เอกสารการควบคุมอินเตอร์เฟสคืออะไร?

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

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

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

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