软件文档编写规定

《软件文档编写规定》由会员分享，可在线阅读，更多相关《软件文档编写规定（33页珍藏版）》请在金锄头文库上搜索。

1、无锡航天长峰电子技术研究所企业标准QQ/CFDZ210 2005拟制：审核：会签：标 准 化：批准：1 范围本标准规定了软件文档的组成、标识和编制要求等。本标准适用于软件文档的编制。2 引用文件下列文件中的有关条款通过引用而成为本标准的条款。凡注日期或版 次的引用文件，其后的任何修改单（不包括勘误的内容）或修订版本都不 适用于本标准，但提倡使用本标准的各方探讨使用其最新版本的可能性。 凡不注日期或版次的引用文件，其最新版本适用于本标准。QQ/CFDZ111 软件工程化管理程序QQ/CFDZ201 技术文件归档签署规定3 术语和定义3.1 计算机软件文档 技术数据或信息，包括计算机的列表和打印输

2、出。计算机软件文档可 记录计算机软件的要求、设计或细节，解释软件的能力和限制条件，或提 供在软件运行期中使用或保障计算机软件的操作指令。4 职责4.1 产品标准化总师负责确定产品软件文档的齐套性要求；4.2 软件室产品软件负责人负责组织软件文档的编制。5 规定5.1 软件文档的组成 在软件开发过程中可能产生的文档按技术文件归档签署规定中的 软件文档完整性表。5.2 软件文档的标识5.2.1标识的组成 标识由产品代号、软件标识、文档简号、版本号和密级代号组成。5.2.2标识的填写规定a) 产品代号由科研部下发；b) 软件标识按各产品设计与试验规范的规定填写；c) 文档简号见表1；d) 版本号按软

3、件入库时定义的版本号；e) 密级代号按保密有关规定填写。5.3 软件文档的编制方法 5.3.1软件文档的格式a) 纸质软件文档的格式按硬件产品技术文件；b) 可执行文件可使用光盘(或软盘)作为复制载体。5.3.2软件文档的编写a)软件文档内容编写，参照GJB438A-1997规定，制定了各个文档的编写提示见附录A；b） 为使各文档章节的信息更加清晰可读，可采用图、表、矩阵或其它 形式的表示方式进行说明；c）合同有要求时，按顾客规定的要求编制软件文档。5.3.3标准文档的剪裁除另有规定外，本标准规定的各种软件文档可根据各产品的性质、特 点等具体情况进行剪裁，并应在产品的软件设计与编码规范中明确。

4、如： 产品规模较小时，可将“软件需求规格说明”和“接口需求规格说明”合 并拟制，接口的需求可插入“软件需求规格说明”文档中；“计算机系统 操作员手册”、“软件用户手册”和“软件程序员手册”可将有关章节合 并至“软件用户手册”中；对于无人机界面的软件，其有关操作、使用方 法和注意事项等可写入系统的技术说明书和使用说明书中。 5.3.4程序汇总表的编写5.3.4.1 程序汇总表是对电子设备中所有程序（包括可编程器件配置文件） 在设备中配置情况的具体描述，供组织和管理生产使用。程序汇总表的填 写，有以下规定：a）“软件标识或编号”栏填写程序的标识（包括产品代号、版本号和密级代号）或可编程器件的S整件

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

6、0-1：。如果本程序汇总表中包括其它软件产品、且该软件产品有单独的汇总 表时，则该软件产品汇总表中的程序不再汇入本汇总表，需在本汇总表末 尾加以引述，女|如：“成套软件产品的程序汇总表见CFDZ1.231.011RH”。5.3.4.2 单元或分系统的程序汇总表可以将可编程逻辑器件的 S 整件汇总 表和软件的程序汇总表分别汇总提交给总体，也可以合并汇总在一份汇总 表中。5.3.4.3 提交归档的程序汇总表应包括可编程逻辑器件的 S 整件和软件的 程序。程序汇总表整机工作令号序号软件标识 或编号程序装入SP整件文件号名称编号位置代号种类代号备注更改附录A（规范性附录） 软件文档编写提示 各文档的内

7、容、结构层次划分可按本提示和正文5.3.2条的规定编写。OA.1软件质量保证计划编写提示1 目的本计划的目的在于对所开发的,软件规定各种必要的质量保证措施，以保证交付的,软件能够满足项目委托单位的各种需求，能够满足开发任务书规定的各项具体需求。2.引用文件按文档号和标题列出本文档引用的所有文档。3 软件质量保证机构与职责4 软件质量控制程序和要求4.1 软件评审4.2 软件文档管理4.3 软件配置管理4.4 软件更改管理4.5 软件的测试、验收4.6 外购、外协软件的质量控制根据需要而定4.7 质量记录的收集、维护和保存描述准备计划、维护、评审和执行软件质量保证活动的记录。标识要使用的格式和要

8、记录的信 息。4.8 软件的维护A.2 系统分析和段设计文件编写提示1 范围1.1 标识 列出本文档的：a) 已批准的标识号；b) 标题；c) 缩略语；d) 本文档适用的系统；e) 由系统设计所派生需求的更高层的规格说明。1.2 概述概述本文档所适用的系统和CSCI的用途。1.3 文档概述 概述本文档的用途和内容。2 引用文档按文档号和标题列出本文档引用的所有文档。3 运行概念分节描述系统的运行概念。3.1 任务3.1.1 用户要求 描述系统必须满足的用户要求，并引用描述这些要求的文档。3.1.2 主要任务 描述系统的主要任务。3.2 支持环境 描述在系统生产和部署阶段所需的支持环境。3.2.

