--- name: GJB438C接口设计说明文档结构规范 description: 本技能用于指导用户按照GJB 438C-2021标准编写接口设计说明文档的结构。当用户需要编制适用于系统、子系统、配置项或人工操作等实体之间接口的正式设计文档时,应使用此技能。 --- # GJB438C接口设计说明文档结构规范 ## 何时使用 - 正在编写**接口设计说明文档**(Interface Design Description, IDD) - 文档需符合**GJB 438C-2021《军用软件开发文档通用要求》** - 系统或软件包含两个及以上需交互的接口实体(如系统、CSCI、用户等) - 不适用于无接口的独立软件单元 ## 执行步骤 ### 1. 范围章节 必须包含以下内容: - **标识**:明确适用系统、接口实体和接口的完整标识(含标识号、名称、缩略名、版本号、发布号) - **系统概述**:简述系统用途、一般特性(规模、安全性、可靠性、实时性、技术风险等)、开发/运行/维护历史、项目相关方(需方、用户、开发方、保障机构)、当前及计划运行现场、其他相关文档 - **文档概述**:说明本文档用途、内容范围及安全保密要求 ### 2. 引用文档章节 - 列出所有引用文档的编号、标题、编写单位、修订版、日期 - 若引用文档来自非正常渠道,须注明来源 ### 3. 接口设计章节 - 按子条目分别描述一个或多个接口实体(系统/子系统/CSCI/人工操作等)的接口特性 - 若接口设计依赖于系统状态或运行方式,必须明确指出该依赖关系 - 可引用其他文档中的设计信息,但需确保可追溯 - 必须给出或引用适用的设计约定(如数据格式、协议、时序等) ### 4. 需求可追踪性章节 - 建立并描述接口实体与系统或CSCI需求之间的**双向可追踪性** - 确保每个接口特性均可追溯至对应的需求项 ### 5. 注释章节 - 提供有助于理解文档的背景信息、术语定义、缩略语解释或关键公式 > 注意:所有章节必须严格遵循GJB 438C-2021的格式与内容要求,确保文档具备工程合规性和审查通过能力。