软件开发的生命线——文档

文档是软件开发建设的生命线，它贯穿于软件开发的整个过程。文档是软件开发人员、管理人员、维护人员、用户以及计算机之间的桥梁和纽带。

软件开发人员在各个阶段都要以文档作为前一阶段工作成果的体现和后一阶段工作的依据。在软件开发过程中需指定一些工作计划和工作报告，供给管理人员，并得到同意和支持。管理人员通过文档了解软件开发的项目安排、进度、资源使用和成果等。软件开发的最终目的是满足用户的需求，所以开发人员需要针对用户对所开发软件的使用、操作、维护等提供详细的说明指导。用户文档、开发文档、管理文档构成了软件文档的主要部分：

		用户 文档		1.用户手册
				2.操作手册
				3.维护修改建议
				4.软件需求说明书
		开发 文档		1.软件需求说明书
				2.数据库设计说明书
				3.概要设计说明书
				4.详细设计说明书
				5.可行性研究报告
				6.项目开发计划
		管理 文档		1.项目开发计划
				2.测试计划
				3.测试分析报告
				4.开发进度月报
				5.项目开发总结报告

一、各文档在软件生存期的编写阶段：

阶段文档	可行性要求与计划	需求分析	设计	代码编写	测试	运行与维护
可行性研究报告
项目开发计划
软件需求说明
数据要求说明
概要设计说明
详细设计说明
测试计划
用户手册
操作手册
测试分析报告
开发进度月报
项目开发总结
维护修改建议

二、各文档所要问答的问题：

所提问题文档	什么	何处	何时	谁	如何	为何
可行性研究报告	√					√
项目开发计划	√		√	√
软件需求说明	√	√
数据库设计说明	√	√
概要设计说明					√
详细设计说明					√
测试计划			√	√	√
用户手册					√
操作手册					√
测试分析报告	√
开发进度月报	√		√
项目开发总结	√
维护修改建议	√			√		√

三、对各个文档主要内容和作用的理解：

1.可行性研究报告：

说明该软件开发项目的实现在技术、经济和社会因素等方面是否可行，阐述能够达到开发目标可供选择的各种可实施方案，以及指出当前系统存在的问题和需要改进之处，说明并论证所选定实施方案的理由和带来的效益。

2.项目开发计划：

为软件项目实施方案制定出具体计划，主要包括各部分工作人员开发的进度。经费的预算、所需的硬软件资源等。项目开发计划提供给管理部门，作为开发阶段评审的参考。

3.软件需求说明书：

也称软件规格说明书，其中对软件的功能、性能、用户界面及运行环境等做出详细的说明。它是用户与开发人员双方对软件需求取得共同理解基础上达成的协议，也是实施开发工作的基础。

4.数据库设计说明书：

给出数据库的概念设计、逻辑设计、物理设计以及数据字典和一些约定等，为生成和维护系统数据文卷做好准备。

5.概要设计说明书：

该说明书是概要设计阶段的工作成果，用于说明功能分配、模块划分、程序的总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理设计等，为接下来的详细设计奠定基础。

6.详细设计说明书：

详细描述每一个模块是如何实现的，包括实现算法、逻辑流程等。

7.用户手册：

本手册详细描述软件的功能、性能和用户界面，使用户了解如何使用该软件。

8.操作手册：

本手册为操作人员提供该软件的各种运行情况的有关知识，特别是操作方法的具体细节。

9.测试计划：

为如何组织测试制定实施计划。计划包括测试的内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。

10.测试分析报告：

测试工作完成后，提交测试计划执行情况的说明，对测试结果加以分析，并提出测试的结论意见。

11.开发进度月报：

软件开发人员按月向管理部门提交的项目进度情况报告。包括进度计划与实际执行情况的比较、阶段成果、遇到的问题和解决的办法以及下个月的打算等。

12.项目开发总结报告：

软件项目开发完成以后，要与项目实施计划对照，总结实际执行的情况，如进度、成果、资源利用、成本和投入的人力。此外还需对开发工作作出评价，总结经验教训。

13.维护修改建议：

软件产品投入运行后，发现了需要对其进行修正、更改的问题，将这些存在的问题、修改的考虑以及修改的影响估计作详细的描述，写成维护修改建议，提交审批。