9、1 支持硬件 描述系统正常运行需要的硬件环境。3.2.2 支持软件 描述系统正常运行需要的软件环境。3.4 系统体系结构描述系统的内部结构，标识子系统、HWCI和CSCI，并概述其用途。描述子系统、HWCI和CSCI之 间的关系。标识和陈述系统每个内部接口的用途，用系统体系结构框图表示系统顶层的体系结构。3.5 运行情况 描述系统的每一种运行情况。对每个系统状态和方式，应标识其执行的配置项和执行的手工操作，也可以用图表表示。此外，还应描述系统以不同的状态和方式运行时，配置项之间执行的控制 流程和数据流程。4 系统设计本章应标识系统内部被指定为主要项目或关键项目的HWCI。分小节标识系统的每个H

10、WCI、CSCI 和手工操作，还应描述系统内部HWCI、CSCI和手工操作之间的关系，也可用树型框图描述配置项之 间的关系。4.1 HWCI 标识分小节描述分配给每个HWCI的系统需求。4.1. X （HWCI名称和项目唯一标识号）从4.1.1节开始编号，用名称和项目唯一标识号标识-HWCI，并陈述它的用途。标识由系统和段规 范分配给HWCI的每个需求，标识由HWCI决定的每个系统功能的名称和项目唯一标识号。系统的每个 外部接口都要用标准术语（如:输入/输出电压、维数、冗余度、负载、速度等）详细描述，并描述 HWCI的设计约束。4.2 CSCI 标识分小节描述分配给每个CSC I的系统需求。4

11、.2. X （CSC I名称和项目唯一标识号）从4.2.1节开始编号，用名称和项目唯一标识号标识CSCI，并陈述它的用途。标识由系统和段规 范分配给CSCI的每个需求，标识由HWCI决定的每个系统功能的名称和项目唯一标识号。系统的每个 外部接口都要用标准术语（如：位/秒、字长、消息格式、消息频率、优先权规则、协议等）详细描 述。并描述CSCI的设计约束。4.3 手工操作标识 分小节描述分配给每个手工操作的系统需求。4.4 内部接口 分节描述系统内部每个接口及其系统中接口与配置项之间关系，并可以引用系统内部接口框图。4.4.X （接口名称和项目唯一标识号） 从4.4.1节开始编号，用名称和项目唯

12、一标识号标识系统内部所有的接口，标识模块间传输的每 个信号。5 处理资源分小节描述系统的处理资源。5. X （处理资源名称和项目唯一标识号）从5.1节开始编号，用名称和项目唯一标识号标识处理资源、系统使用的配置项。对每个处理资 源要指定其使用特性。例如对计算机硬件还应定义下列特征：a）内存大小：计算机内部存储器（独立、共享或全部）的大小；b）字长：每个计算机字的位数；c）处理速度：计算机处理器能力（独立、共享或全部）（如在全部配置运行时有的余量）；d）字符集标准：如：Unicodee）中断能力：硬件的中断能力；f）直接存储器访问（DMA）： DMA的数据传输；g）辅助存储器：辅助存储器容量（独

13、立、共享或全部）；h）其他；6. 质量因素的考虑根据情况，分小节指明质量因素和质量度量的模型，包括相关的评价标准。OA.3软件开发计划编写提示1 范围1.1标识 引出本文档的：a) 已批准的标识号；b) 标题；c) 缩略语；d) 本文档适用的计算机软件配置项(CSCI)。并标明CSCI的标题、缩写和标识号。1.2 概述概述本文档所适用的系统和CSCI的用途。1.3 文档概述概述本文档的用途和内容。1.4 与其它计划的关系 概述本计划与其它项目开发计划的关系。2 引用文档按文档号和标题列出本文档引用的所有文档。3 软件开发管理分节描述与软件开发管理活动相关的计划。3.1 项目组织与资源 分小节叙

14、述承制方的项目组织和项目资源。3.1.1 承制方的设施 叙述用于完成合同的设施。醒目地标出安全保密范围和简述安全保密活动的特点。还要醒目标出特定的资源，如：软件工程环境。3.1.2 管理部门提供的设备、软件和服务 描述为完成合同要求由管理部门提供的所有设备、软件、服务和设施，其中包括何时需要的详细进度表。要醒目的标出在系统规范、主要项目或关键项目开发说明中未列出的但要求的项目。3.1.3 组织机构 概述承制方软件项目组织机构。标识每个组织的权限和职责，可以用图表来表示此信息。3.1.4 人员 描述完成软件开发项目必须的人员数量，指明项目管理、软件工程、正式软件测试、软件产品评价、软件配置管理以及本计划标识的其它功能分别所需的人员数目及总数。3.2 进度和里程碑3.2.1 活动 以承制方主要进度表为基础，简要的叙述项目的每个软件开发活动及其相应的进度。 开发进度还应指明所有的重要事件，如评审