GJB 中华人民共和国国家军用标准 FL0137 GJB438A-97 武器系统软件开发文档 Defense system software development documentation 1997-11-05发布 1998-05-01实施 国防科学技术工业委员会批准
目次 范围 1.1主题内容 (1) 1.2适用范围… 引用文件………………………………………………………………………………(1 3定义 3.1术语……………………………………………… 3.2缩略语… 一般要求 4.1文档的种类 4.2文档的产生… 着非中甲由 4.3文档的准备…… (3) 4.4文档的結构… 5详细要求 5.1系统和段设计文件… (5) 5.2软件开发计划… 5.3软件需求规格说明…………………… (20) 5.4接口需求规格说明…………………… 5.5接口设计文档…… …(27) 5.6软件设计文档……… …(29) 5.7软件产品规格说明… 58版本说明文档 (35) 59软件测试计划 (37) 5.10软件测试说明 ……(40) 5.11软件测试报告…………… 5.12计算机系统操作员手册…… ……(46) 5.13软件用户手册……… ………………(48) 5.14软件程序员手册… 5.15固件保障手册……………………… (53) 5.16计算机资源综合保障文件 …………………(55)
中华人民共和国国家军用标准 武器软件开发文档 Defense system software development documentation GJB438A-97 代替GJB438-88 1范目 1.1主题内容 本标准规定了武器系统软件开发文档编制的格式、内容和要求 1.2适用范围 本标准适用于武器系统系统软件进行开发过程中的文档编制,尤其适用于用GJB2786 96进行软件开发的系统。 2引用文件 GB1988-80信息处理信息交换用的7位编码字符集 GB2312-80信息交换用的汉字编码字符集基本集 GB2786-96武器系统软件开发 3定义 3.1术语 本标准所用术语见GJB2786-96 3.2缩略语 CRISD Computer Resources Integrated Support Document 计算机资源综合保障文件 CSOM Computer System Operators Manual 计算机系统操作员手册 FSM Firmware Support Manual 固件保障手册 IDd Interface Design Document 接口设计文档 IRs Interface Requirements Specification 接口需求规格说明 Sdd Software Design Document 软件设计文档 SDP Software Development Plan 国防科学技术工业委员会1997-11-05发布 1998-05-01宾施
GJB438A一97 软件开发计划 SPM Software Programmers Manual 软件程序员手册 SPs Software Product Specification 软件产品规格说明 SRs Software Requirements Specification 软件需求规格说明 SsDd System/Segment Design Document 系统和段设计文件 std Software Test Description 软件测试说明 sTP Software Test Plan 软件测试计划 STR Software Test Report 软件测试报告 SUM Software Users Manual 软件用户手册 VDD Version Description document 版本说明文档 HwCi Hardware Configuration Item 硬件技术状态项(配置项) CSci Computer Software Configuration Item 计算机软件配置(技术状态)项 CSC Computer Software Component 计算机软件部件 Csu Computer Software Unit 计算机软件单元 4一般要求 4.1文档的种类 根据GJB2786的要求,在软件开发过程应产生下列文档: 系统和段设计文件 软件开发计划 软件需求规格说明 接口需求规格说明 接口设计文档 软件设计文档
GJB438A-97 软件产品规格说明 版本说明文档 软件测试计划 软件测试说明 软件测试报告 计算机系统操作员手册 软件用户手册 软件程序员手册 固件保障手册 计算机资源综合保障文件 4.2文档的产生 文档的格式和内容是根据GJB2786中各阶段描述的工作任务而产生的,这些文档记载了 软件开发过程中的主要活动信息和要求。它们与GJB2786标准各条的关系见GJB2786标准 的资料要求和文档的相互引用。承制方应按照要求编写并交付软件文档。 4.3文档的准备 软件开发过程中要编制的文档应是书面文档或电子媒体的形式,若选择电子媒体,则应规 定其格式。 鼓励使用自动化技术生成文档。在编制文档时可根据任务要求裁剪文档,裁剪说明和编 写要求如下: a.裁剪说明:根据需要,可以对文档的种类和内容进行裁剪。按文档章节标题顺序应与 本标准规定的标题相同的原则,若裁剪了某章节或某小节,则在被裁去的章节(或小节)的标题 下直接加以说明,若裁剪的是整章节(包括其所有小节),则仅需在最高层的章节标题下加以说 明 b.表示形式:为使各文档章节的信息更加清晰可读,可采用图、表、矩阵或其它形式的表 示方式进行说明。 c.页码编制:文档正文的目录使用小写罗马数字编号,文档正文和附录均使用阿拉伯数 字顺序编号;若一个文档分为若千卷,则每一卷应重新开始按顺序编号。 d.文档控制号:书面形式文档的控制号可打印在页的一边或两边(单边或双边)。文档控 制号包括文档修订号和卷号。每页的页眉一般应有文档控制号和日期。 e.自变量:字母X和Y为各文档小节编号的自变量。标题上圆括号中的文字在编写时要 用实际内容替换。例如在“软件需求规格说明”文档中3.2.X节在实际应用时可能为: 3.2.1信号采集——RO01 3.2.2信号传输—R002 4.4文档的结构 软件文档由封面、目录、正文、注释和附录组成 4.4.1封面 封面一般应包括:
GJB438A-97 文档控制号 b.密级; c.修订日期; d.系统名,CSCI名,文档名称; e,用户单位; f.管理部门; 编制单位 h.编制人; 审核; j.批准; 例如,某工程项目的开发计划封面如下 密级:XX [文档控制号:VOL.X/Y(多卷情况)] [修订日期: [系统名]的[cSCI]的 软件开发计划 合同号:K-9601-03 用户单位:XXX部队 签约机构:XXXX 编制单位:北京系统工程研究所 编制人:XXX 审核 XXX 批准 XXX 4.4.2目录 当文档内容较长或章节较多时,应编写目录。目录的内容包括章、节、图表、注释和附录的 编号、标题及其页码。标题与页码之间用符号 连接。注释和附录可以另编页码。 4.4.3正文 正文是各文档的具体内容。其要求见 4.4.4注释 各文档的注释部分应包括能帮助了解这份文档的所有信息(例如:背景信息、词汇表、公 式),以及本文档使用的所有的缩略语及其含义。 4.4.5附录 各文档的附录应提供文档维护的详细信息(例如:图、表、分类数据等)。每个附录都应在
GJB438A-97 文档的正文中被引用。为方便起见,附录可单独装订成册。附录应按字母顺序(A,B,等等)分 类,并且每个附录中的小节编号均须加上附录字母(例如:附录A,A1,A2,等等)。 5详细要求 本条规定了各个文档的内容要求。每个文档分为目录和正文两部分
GJB438A-97 5.1系统和段设计文件 5.1.1系统和段设计文件的目录的格式 1范围 1.1标识 1.2概述 13文档概述 2引用文档 3运行概念 31任务 用户要求 31.2主要任务 313次要任务 32运行环境 33支持环境 33.1主要任务 3.32支持设施 33.3供应 334管理机构 3.4系统体系结构 3.5运行情况 4系统设计 4.1HwcI标识 4.1.x(Hwcr名称和项目唯一标识号) 4.2CSC标识 4.2x(cScI名称和项目唯一标识号) 43手工操作标识 4.4内部接口 44.1(HwCI-Hwcr接口名称和项目唯一标识号) 442(HwCI-CSCI接口名称和项目唯一标识号) 44.3(CSCr-CSCI接口名称和项目唯一标识号 处理资源 5x(处理资源名称和项目唯一标识号) 6质量因素的考虑 7需求的可追踪性
GJB438A-97 5.1.2系统和段设计文件的正文的格式 1范围 1.1标识 列出本文档的: a已批准的标识号; b标题; c.缩略语; d本文档适用的系统; e.由系统设计所派生需求的更高层的规格说明 1.2概述 概述本文档所适用的系统和CSCI的用途。 13文档概述 概述本文档的用途和内容。 引用文档 按文档号和标题列出本文档引用的所有文档 运行概念 分节描述系统的运行概念, 3.上任务 31.1用户要求 描述系统必须满足的用户要求,并引用描述这些要求的文档 312主要任务 描述系统的主要任务 313次要任务 描述系统的次要任务 32运行环境 描述使用该系统的运行环境 33支持环境 描述在系统生产和部署阶段所需要的支持环境 33.1主要任务 描述系统的支持概念,包括 a.多用途或自动测试设备的使用; b.修改与替换的准则; 维护层次 d.维护和修改周期; e.用户、签约机构和承制方的支持; f.可访问性;
cJB438A-97 g.其他。 3.3.2支持设施 描述在系统生产和部署阶段,系统的支持设施和使用的设备。不仅要求详细描述已有的 设施和设备(以便于使用),而且要求详细描述新的或要改造的设备以便作研制和选购计划 33.3供应 描述供应系统、供应系统的系统需求的重要性、以及系统设计与使用对供应系统的影响。 包括: a.引入新项目到供应系统; b.新的供应方式 c.系统仓库的位置和分发方式 3.34管理机构 标识系统的开发、保障和用户的组织机构 3.4系统体系结构 描述系统的内部结构标识子系统、HWCI和Cc,并概述其用途。描述子系统、HC 和CSCI之间的关系。标识和陈述系统每个内部接口的用途用系统体系结构框图表示系统 顶层的体系结构。 3.5运行情况 描述系统的每一种运行情况。对每个系统状态和方式,应标识其执行的配置项和执行的 手工操作也可以用图表表示。此外还应描述系统以不同的状态和方式运行时配置项之间 执行的控制流程和数据流程。 4系统设计 本章应标识系统内部被指定为主要项目或关键项目的HwCI分小节标识系统的每个 HwCI、CSCI和手工操作,还应描述系统内部 HWCI CSCI和手工操作之间的关系,也可用树 型框图描述配置项之间的关系 41HwcI标识 分小节描述分配给每个HWCI的系统需求 4.1X(HwCI名称和项目唯一标识号) 从4.1.1节开始编号,用名称和项目唯一标识号标识HWCI,并陈述它的用途。标识由 系统和段规范分配给HwCI的每个需求,标识由HwCI决定的每个系统功能的名称和项目 唯一标识号。系统的每个外部接口都要用标准术语(如,输入/输出电压、维数、冗余度、负载、 速度等)详细描述,并描述HwCI的设计约束。 4.2CSCI标识 分小节描述分配给每个CSCI的系统需求 42x(CC名称和项目唯一标识号)