05-项目说明书

25.4　项目说明书

**本节视频教学录像：8分钟**

计算机软件是计算机系统中与硬件相互依存的另一部分，包括程序、数据及其相关文档的完整集合。文档是软件产品的一部分，是与程序开发、维护和使用有关的图文材料，没有文档的软件是不完整的。软件文档的编制在软件开发工作中占有突出的地位，并且工作量也非常大。高质量、高效率地开发、分发、管理和维护文档，对于转让、变更、修正、扩充和使用文档，充分地发挥软件产品的效益有着十分重要的意义。

文档在产品的开发生产过程中起着重要的作用。主要作用介绍如下。

（1）提高软件开发过程的能见度。

把开发过程中发生的事件以可阅读的形式记录起来，管理人员可以把这些记载下来的材料作为检查软件开发进度和开发质量的依据，实现对软件开发的工程管理。

（2）提高开发效率。

通过软件文档的编制，可以使开发人员对各个阶段的工作进行周密思考、全盘权衡，从而减少返工，并且可在开发早期发现错误和不一致性，以便及时纠正。

（3）可作为开发人员在一定阶段的工作成果和结束标志。

（4）记录开发过程中的有关信息，便于协调以后的软件开发、使用和维护。

（5）提供对软件的运行、维护和培训的有关信息，便于管理人员、开发人员、操作人员、用户之间的协作、交流和了解，使软件开发活动更科学、更有成效。

（6）便于潜在用户了解软件的功能、性能等各项指标，为他们选购符合自己需要的软件提供依据。

从某种意义上来说，文档是软件开发规范的体现和指南。按照规范要求生成一整套文档的过程，就是按照软件开发规范完成一个软件开发的过程。所以，在使用工程化的原理和方法来指导软件的开发和维护时，应当充分注意软件文档的编制和管理。

按照文档产生和使用的范围，软件文档大致可分为以下3类。

（1）开发文档。这类文档是在软件开发过程中，作为软件开发人员前一阶段工作成果的体现和后一阶段工作依据的文档，包括软件需求说明书、数据要求说明书、概要设计说明书、详细设计说明书、可行性研究报告、项目开发计划等。

（2）管理文档。这类文档是在软件开发过程中，由软件开发人员制订的工作计划或工作报告，使管理人员能够通过这些文档了解软件开发项目安排、进度、资源使用和成果等，包括项目开发计划、测试计划、测试报告、开发进度月报及项目开发总结等。

（3）用户文档。这类文档是软件开发人员为用户准备的有关该软件使用、操作、维护的资料，包括用户手册、操作手册、维护修改建议、软件需求说明书等。

整个软件开发过程应提交的文档归纳为以下13种。

1．可行性研究报告

说明该软件项目的实现在技术、经济和管理等方面的可行性，评价为合理地达到开发目标可供选择的各种可能的实现方案，说明并论证所选定实施方案的理由。

2．项目开发计划

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

3．软件需求说明书

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

4．数据要求说明书

该说明书应给出数据逻辑描述和数据采集的各项要求，为生成和维护系统的数据文件做好准备。

5．概要设计说明书

也叫总体设计说明书，是总体设计工作阶段的成果。它应当说明系统的功能、模块划分、程序的总体结构、输入/输出及接口设计、运行设计、数据结构设计和出错处理设计等，为详细设计奠定基础。

6．详细设计说明书

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

7．用户手册

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

8．操作手册

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

9．测试计划

针对组织测试和确认测试，需要为组织测试制订计划，计划应包括测试的内容、进度、条件、人员，测试用例的选取原则、测试结果允许的偏差范围等。

10．测试分析报告

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

11．开发进度月报

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

12．项目开发总结报告

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

13．维护修改建议

软件产品投入运行之后，可能有修正、更改等问题，应当对存在的问题、修改的考虑以及修改的影响估计等做详细的描述，写成维护修改建议，提交审批。

上述13个文档，最终要向软件管理部门或用户回答下列问题：要满足哪些需求，即回答“做什么”；所开发的软件在什么环境中实现，所需信息从哪里来，即回答“从何处”；开发工作的时间如何安排，即回答“何时做”；开发(或维护)工作打算“由谁来做”；需求应如何实现，即回答“怎样干”；为什么要进行这些软件的开发或维护修改。具体在哪个文档要回答哪些问题，与软件开发人员和文档的编制有关。

然而在实际工作中，软件开发人员普遍地存在着对编制文档不感兴趣的现象。从用户方面来看，他们又常常抱怨：文档不够完整、文档编写得不好、文档已经陈旧，或是文档太多，难以使用，等等。所以为了对软件开发流程进行更好的管理，一定要重视文档的编写工作。