软件工程文档规范

1 前言
本文记录了随着项目开发过程所需要的所有文档，并附有详细说明，开发中可参考本笔记筛选使用具体内容。

2 软件工程国家标准
2.1 GB/T 8567—2006 计算机软件文档编制规范
该规范认为，计算机软件所包含的文件有两类：一类是开发过程中填写的各种图标，另一类是编制的技术资料或技术管理资料。前者称为工作表格，后者称为文档。规范中给出了14种文档的编写大纲，详细规定了每种文档自然语言形式的编写章节和内容。但并未涉及工作表格的设计和填写，知识在编制的提纲中偶尔提及一些常用的工作表格。

作为一份软件开发的指导性文件，该规范建议，在计算机软件的开发过程中，应该产生14种文档。

可行性研究报告

编制目的：说明软件开发项目的实现在技术、经济和社会条件等方面的可行性，评述为了合理地达到开发目标而可能选择的各种方案；说明并论证所选定的方案。

项目开发计划

编制目的：用文件形式把开发过程中对各项工作的负责人员、开发进度、所需经费预算、所需软硬件条件等问题做出的安排记载下来，以便根据本计划开展和检查本项目的开发工作。

软件需求规格说明书

编制目的：使客户和软件开发者双方对软件的初始规定有一个共同的理解，使之成为整个开发工作的基础。

数据要求说明书

编制目的：向整个开发时期提供关于被处理数据的描述和数据采集的要求的技术信息。

概要设计说明书

编制目的：说明对程序系统的设计考虑，包括程序系统的基本处理流程、程序系统的组织结构、模块划分、功能分配、接口设计、运行设计、数据结构设计和出错处理设计等，为程序的详细设计提供原则和基础。

详细设计说明书

编制目的：说明一个软件系统各层次中每一个程序（每个模块或子程序）的设计考虑。

数据库设计说明书

编制目的：对于设计中的数据库的所有标识、逻辑结构和物理结构做出具体的设计规定。

用户手册

编制目的：使用非专业术语，充分地描述该软件的功能和基本的使用方法，使用户（和潜在用户）能通过手册了解软件的用途以及如何在不同的情况下正确使用它。

操作手册

编制目的：向操作人员提供该软件运行的每一个具体过程和有关知识，包括操作细节。

模块开发卷宗

编制目的：以一个模块或一组密切相关的模块为单位，记录和汇总低层次开发的进度和结果，以便于整个模块开发工作的管理和评审，并未将来的维护提供非常有用的技术信息。

测试计划

编制目的：为程序系统的组装测试和确认测试提供计划，包括每项测试活动的内容、进度安排、设计考虑、测试数据的整理方法及评价准则。

测试分析报告

编制目的：把组装调试和确认测试的结果、发现及分析写成文件加以记载。

开发进度月报

编制目的：及时向有关管理部门汇报项目开发的进展和情况，以便及时发现和处理开发过程中出现的问题。

项目开发总结报告

编制目的：为了总结本项目软件开发工作的经验，说明实际取得的开发结果以及对整个开发工作的各个方面的评价。