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封面 封面一般应包括: