เอกสารการควบคุมส่วนต่อประสานคืออะไร?

เอกสารควบคุมอินเตอร์เฟส (ICD) เป็นคำอธิบายอย่างเป็นทางการของวิธีการและโครงสร้างที่เกี่ยวข้องกับการจัดหาอินพุตและรับเอาต์พุตจากระบบเฉพาะ ระบบที่อธิบายโดยเอกสารควบคุมส่วนต่อประสานสามารถเป็นห้องสมุดซอฟต์แวร์หรือฮาร์ดแวร์ เอกสารไม่จำเป็นต้องทำตามรูปแบบใด ๆ แต่สามารถรวบรวมย่อหน้าแผนภูมิหรือแม้แต่ภาพวาดทางเทคนิคของฮาร์ดแวร์อินเตอร์เฟส เมื่ออ้างถึงซอฟต์แวร์เป็นพิเศษเอกสารควบคุมส่วนต่อประสานสามารถมีลักษณะคล้ายกันและมีส่วนร่วมในการเขียนโปรแกรมเชิงนามธรรม (API) ซึ่งอธิบายวิธีการหรือฟังก์ชั่นสาธารณะที่สามารถใช้ในการป้อนข้อมูลลงในห้องสมุดและอธิบายผลลัพธ์ที่จะเกิด เอกสารควบคุมอินเตอร์เฟสมักอธิบายวิธีรวมระบบเข้ากับระบบที่มีขนาดใหญ่ขึ้นหรือเชื่อมต่อกับระบบขนาน ไม่ได้อธิบายการทำงานภายในของระบบใด ๆ ซึ่งอาจสะกดออกมาเป็นเอกสารประเภทอื่น

วัตถุประสงค์ของเอกสารควบคุมอินเทอร์เฟซคือเพื่อให้นักพัฒนาซอฟต์แวร์หรือเอกสารบางอย่างที่สามารถใช้เมื่อสร้างระบบหรือซอฟต์แวร์ที่จะถ่ายโอนข้อมูลไปยังและจากระบบ ICD อธิบาย ซึ่งมักจะหมายถึงการกำหนดฟังก์ชั่นที่แน่นอนหรือส่วนประกอบฮาร์ดแวร์ในลักษณะที่เป็นที่รู้จักของพวกเขาและความคลาดเคลื่อนของพารามิเตอร์สำหรับการใช้งานจะได้รับ ในวิศวกรรมซอฟต์แวร์สิ่งนี้อาจหมายถึงการรู้ชื่อของฟังก์ชันเฉพาะตัวแปรชนิดใดที่ได้รับการยอมรับเป็นพารามิเตอร์และอาจเป็นไปได้ว่าข้อ จำกัด การทำงานใดที่วางอยู่บนค่าที่ส่งผ่าน สำหรับชิ้นส่วนของฮาร์ดแวร์ข้อมูลนี้อาจรวมถึงสิ่งที่ทำหน้าที่เป็นหมุดของตัวควบคุมคอนเนคเตอร์อนุกรมการขัดจังหวะของฮาร์ดแวร์ใด ๆ ที่ใช้และความเร็วในการทำงานของอุปกรณ์

สิ่งหนึ่งที่เอกสารควบคุมอินเทอร์เฟซไม่ได้อธิบายโดยเฉพาะคือวิธีที่ระบบแปลอินพุตเป็นเอาต์พุตหรือวิธีการสร้างเอาต์พุตโดยทั่วไป สิ่งนี้ช่วยให้นักพัฒนาใช้มุมมองที่มุ่งเน้นอย่างแคบ ๆ ของระบบเมื่อสร้างอินเทอร์เฟซ แต่ยังต้องการให้ผู้พัฒนาระบบที่รายละเอียดของ ICD ปฏิบัติตามแนวทางที่สะกดออกมาในเอกสารอย่างเคร่งครัด ความสะดวกสบายสำหรับผู้เขียนเอกสารควบคุมอินเตอร์เฟสและผู้พัฒนาระบบคือการใช้งานภายในระบบไม่ได้อธิบายไว้ในเอกสารจึงสามารถเปลี่ยนแปลงได้อย่างอิสระโดยไม่กระทบต่อการพัฒนาอินเตอร์เฟสภายนอกที่พึ่งพา ICD

ในบางสถานการณ์เอกสารควบคุมอินเตอร์เฟสสามารถอนุญาตให้ทำการทดสอบระบบได้โดยไม่จำเป็นต้องใช้อินเตอร์เฟสที่สมบูรณ์ สิ่งนี้สามารถทำได้โดยการจำลองเอาท์พุทประเภทต่าง ๆ ที่ระบบสามารถสร้างได้ตามที่อธิบายไว้ใน ICD แล้วส่งผ่านเอาต์พุตนั้นผ่านอินเตอร์เฟสที่พัฒนาขึ้นภายนอก ระบบที่สนใจเพียงการจัดการด้านใดด้านหนึ่งของระบบ - เช่นเอาท์พุทในกรณีของฮาร์ดแวร์เช่นอุปกรณ์แสดงผลสามารถมั่นใจได้ว่าอินเทอร์เฟซทำงานภายในข้อกำหนดโดยไม่ต้องใช้อินพุตจริง