--- name: CSCI外部接口需求描述规范 description: 用于在定义CSCI(计算机软件配置项)外部接口需求时,系统化地描述接口的完整技术规格。当需要编写或审查CSCI与外部系统、组件或用户之间的接口需求文档时使用本技能,确保涵盖优先级、数据元素、组合体、通信方法、协议及其他关键特征。 --- # CSCI外部接口需求描述规范 ## 何时使用 - 正在编写软件需求规格说明(SRS)中关于CSCI外部接口的部分 - 需要确保接口需求满足系统集成和互操作性要求 - 审查现有接口需求是否完整、一致且可验证 - 外部实体行为未完全定义,需通过假设方式描述接口交互 ## 如何执行 按以下结构组织CSCI外部接口需求描述(顺序可调整,但内容必须完整): 1. **接口优先级**:明确CSCI为该接口分配的优先级。 2. **接口类型特征**:说明接口功能类型,例如实时数据传送、数据存储与检索、命令控制等。 3. **数据元素特征**:对CSCI提供、存储、发送、访问或接收的每个数据元素,描述: - 名称/标识符(包括唯一标识符、非技术名称、标准化名称、技术名称、缩略名) - 数据类型 - 大小和格式 - 计量单位 - 值范围或枚举值 - 准确性和精度要求 - 优先级、定时、频率、容量、序列及其他约束 - 保密性约束 - 来源和接收者 4. **数据元素组合体特征**:对记录、消息、文件等结构化数据集合,描述: - 名称/标识符 - 包含的数据元素及其结构 - 介质类型及结构(如网络报文、磁盘文件) - 视听特性(如适用) - 组合体之间的关系(如依赖、顺序) - 约束条件 - 保密性约束 - 来源和接收者 5. **通信方法特征**:说明CSCI使用的通信机制(如API调用、消息队列、共享内存等)。 6. **协议特征**:描述所采用的接口协议(如HTTP/REST、TCP/IP、自定义二进制协议等)。 7. **其他要求**:包括物理兼容性、电气特性、环境约束等非功能性要求。 ### 处理未涵盖的外部实体 若外部实体的行为或特性未被完全定义,应采用以下任一方式描述: - 以“假设”形式明确前提条件 - 使用“当[未涵盖实体]这样做时,本CSCI应该...”的句式定义响应行为 确保所有描述可测试、无歧义,并避免涉及CSCI内部实现细节。