中华人民共和国航空航天工业部航空工业标准 软件文档编制规范 HB6465-90 1主题内容与适用范围 本标准规定了在软件开发工作的各个阶段需要编制的文档. 本标准适用于软件开发的全过程. 2引用标准 GB/T11457软件工程术语 HB6464 软件开发规范 HB6466 软件质量保证计划编制规定 HB6467 软件配置管理计划编制规定 3术语 除下面给出的术语外，其他术语的定义见GB/T11457和HB6464. 3.1接口(Interface) 两个不同系统的交接部分.例如，两种硬设计的接口装置，两个程序块的接口程序，两个或 多个程序共向访问的存储区等. 3.2模块(Module) 程序中能逻辑地分开的部分. 4文档的作用 文档是计算机软件的重要组成部分，它有如下作用： a.作为软件开发人员在软件开发各阶段内工作的成果和结束标志； b.向管理人员报告软件开发过程的进展情况； c.记录开发过程中的技术信息，作为以后各开发阶段的依据： d.提供对软件有关运行、维护、培训和交流的信息，以提高维护效率，促进管理人员、开发 人员和用户之间在工作上的相互了解； e.向用户介绍软件的功能、性能和特点，便于用户判定此软件是否符合要求. 5编制文档需要考虑的因素 文档编制是一项非常仔细的工作，它是从最初提出一个文档的提纲开始，经过逐步充实内 航空航天工业部1990一09一18发布 1991-02-01实施 14 HB6465-90 容并反复检查和修改，直到正式交付使用的不断完善的过程.为了保证软件开发工作的顺利进 行，作为开发各阶段工作完成的重要标志，任务承办单位应按开发阶段的要求认真编制相应的 文档.文档编制与开发周期各阶段的关系参见表1. 表1.给出了软件开发期中各阶段应产生和完成的各种文档： a.可行性研究报告应在初期完成，它为是否进行软件开发的决策提供参考； b.项目开发计划应在需求分析阶段的早期完成，它将影响整个开发期； .需求规格说明应在需求分析阶段产生并完成，它将影响以后的各个阶段； d.数据要求说明应在需求分析阶段产生并完成，它将影响以后的各个阶段； e、概要设计说明应在概要设计阶段产生并完成，它将影响以后的三个阶段； f.详细设计说明应在详细设计阶段产生并完成，它将影响以后的两个阶段； g数据库设计说明应在详细设计阶段产生并完成，它将影响以后的两个阶段； h.用户手册应在需求分析阶段提出初稿，在概要设计阶段修改，并在以后各阶段逐步完 善，直到综合测试阶段结束时完成，将影响安装与验收阶段以及整个运行期； i.测试计划应在需求分析阶段提出初稿，在以后各阶段逐步修改完善，直到编码与单元 测试阶段； j测试报告应在综合测试阶段完成，它将影响安装与验收阶段； .项目开发总结应在安装与验收阶段完成. 5.1制订编制计划 在软件项目开发过程的早期，项目负责人应根据需要制订的一个文档编制计划，对应编制 文档的个数及详细程度，各文档完成日期，采用的质量保证方法等提出具体要求.并定期检查 文档草稿，以保证正确及时地制订出这些文档. 5.2及时性 软件开发人员必须明确，文档编制作为项目开发过程中的一个连续的组成部分，文档的起 草工作应按开发阶段做到随时进行，以避免由于在程序编制完成后再开始编写文档所带来的 产品内容协调的问题.同时，文档作为各阶段工作完成的标志，及时编制完成并通过评审，也有 利于尽早发现间题，及时解决，以避免带来不必要的损失. 5.3重复性 在本标准给出的各种文档中，内容上存在着某些重复这是为了方便每种文档不同的读 者，每一种文档都应自成体系，尽...
HB 6465-1990 软件文档编制规范.pdf
