文档介绍：计算机软件文档编制规范
冯惠
GB/T 8567-2019 计算机软件文档编制规范
目次
1 修订背景
２ 修订依据
３ 新老版本的差异
４ 新版标准结构
５ 文档编制过程
６ 文档编制要求
７ 文档编制格式
８ 小结
宜确认草案（包含评审对草案的评论）已经准备好批准。
六、文档编制要求
软件生存周期与各种文档的编制
在计算机软件的生存周期中，一般地说，应该产生以下一些基本文档。
可行性分析（研究）报告；
软件（或项目）开发计划；
软件需求规格说明；
接口需求规格说明；
系统／子系统设计（结构设计）说明；
软件（结构）设计说明；
接口设计说明；
数据库（顶层）设计说明；
（软件）用户手册；
操作手册；
测试计划；
测试报告；
软件配置管理计划；
软件质量保证计划；
开发进度月报；
项目开发总结报告；
软件产品规格说明；
软件版本说明等。
本标准将给出这些文档的编制规范，同时，本标准也是这些文档的编写质量的检验准则。一般地说，一个软件总是一个计算机系统（包括硬件，固件和软件）的组成部分。鉴于计算机系统的多样性，本标准一般不涉及整个系统开发中的文档编制问题，本标准仅仅是软件开发过程中的文档编制指南。
对于使用文档的人员而言他们所关心的文件的种类随他们所承担的工作而异。
管理人员：
可行性分析（研究）报告，
项目开发计划，
软件配置管理计划，
软件质量保证计划，
开发进度月报，
项目开发总结报告；
开发人员：
可行性分析（研究）报告，
项目开发计划，
软件需求规格说明，
接口需求规格说明，
软件（结构）设计说明，
接口设计说明书，
数据库（顶层）设计说明，
测试计划，
测试报告；
维护人员：
软件需求规格说明，
接口需求规格说明，
软件（结构）设计说明，
测试报告，
用 户：
软件产品规格说明，
软件版本说明，
用户手册，
操作手册。
本标准规定了在软件开发过程中文档编制的要求，这些文档从使用的角度可分为用户文档和开发文档两大类。其中，用户文档必须交给用户。用户应该得到的文档的种类和规模由供应者与用户之间签订的合同规定。
如前所述，软件，从出现一个构思之日起，经过软件开发成功投入使用，直到最后决定停止使用并被另一项软件代替之时止，被认为是该软件的一个生存周期，一般地说这个软件生存周期可以分成以下六个阶段：
可行性与计划研究阶段；
需求分析阶段；
设计阶段；
实现阶段；
测试阶段；
运行与维护阶段。
在可行性分析（研究）与计划阶段内，要确定该软件的开发目标和总的要求，要进行可行性分析、投资一收益分析、制订开发计划，并完成应编制的文档。
在需求分析阶段内，由系统分析人员对被设计的系统进行系统分析，确定对该软件的各项功能、性能需求和设计约束，确定对文档编制的要求，作为本阶段工作的结果，一般地说软件需求规格说明（也称为：软件需求说明、软件规格说明）、数据要求说明和初步的用户手册应该编写出来。
在设计阶段内，系统设计人员和程序设计人员应该在反复理解软件需求的基础上，提出多个设计，分析每个设计能履行的功能并进行相互比较，最后确定一个设计，包括该软件的结构、模块（或CSCI）的划分、功能的分配，以及处理流程。在被设计系统比较复杂的情况下，设计阶段应分解成概要设计阶段和详细设计阶段两个步骤。在一般情况下，应完成的文档包括：结构设计说明、详细设计说明和测试计划初稿。
在实现阶段内，要完成源程序的编码、编译（或汇编）和排错调试得到无语法错的程序清单，要开始编写进度日报、周报和月报（是否要有日报或周报，取决于项目的重要性和规模），并且要完成用户手册、操作手册等面向用户的文档的编写工作，还要完成测试计划的编制。
在测试阶段：该程序将被全面地测试，已编制的文档将被检查审阅。一般要完成测试分析报告。作为开发工作的结束，所生产的程序、文档以及开发工作本身将逐项被评价，最后写出项目开发总结报告。
在整个开发过程中（即前五个阶段中），开发团队要按月编写开发进度月报。
在运行和维护阶段，软件将在运行使用中不断地被维护，根据新提出的需求