软件开发文档模板GF

《软件开发文档模板GF》由会员分享，可在线阅读，更多相关《软件开发文档模板GF（7页珍藏版）》请在装配图网上搜索。

1、文档标识及版本号：XX项目标识.IRSV1.0密级：秘密*5年编制/修订日期：yyyy-mm-dd规范性文档名称：XX项目中文名称-接口需求规格说明接口需求规格说明XX项目中文名称接口需求规格说明InterfaceRequirementSpecificationofXX项目英文名称编制单位：江苏科技大学新技术研究所编写：CNISILS项目组XXX审核：YYY批准：ZZZ编写记录修改记录1范围11.1标识11.2系统概述11.3文档概述12引用文档13需求23.1接口标识和接口图23.2（接口的项目唯一标识符）【原标准中此处编号为3.X，为后续使用方便，故用自动编号】24 3.3需求的优先顺序和

2、关键性【原标准中此处编号为3.Y，为后续使用方便，故用自动编号】4合格性规定4需求可追踪性4注释5文档模板使用和裁剪说明使用本文档模板时，首先另存为“实际文档名”然后通过Word的“文档属性”来设置文档属性，包括：文档标识及版本号、密级及保密期限、文档名称、文档类别（中、英文）、项目名称（中、英文）、编制单位、编写人、审批人、批准人等。具体操作方法Word标题栏的Office按钮菜单T准备T属性T文档属性T高级属性T自定义T在“属性”列表中，选择属性的“名称”，在“取值”框输入要设定的值，然后按“更改”按钮。文档属性设置完成后，选中全部文档内容，执行右键菜单“更新域”操作（文档中的所有文档属性

3、参数引用均被替换为最新设定的取值）9双击任意内容页面的页眉区，选中全部页眉内容，执行右键菜单“更新域”操作（页眉中的所有参数引用均被替换为最新设定的取值）。本文档模板依据GJB438B-2009军用软件开发文档通用要求制定,模板中的文档编写说明均引自GJB438B-2009军用软件开发文档通用要求，并用方括号【”和“】括起来，以及使用蓝色文字区分，主要用于指导文档的编写，应在文档编写完成后或正式提交前予以删除（包括删除本说明）。文档编写者可根据实际需要，对文档内容进行裁剪。按照文档标题顺序与本标准模板规定的标题顺序相同的原则，若裁剪了某章或某条，则在被裁去章条的标题下标识为“本章若无内容，则标

4、识为“本章无内容”，并说明理由。”或“本条若无内容，则标识为“本条无内容”，并说明理由。”，并说明理由。若裁剪的是整章条（包括其所有小条），则仅需在最高层章条的标题下标识为“本章若无内容，则标识为“本章无内容，”并说明理由。”或“本条若无内容，则标识为“本条无内容”，并说明理由。”，并说明理由。1.1 1范围标识1.2 【本条应包含本文档适用系统、接口实体和接口的完全标识，适用时，包括其标识号名称、缩略名、版本号和发布号。】表1-1本文档所适用的系统、接口实体和接口系统概述【本条应概述本文档所适用的系统和软件的用途，还应描述系统与软件的一般特性概述系统开发、运行和维护的历史；标识项目的需方、用

5、户、开发方和保障机构等标；识当前和计划的运行现场；列出其他有关文档。】1.3 （本条若无内容，则标识为“本条无内容”，并说明理由。）文档概述【本条应概述本文档的用途和内容，并描述与它的使用有关的保密性方面的要求】。（本条若无内容，则标识为“本条无内容”，并说明理由。）2引用文档【本章应列出引用文档的编号、标题、编写单位、修订版及日期，还应标识不能通过正常采购活动得到的文档的来源。】（本章若无内容，则标识为“本章无内容”，并说明理由。）3需求3.1接口标识和接口图【对于1.1中标识的每个接口，本条应包含其项目唯一的标识符（，若适用）应通过名称、编号、版本和文档引用来指明接口实体（系统、配置项、用

6、户等）。该标识应声明哪些实体具有固定的接口特性（要给出这些接口实体的接口需求），说明哪些实体正在开发或修改之中（这些实体已有各自的接口需求）。可通过一张或多张接口图来描述这些接口。】（本条若无内容，则标识为“本条无内容”，并说明理由。）3.2（接口的项目唯一标识符）【原标准中此处编号为3.X,为后续使用方便，故用自动编号】【本条（从3.2开始编号）应通过项目唯一的标识符来标识接口，并简要地标识接口实体。根据需要可分条描述为实现该接口而提出的一个或多个接口实体的需求。如果一个实体的接口特性未包含在本文档中，但是描述对该接口实体的需求时需要提到其接口特性，这些特性应作为假定予以陈述，或以“当未涵盖

