软件开发软件产品开发文件编制指南

附录五国家标准《计算机软件产品开发文件编制指南》国家标准《计算机软件产品开发文件编制指南》（GB 8567—88）是一份指导性文件。它建议在软件的开发过程申编下述14个文件：可行性研究报告、项目开发计划、软件需求说明书、数据要求说明书、总体设计说明书、详细设计说明、数据库设计说明书、用户手册、操作手册、模块开发卷、测试计划、测试分析报告、开发进度表、项目开发总结。该指南给出了这14个文件的编制提示，它同时也是这14个文件编写质量的检验准则。下面详细介绍这14种文件的编写目的与内容要求。

l、可行性研究报告

可行性研究报告的目的是：说明该软件开发项目的实现在技术上、经济上和社会条上的可行性，论述为了合理地达到开发目标而可能选择的各种方案，说明并论证所选定的方案。可行性研究报告的编写内容见表l。

表l 可行性研究报告

2、项目开发计划

编制项目开发计划的目的是用文件的形式，并在开发过程中各项工作的

负责人员、开发进度、经费预算、所需软硬件条件等问题做出的安排记录下来，以便根据本计划开展和检查项目的开发工作。编制内容要求如表2所示。

表 2 项目开发计划

3、软件需求说明书

软件需求说明书的编制是为了使用户和软件开发人员双方对该软件的初始规定有一个共同的理解，使

之成为整个软件开发工作的基础。其内容要求见表3。

表3 软件需求说明书

4、数据要求说明书

数据要求说明书的编制目的是为了向整个软件开发时期提供关于被处理数据的描述和数据采集要求的技术信息，其内容要求列于表4中。

表4 数据要求说明书

5、概要设计说明书

概要设计说明书又称为总体设计说明书，编制目的是说明对项目系统的设计考虑，包括基本处理流程、组织结构、模块结构、功能配置、接口设计、运行设计、系统配置、数据结构设计和出错处理设计等，为程序的详细设计提供基础。其内容要求见表5。

表5 概要设计说明书

6、详细设计说明书

详细设计说明书又称为程序设计说明，编制目的是说明一个软件系统各个层次中的每一个程序（模块）的设计考虑。如果软件系统比较简

单，层次少，本文件可以不单独编写，有关内容可并入概要设计说明书。详细设计说明书的内容要求见表6。

表6 详细设计说明书

7、数据库设计说明书

数据库设计说明书的编制目的是对于设计中的数据的所有标识、逻辑结

表7 数据库设计说明书

构和物理结构做出具体的设计规定。内容要求见表7。

8、用户手册

用户手册的编制是使用非专业术语的语言，充分地描述该软件系统所具有的功能及基本的使用方法。使用户通过本手册能够了解该软件的用途，并能够确定在什么情况下、如何使用它。具体的内容要求见表8。

表8 用户手册

9、操作手册

操作手册的编制是为了向操作人员提供该软件每个运行的具体过程的有关知识，包括操作方法的细节。内容要求见表9。

表9 操作手册

10、模块开发卷宗

模块开发卷宗是在模块开发过程中逐步编写出来的。每完成一个模块或一组密切相关的模块，复审时编写出一份，应该把所有的模块开发卷宗汇集在一起。编写的目的是记录和汇总低层次开发的进度和结果；以便于对整个系统开发工作进行管理的复审，并为将来的维护提供有用的技术信息。具体内容要求见表10。 11、测

试计划

表10 模块开发卷宗

表10a 模块开发情况表

这里所说的测试是指整个软件系统的组装测试和确认测试，本文件的编制是为了提供一个对该软件的测试计划，包括对每项测试活动的内容、进度安排、设计考虑、测试数据的整体性方法及评价准则。具体内容见表11。

表11 测试计划

12、测试分析报告

测试分析报告的编写是为了把组装测试和确认测试的结果、发现的问题以及分析结果写出成文件形式加以保存，具体编写内容要

求见表12。

表12 测试分析报告

13、开发进度月报

开发进度月报的编制目的是及时向有关管理部汇报项目开发的进度和情况

,以便及时发现和处理开发过程中出现的问题。一般来说，开发进度月报是以项目组为单位每月编写的，具体内容要求见表13。

表13 开发进度月报

14、项目开发总结报告

项目开发总结报告的编制是为了总结本项目开发工作的经验，说明实际取得的开发成果以及对整个开发工作的各个方面的评价，具体内容要求见表14。

表14 项目开发总结报告