GJB438B-接口需求规格说明IRS-模板

[键入文字]文档标识及版本号：XX项目标识.IRSV1.0密级：秘密★5年编制/修订日期：yyyy-mm-dd文档名称：XX项目-接口需求规格说明接口需求规格说明《XX项目》接口需求规格说明编制单位：编写：审核：批准：修改记录序号修改时间修改说明（修改章节及内容概要）修改人yyyy-mm-ddi目录1范围...........................................11.1标识.....................................11.2系统概述.................................11.3文档概述.................................12引用文档.......................................23接口设计.......................................23.1接口标识和接口图.........................23.X(接口的项目唯一的标识符).................34需求的可追踪性.................................75注释...........................................8iiXX项目-接口设计说明IDD密级：秘密★5年第1页，共9页1范围1.1标识【本条应描述本文档所适用的系统、接口实体和接口的完全标识，适用时，包括其标识号、名称、缩略名、版本号和发布号。】表1-1本文档所适用的系统、接口实体和接口序号名称缩略名标识号版本号发布号1.2系统概述【本条应概述本文档所适用的系统和软件的用途，还应描述系统与软件的一般特性；概述系统开发、运行和维护的历史；标识项目的需方、用户、开发方和保障机构等；标识当前和计划的运行现场；列出其他有关文档。】（本章若无内容，则标识为“本章无内容”，并说明理由。）1.3文档概述【本条应概述本文档的用途和内容，并描述与它的使用XX项目-接口设计说明IDD密级：秘密★5年第2页，共9页有关的保密性方面的要求。】（本章若无内容，则标识为“本章无内容”，并说明理由。）2引用文档【本章应列出引用文档的编号、标题、编写单位、修订版及日期，还应标识不能通过正常采购活动得到的文档的来源。】（本章若无内容，则标识为“本章无内容”，并说明理由。）3需求3.1接口标识和接口图【对于1.1中所标识的每个接口，本条应本条应包含其项目唯一的标识符，（若适用）应通过名称、编号、版本和文档引用来指明接口实体（系统、配置项、用户等）。该标识应声明哪些实体具有固定的接口特性（要给出这些接口实体的接口需求），说明哪些实体正在开发或修改中（这些实体已有各自的接口需求）。可通过一张或多张接口图来描述这些接口。】（本章若无内容，则标识为“本章无内容”，并说明理由。）XX项目-接口设计说明IDD密级：秘密★5年第3页，共9页3.X(接口的项目唯一的标识符)【本条（从3.2开始）应通过项目唯一的标识符标识接口，并简要地标识接口实体.根据需要可分条描述为实现该接口而提出的一个或多个接口实体的需求。如果一个实体的接口特性未包含在本文档中，但是描述对该接口实体的需求时需要提到其接口特征，这些特征应作为假设予以陈述、或以“当[未涵盖的实体]这样做时，[所指定的实体]将……”的形式描述，而不作为本文档没有涵盖的实体的需求。本条可引用其他文档（例如，数据字典、通信协议标准、用户接口标准）代替在此所描述的信息。若适用，需求应包括以下内容，并以适合于需求的任何顺序给出，还应从接口实体角度，说明这些特性之间的区别（例如关于数据元素的大小、频率或其他特性的不同期望值）。a)接口实体必须分配给接口的优先级别。b)关于要实现的接口类型的要求（如：实时数据传送、数据的存储和检索等）。c)接口实体应提供、存储、发送、访问、接收的各个数据元素的特征，如：1）名称/标识符：a.项目唯一的标识符；b.非技术（自然语言）名称；XX项目-接口设计说明IDD密级：秘密★5年第4页，共9页c.数据元素名称；d.技术名称（如代码或数据库中的变量名或字段名）；e.缩写名或同义名。2）数据类型（字母、数字、整数等）。3）大小和格式（如：字符串的长度和标点符号）。4）计量单位（如：m）。5）可能值的范围或枚举（如：0-99）。6）准确性（正确程度）和精度（有效数字位数）。7）优先级别、时序、频率、容量、序列、其他的约束条件（如：数据元素是否可被更新、业务规则是否适用）。8）保密性约束。9）来源（建立/发送的实体）和接收者（使用/接收的实体）。d)接口实体必须提供、存储、发送、访问、接收的数据元素组合体（记录、消息、文件、数组、显示、报表等）所要求的特征，如：1）名称/标识符：a.项目唯一的标识符；b.非技术（自然语言）名称；c.技术名称（如代码或数据库中的记录名或数XX项目-接口设计说明IDD密级：秘密★5年第5页，共9页据结构名）；d.缩略名或同义名。2）包中的数据元素及其结构（编号、顺序和成组情况）。3）介质（如磁盘）以及在介质上数据元素/包的结构。4）显示和其他输出的视听特性（如：颜色、布局、字体、图标和其他显示元素、蜂鸣声、亮度等）。5）包之间的关系，如排序/存取特性。6）优先级、定时、频率、容量、定序及其他的约束条件，如：包是否可以被更新、业务规则是否适用。7）保密性约束。8）来源（建立/发送的实体）和接收者（使用/接收的实体）。e)接口实体必须使用的接口的通信方法所要求的特征。如：1）项目唯一的标识符；2）通信链接/带宽/频率/介质及其特性；3）消息格式化；4）流控制（如：序列编号和缓冲区分配）；5）周期/非周期传送的数据传送速率，传输间隔；XX项目-接口设计说明IDD密级：秘密★5年第6页，共9页6）路由、寻址、命名约定；7）传输服务，包括优先级别和等级；8）安全性/保密性方面的考虑，如：加密、用户鉴别、隔离、审核等。f)接口实体必须使用的接口协议所要求的特征，如：1）项目唯一的标识符；2）协议的优先级别/层次；3）打包，包括拆重新打包、路由和寻址；4）合法性检查、错误控制和恢复过程；5）同步，包括建立连接、保持和终止；6）状态、标识及任何其他报告的特性。g)其他所要求的特征，如：接口实体的物理兼容性（尺寸、公差、负荷和接插件的兼容性等）、电压等】（本章若无内容，则标识为“本章无内容”，并说明理由。）3.Y需求的优先顺序和关键性【（若适用）本条应描述本文档中各需求的优先次序、关键性或所赋予的指示其相对重要性的权重。例如标识对安全性和保密性关键的需求，以便进行特殊处理。如果所有需求具有相等的权重，本条应如实说明。】（本条若无内容，则标识为“本条无内容”，并说明理XX项目-接口设计说明IDD密级：秘密★5年第7页，共9页由。）4合格性规定【本条应定义一组合格性方法，并为第3章中的每个需求指定为确保需求得到满足所应使用的方法。可用表格形式表述该信息，或为第3章中的每个需求注明所使用的方法。合格性方法可以包括：a)演示：依靠可见的功能操作，直接运行接口实体，而不需要使用仪器、专用测试设备或进行事后分析。b)测试：使用仪器或专用测试设备，运行接口实体，以便采集数据供事后分析使用。c)分析：处理从其他合格性方法获得的积累数据。例如，对测试结果进行简约、解释或推断。d)审查：对接口实体、文档等进行目视检查。e)特殊的合格性方法：任何针对接口实体的特殊合格性方法，例如专用工具、技术、规程、设施、验收限制。】（本章若无内容，则标识为“本章无内容”，并说明理由。）XX项目-接口设计说明IDD密级：秘密★5年第8页，共9页5需求可追踪性【对系统级接口实体，本章不适用。对每一个子系统级或更低级接口实体，本章应包含：a)从本规格说明书中实体的每个需求，到该需求所涉及的系统（或子系统）需求的可追踪性（也可以通过对第3章中的每一个需求进行注释来提供可追踪性）。注：每个层次的系统细化都可能导致不能直接追踪到较高层次需求的需求。例如：创建多个CSCI的系统体系结构设计，可能导出关于这些CSCI如何接口的需求，而这些接口需求在系统需求中并没有涵盖。这样的需求可以被追踪到类似于“系统实现”这样的一般需求，或被追踪到导致它们产生的系统设计决策上。b)从分配给本接口实体的和影响到这个规格说明中某个接口的每个系统（或子系统）需求，到本规格说明中涉及到它的接口需求的可追踪性。】（本章若无内容，则标识为“本章无内容”，并说明理由。）6注释【本章应包括有助于了解文档的所有信息（例如：背景、术语、缩略语或公式）。】（本章若无内容，则标识为“本章无内容”，并说明理由。）XX项目-接口设计说明IDD密级：秘密★5年第9页，共9页