7、的实体这么做时，所指定的实体将”的形式描述，而不作为本文档没有涵盖的实体的需求。本条可引用其它文档（例如数据字典、通信协议标准、用户接口标准）代替在此所描述的信息。若适用，需求应包括如下内容，并以适合于需求的任何顺序给出，还应从接口实体的角度说明这些特性之间的区别（例如关于数据元素的大小、频率或其它特性的不同期望值。）a）接口实体必须分配给该接口的优先级。b）关于要实现的接口类型的需求（例如实时数据传送、数据的存储和检索等）c）接口实体必须提供、存储、发送、存取、接收的各个数据元素所要求的特征，例如：1）名称/标识符：项目唯一标识符；非技术（自然语言）名称；数据元素名称；技术名称（如在代码或数

8、据库中的变量名或字段名）；缩略名或同义名；2）数据类型（字母、数字、整数等）；3）大小和格式（如：字符串的长度和标点符号）；4）计量单位（如m）；5）可能值的范围或枚举（如：099）；6）准确性（正确程度）和精度（有效数字位数）；7）优先级别、时序、频率、容量、序列以及其它的约束条件（例如数据元素是否可以被更新、业务规则是否适用)。d) 保密性约束；来源(建立/发送的实体)和接收者(使用/接收的实体)；接口实体必须提供、存储、发送、访问、接收的数据元素组合体(记录、消息、文件、数组、显示、报表等)所要求的特征，例如：1) 名称/标识符：a. 项目唯一标识符；非技术(自然语言)名称；技术名称(如

9、在代码或数据库中的记录名或数据结构名)；缩写名或同义名。2) 包中的数据元素及其结构(编号、顺序和成组情况)；介质(例如磁盘)以及在介质上数据元素/包的结构；显示和其它输出的视听特性(例如颜色、布局、字体、图标和其它显示元素蜂鸣声和亮度)；包之间的关系，如排序/存取特性；优先级、定时、频率、容量、定序及其它约束，例如包是否可以被更新、业务规则是否适用；保密性约束；来源(建立/发送的实体)和接收者(使用/接收的实体)。e) 接口实体必须使用的接口的通信方法所要求的特征。如：1) 项目唯一标识符；通信链接/带宽/频率/介质及其特性；消息格式；流控制(如：序列编号和缓冲区分配)；周期性/非周期传送的

10、数据传送速率，传输间隔；路由、寻址、命名约定；传输服务，包括：优先权和等级；安全性/保密性考虑，如：加密、用户鉴别、隔离和审核。f) 接口实体必须使用的接口的协议所要求的特征，如：1) 项目唯一标识符；协议的优先级别/层次；打包，包括拆包和重新打包、路由和寻址；合法性检查、错误控制和恢复过程；同步，包括建立连接、保持和终止；状态、标识及任何其它报告的特性。其它所要求的特特征，例如接口实体的物理兼容性(尺寸、公差、负载、和接插件的兼容性等）、电压等。】（本条若无内容，则标识为“本条无内容”，并说明理由。）3.3需求的优先顺序和关键性【原标准中此处编号为3.Y,为后续使用方便，故用自动编号】【（若

11、适用）本条应描述本文档中各需求的优先次序、关键性或所赋予的指示其相对重要性的权重。例如标识对安全性或保密性关键的需求，以便进行特殊处理。如果所有需求具有相等的权重，本条应如实说明。】4 （本条若无内容，则标识为“本条无内容”，并说明理由。）合格性规定【本条应定义一组合格性方法，并为第3章中每个需求指定为确保需求得到满足所应使用的方法。可用表格形式表述该信息，或为第3章的每个需求注明所使用的方法。合格性方法可以包括：a）演示：依靠可见的功能操作，直接运行接口实体，而不需要使用仪器、专用测试设备或进行事后分析；b）测试：使用仪器或专用测试设备，运行接口实体，以便采集数据供事后分析使用；c）分析：处

12、理从其它合格性方法中获得的积累数据。例如，对测试结果进行简约、解释或推断。d）审查：对接口实体、文档等进行目视检查；e）特殊的合格性方法：任何针对接口实体的特殊合格性方法，例如专用工具、技术、规程、设施、验收限制。】5 （本条若无内容，则标识为“本条无内容”，并说明理由。）需求可追踪性【对系统级接口实体，本章不适用。对每一个子系统级或更低级的接口实体，本章应包含：a）从本规格说明中实体的每个需求，到该需求所涉及的系统（或子系统）需求的可追踪性。（也可以通过对第3章中的每一个需求进行注释来提供可追踪性）。注：每个层次的系统细化都可能导致不能直接追踪到较高层次需求的需求。例如：创建多个CSCI的系统体系结构设计可能导出关于这些CSCI如何接口的需求，而这些接口需求在系统需求中并没有涵盖。这样的需求可以被追踪到类似于“系统实现”这样的一般需求，或被追踪到导致它们产生的系统设计决策上。b）从分配给本接口实体的和影响到这个规格说明中某个接口的每个系统（或子系统）需求，到本规格说明中涉及到它的接口需求的可追踪性。】（本章若无内容，则标识为“本章无内容”，并说明理由。）6注释【本章应包括有助于了解文档的所有信息（例如：背景、术语、缩略语或公式）。】（本章若无内容，则标识为“本章无内容”，并说明理由。）