GJB 438B-2009《军用软件开发文档通用要求》目前正在修订,并已形成征求意见稿,GJB438C-2017很快与各位见面,那么与上一版本相比有哪些改变,我们先剧透下:
1)将软件配置管理计划(SCMP)、软件质量保证计划(SQAP)纳入软件开发计划 (SDP),将软件配置管理报告(SCMR)、软件质量保证报告(SQAR)纳入软件研制总结报告(SDSR),不作为单独的文档;
2)删除了软件输入/输出手册(SIOM);软件中心操作员手册(SCOM)、计算机操作手册(COM)、软件研制任务书(SDTD);
3)增加了“4.1 总则”,明确了文档载体和文档格式方面的要求;
4)“4.3 文档组成”中,明确了数据库或其他格式的文档方面的要求;
5)增加了页号/页标记要求,明确文档的每一页应有唯一的页号,适用时每页还可有文档号、版本/修订号和卷号等;
6)详细要求”根据文档种类的调整进行了修改;
7)修改了《运行方案说明》、《系统/子系统规格说明》等23个文档;
8)运行方案说明、系统/子系统规格说明(SSS)、系统/子系统设计说明(SSDD)等文档中的“合格性规定”改为“鉴定检验”;
9)软件测试计划(STP)中增加对测试环境的概述;
10)系统/子系统规格说明等文档中将“安全性需求”、“保密性需求”、“系统质量因素”合并为“系统质量特性需求”。
下面将标准正文主要修改的4.1与4.3节内容列出,供大家参考:
4.1 总则
本标准给出了根据GJB 2786进行软件开发所产生的主要文档。文档描述了军用软件开发过程中的主要活动信息和要求,当以数据库等格式保存时,则为数据的集合。其中:
a)文档载体:分为纸型和电子文件介质;
b)文档格式:分为传统纸型文件格式和电子文件格式,电子文件格式如数据库、交互电子手册、文档处理器(如WPS)兼容的格式,或者软件开发人员存储在计算机辅助软件工程(CASE)工具中的格式。
本标准规定的文件格式主要适用于军用软件合同(研制任务书)签订时提出软件开发过程中文档或数据的要求,订购方应在合同中规定所交付文档的载体以及文档的格式。
4.3 文档组成
4.3.1 文档构成
文档一般由封面、目录、正文和附录组成。
4.3.2 封面
适用时,封面宜包括如下内容:
a)文档号、版本/修订号和卷号;
b)密级;
c)文档名称;
d)所适用的系统或软件标识;
e)编制单位;
f)编写;
g)审核;
h)批准编制/修订日期。
对于数据库或其他格式的文档,封面信息可包含在外部和内部的标记中,也可采用其他等效方法进行标记。
4.3.3 目录
目录应包括章、条、图表、注释和附录的编号、标题及其所在页码。
对于数据库或其他格式的文档,目录可为包含章、条、图表、注释和附录的指针或访问命令的外部和内部的目录表。
4.3.4 正文
正文为各文档的具体内容,详细要求见第5章。
4.3.5 附录
文档的附录应提供为便于文档维护可以单独发布的信息(例如:图、表、分类数据等)。每个附录都应在文档的正文中被引用。附录可作为一个单独的文档,以A、 B等大写字母标记。
4.3.6 其他
4.3.6.1 页号/页标记
文档的每一页应有唯一的页号,适用时每页还可有文档号、版本/修订号和卷号等。文档正文的页使用小写罗马数字编号;文档正文和附录的页均使用阿拉伯数字顺序编号;若一个文档分为若干卷,则每一卷应重新开始按顺序编号。
对于数据库或其他格式的文档,以方便访问或检索的方式,对文件、截屏或其他内容指定名称或编号。
4.3.6.2 条或子条
为增加可读性,文档的条或子条均可拆分为若个条或子条。文档中字母X和Y为各文档条或子条编号的自变量,标题上圆括号中的文字在编写时要用实际内容替换。
示例:在“软件需求规格说明”文档中3.2.X条在实际应用时可能为:
3.2.1 信号采集—R001
3.2.2 信号传输—R002
4.3.6.3 表示形式
为使各文档章条的信息更加清晰可读,可采用图、表、矩阵或其他形式的表示方式进行说明。