软件文档编写规定

《软件文档编写规定》由会员上传分享，免费在线阅读，更多相关内容在学术论文-天天文库。

1、软件文档编写规定I无锡航天长峰电子技术研究所无锡航天长峰电子技术研究所企业标准QQ/CFDZ210－2005拟制：审核：会签：标准化：批准：QQ/CFDZ210-20051范围本标准规定了软件文档的组成、标识和编制要求等。本标准适用于软件文档的编制。2引用文件下列文件中的有关条款通过引用而成为本标准的条款。凡注日期或版次的引用文件，其后的任何修改单（不包括勘误的内容）或修订版本都不适用于本标准，但提倡使用本标准的各方探讨使用其最新版本的可能性。凡不注日期或版次的引用文件，其最新版本适用于本标准。QQ/CFDZ111软

2、件工程化管理程序QQ/CFDZ201技术文件归档签署规定3术语和定义3.1计算机软件文档技术数据或信息，包括计算机的列表和打印输出。计算机软件文档可记录计算机软件的要求、设计或细节，解释软件的能力和限制条件，或提供在软件运行期中使用或保障计算机软件的操作指令。4职责4.1产品标准化总师负责确定产品软件文档的齐套性要求；4.2软件室产品软件负责人负责组织软件文档的编制。5规定5.1软件文档的组成在软件开发过程中可能产生的文档按《40无锡航天长峰电子技术研究所QQ/CFDZ210-2005技术文件归档签署规定》中的软件文

3、档完整性表。1.1软件文档的标识1.1.1标识的组成标识由产品代号、软件标识、文档简号、版本号和密级代号组成。1.1.2标识的填写规定a)产品代号由科研部下发；b)软件标识按各产品设计与试验规范的规定填写；c)文档简号见表1；d)版本号按软件入库时定义的版本号；e)密级代号按保密有关规定填写。1.2软件文档的编制方法1.2.1软件文档的格式a)纸质软件文档的格式按硬件产品技术文件；b)可执行文件可使用光盘（或软盘）作为复制载体。1.2.2软件文档的编写a)软件文档内容编写，参照GJB438A-1997规定，制定了各个

4、文档的编写提示见附录A；b)为使各文档章节的信息更加清晰可读，可采用图、表、矩阵或其它形式的表示方式进行说明；c)合同有要求时，按顾客规定的要求编制软件文档。1.2.3标准文档的剪裁除另有规定外，本标准规定的各种软件文档可根据各产品的性质、特点等具体情况进行剪裁，并应在产品的软件设计与编码规范中明确。如：产品规模较小时，可将“软件需求规格说明”和“接口需求规格说明”合并拟制，接口的需求可插入“软件需求规格说明”文档中；“计算机系统操作员手册”、“软件用户手册”和“软件程序员手册”可将有关章节合并至“软件用户手册”中；

5、对于无人机界面的软件，其有关操作、使用方法和注意事项等可写入系统的技术说明书和使用说明书中。40无锡航天长峰电子技术研究所QQ/CFDZ210-20051.1.1程序汇总表的编写1.1.1.1程序汇总表是对电子设备中所有程序（包括可编程器件配置文件）在设备中配置情况的具体描述，供组织和管理生产使用。程序汇总表的填写，有以下规定：a)“软件标识或编号”栏填写程序的标识（包括产品代号、版本号和密级代号）或可编程器件的S整件的编号（包括版本号和密级代号）。当多个CSCI或CSC或CSU合装在一个固件中时，除在首栏填写组合程

6、序的标识外，还需在其下栏填写每个CSCI或CSC或CSU的标识；b)“名称”栏填写各程序的功能名称；c)“编号”栏填写各程序装入的固件所在的SP整件编号（所有装有程序的硬件需编制SP整件）；d)“位置代号”栏填写SP整件所在系统中的位置；e)“种类代号”栏填写固件所在电路中的种类代号；若一个程序分开装入二个以上固件时，应在相应栏内填写各固件所在电路中的种类代号；f)“整机工作令号”填写整机产品的工作令号和台（套）号，如第二批960产品共十套，其第一套的整机工作令号填写960-023-10-1：。如果本程序汇总表中包括

7、其它软件产品、且该软件产品有单独的汇总表时，则该软件产品汇总表中的程序不再汇入本汇总表，需在本汇总表末尾加以引述，如：“成套软件产品的程序汇总表见CFDZ1.231.011RH”。1.1.1.2单元或分系统的程序汇总表可以将可编程逻辑器件的S整件汇总表和软件的程序汇总表分别汇总提交给总体，也可以合并汇总在一份汇总表中。1.1.1.3提交归档的程序汇总表应包括可编程逻辑器件的S整件和软件的程序。40无锡航天长峰电子技术研究所QQ/CFDZ210-2005程序汇总表整机工作令号序号软件标识或编号程序装入SP整件文件号名称

8、编号位置代号种类代号备注更改40无锡航天长峰电子技术研究所QQ/CFDZ210-2005附录A（规范性附录）软件文档编写提示各文档的内容、结构层次划分可按本提示和正文5.3.2条的规定编写。○A.1软件质量保证计划编写提示1目的本计划的目的在于对所开发的,,软件规定各种必要的质量保证措施，以保证交付的,,软件能够满足项目委托单位的各种需求，能够