อ่าน 1 นาที
เอกสารควบคุมอินเทอร์เฟซ
เอกสาร ควบคุมอินเทอร์เฟซ ( ICD ) ใน วิศวกรรมระบบ [ 1 ] และ วิศวกรรมซอฟต์แวร์ ให้บันทึกข้อมูลอินเทอร์เฟซทั้งหมด (เช่น ภาพวาด แผนภาพ ตาราง และข้อมูลข้อความ)...
เอกสารควบคุมอินเทอร์เฟซ
เอกสารควบคุมอินเทอร์เฟซ ( ICD ) ในวิศวกรรมระบบ[ 1 ]และวิศวกรรมซอฟต์แวร์ให้บันทึกข้อมูลอินเทอร์เฟซทั้งหมด (เช่น ภาพวาด แผนภาพ ตาราง และข้อมูลข้อความ) ที่สร้างขึ้นสำหรับโครงการ[ 2 ]เอกสารอินเทอร์เฟซพื้นฐานให้รายละเอียดและอธิบายอินเทอร์เฟซหรืออินเทอร์เฟซระหว่างระบบย่อยหรือไปยังระบบหรือระบบ ย่อย
ภาพรวม
เอกสาร ICD (Integrated Interface Document) เป็นเอกสารหลักที่ครอบคลุมส่วนต่อประสานระบบต่างๆ ตัวอย่างของสิ่งที่ควรระบุในข้อกำหนดส่วนต่อประสานเหล่านี้ ได้แก่:
- ข้อมูลนำเข้าและข้อมูลส่งออกของระบบเดียว ซึ่งบันทึกไว้ในเอกสาร SIRS (Software Interface Requirements Specifications) และ HIRS (Hardware Interface Requirements Specifications) แต่ละฉบับ จะอยู่ภายใต้ "เอกสารควบคุมอินเทอร์เฟซของวิกิพีเดีย"
- ส่วนเชื่อมต่อระหว่างสองระบบหรือสองระบบย่อย เช่น "ส่วนเชื่อมต่อระหว่างบ้านสุนัขกับห้องน้ำกลางแจ้ง" ก็จะมี ICD หลักด้วยเช่นกัน
- โปรโตคอลอินเทอร์เฟซที่สมบูรณ์ ตั้งแต่ส่วนประกอบทางกายภาพที่เล็กที่สุด (เช่น ปลั๊กที่เชื่อมต่อกัน ระดับแรงดันสัญญาณไฟฟ้า) ไปจนถึงระดับตรรกะสูงสุด (เช่น เลเยอร์แอปพลิเคชัน ระดับ 7 ของโมเดล OSI ) จะต้องได้รับการบันทึกไว้ในข้อกำหนดอินเทอร์เฟซที่เหมาะสม และอยู่ภายใต้ ICD เดียวสำหรับ "ระบบ" นั้น
วัตถุประสงค์ของ ICD คือการควบคุมและดูแลรักษาบันทึกข้อมูลอินเทอร์เฟซระบบสำหรับโครงการที่กำหนด ซึ่งรวมถึงข้อมูลนำเข้าที่เป็นไปได้ทั้งหมดและข้อมูลส่งออกที่เป็นไปได้ทั้งหมดจากระบบสำหรับผู้ใช้ระบบที่เป็นไปได้หรือผู้ใช้จริง อินเทอร์เฟซภายในของระบบหรือระบบย่อยจะถูกบันทึกไว้ในข้อกำหนดอินเทอร์เฟซที่เกี่ยวข้อง ในขณะที่อินเทอร์เฟซระหว่างมนุษย์กับเครื่องจักรอาจอยู่ใน เอกสาร การออกแบบระบบ (เช่นเอกสารการออกแบบซอฟต์แวร์ )
เอกสารควบคุมอินเทอร์เฟซเป็นองค์ประกอบสำคัญของวิศวกรรมระบบเนื่องจากเอกสารเหล่านี้ควบคุมอินเทอร์เฟซที่บันทึกไว้ของระบบ ตลอดจนระบุชุดเวอร์ชันอินเทอร์เฟซที่ทำงานร่วมกันได้และด้วยเหตุนี้จึงเป็นการกำหนดขอบเขตของข้อกำหนดต่างๆ
ลักษณะเฉพาะ
อินเทอร์เฟซการเขียนโปรแกรมแอปพลิเคชัน (API)เป็นรูปแบบหนึ่งของอินเทอร์เฟซสำหรับระบบซอฟต์แวร์ โดยจะอธิบายวิธีการเข้าถึงฟังก์ชันและบริการที่ระบบจัดให้ผ่านทางอินเทอร์เฟซ หากผู้ผลิตระบบต้องการให้ผู้อื่นสามารถใช้ระบบได้ การจัดทำเอกสารข้อกำหนดการออกแบบภายใน (ICD) และข้อกำหนดอินเทอร์เฟซ (หรือเอกสารที่เทียบเท่า) ถือเป็นการลงทุนที่คุ้มค่า
เอกสาร ICD ควรบรรยายเฉพาะรายละเอียดของอินเทอร์เฟซเท่านั้น ไม่ควรบรรยายถึงลักษณะเฉพาะของระบบที่ใช้เชื่อมต่อ ฟังก์ชันและตรรกะของระบบเหล่านั้นควรได้รับการอธิบายไว้ในเอกสารข้อกำหนดและการออกแบบของตนเองตามความจำเป็น ด้วยวิธีนี้ ทีมงานอิสระสามารถพัฒนาระบบเชื่อมต่อที่ใช้อินเทอร์เฟซที่ระบุไว้ได้ โดยไม่ต้องคำนึงถึงว่าระบบอื่นๆ จะตอบสนองต่อข้อมูลและสัญญาณที่ส่งผ่านอินเทอร์เฟซอย่างไร ตัวอย่างเช่น เอกสาร ICD และเอกสารอินเทอร์เฟซที่เกี่ยวข้องต้องมีข้อมูลเกี่ยวกับขนาด รูปแบบ และสิ่งที่วัดได้จากข้อมูล แต่ไม่ควรรวมถึงความหมาย สุดท้าย ของข้อมูลในการใช้งานตามที่ผู้ใช้ตั้งใจไว้
อินเทอร์เฟซที่กำหนดไว้อย่างเหมาะสมจะช่วยให้ทีมหนึ่งสามารถทดสอบการใช้งานอินเทอร์เฟซได้โดยการจำลองฝั่งตรงข้ามด้วยโปรแกรมจำลองการสื่อสารอย่างง่าย การที่ไม่ทราบตรรกะทางธุรกิจของระบบอีกด้านหนึ่งของอินเทอร์เฟซจะทำให้มีโอกาสมากขึ้นที่ทีมหนึ่งจะพัฒนาระบบที่ไม่เสียหายเมื่อระบบอื่นเปลี่ยนแปลงกฎและตรรกะทางธุรกิจ (ควรหลีกเลี่ยงการกำหนดข้อจำกัดหรือการตรวจสอบความถูกต้องในข้อกำหนดของอินเทอร์เฟซ) ด้วยเหตุนี้ จึงทำให้เกิดความเป็นโมดูลและความเป็นนามธรรมที่ดี ซึ่งนำไปสู่การบำรุงรักษาและการขยายระบบได้ง่าย
สรุปเนื้อหา
ข้อมูลสำคัญจากบทความ
ข้อมูลสำคัญเกี่ยวกับ เอกสารควบคุมอินเทอร์เฟซ
เอกสาร ควบคุมอินเทอร์เฟซ ( ICD ) ใน วิศวกรรมระบบ [ 1 ] และ วิศวกรรมซอฟต์แวร์ ให้บันทึกข้อมูลอินเทอร์เฟซทั้งหมด (เช่น ภาพวาด แผนภาพ ตาราง และข้อมูลข้อความ)...
ภาพรวม
เอกสาร ICD (Integrated Interface Document) เป็นเอกสารหลักที่ครอบคลุมส่วนต่อประสานระบบต่างๆ ตัวอย่างของสิ่งที่ควรระบุในข้อกำหนดส่วนต่อประสานเหล่านี้ ได้แก่:
ลักษณะเฉพาะ
อิน เทอร์เฟซการเขียนโปรแกรมแอปพลิเคชัน (API) เป็นรูปแบบหนึ่งของอินเทอร์เฟซสำหรับระบบซอฟต์แวร์ โดยจะอธิบายวิธีการเข้าถึงฟังก์ชันและบริการที่ระบบจัดให้ผ่านทางอินเทอร์เฟซ หากผู้ผลิตระบบต้องการให้ผู้อื่นสามารถใช้ระบบได้ การจัดทำเอกสารข้อกำหนดการออกแบบภายใน (ICD)...