软件文档(document)也称文件,通常指的是一些记录的数据 和数据媒体,它具有固定不变的形式,可被人和计算机阅读。它和 计算机程序共同构成了能完成特定功能的计算机软件(有人把源 程序也当作文档的一部分)。我们知道,硬件产品和产品资料在整 个生产过程中都是有形可见的,软件生产则有很大不同,文档本 身就是软件产品。没有文档的软件,不成其为软件,更谈不到软件 产品。软件文档的编制(documentation)在软件开发工作中占有突 出的地位和相当的工作量。高效率、高质量地开发、分发、管理和维 护文档对于转让、变更、修正、扩充和使用文档,对于充分发挥软 件产品的效益有着重要意义。
然而,在实际工作中,文档在编制和使用中存在着许多问 题,有待于解决。软件开发人员中较普遍地存在着对编制文档不感 兴趣的现象。从用户方面看,他们又常常抱怨:文档售价太高、文 档不够完整、文档编写得不好、文档已经陈旧或是文档太多,难于 使用等等。究竟应该怎样要求它,文档应该写哪些,说明什么问 题,起什么作用?这里将给出简要的介绍。
图 文档桥梁作用
文档在软件开发人员、软件管理人员、维护人员、用户以及计 算机之间的多种桥梁作用可从图9.2中看出。软件开发人员在各 个阶段中以文档作为前阶段工作成果的体现和后阶段工作的依 据,这个作用是显而易见的。软件开发过程中软件开发人员需制定 一些工作计划或工作报告,这些计划和报告都要提供给管理人员, 并得到必要的支持。管理人员则可通过这些文档了解软件开发项 目安排、进度、资源使用和成果等。软件开发人员需为用户了解软 件的使用、操作和维护提供详细的资料,我们称此为用户文档。以 上三种文档构成了软件文档的主要部分。我们把这三种文档所包 括的内容列在图6中。其中列举了十三个文档,这里对它们作 一些简要说明:
文档 | 用户文档 | 用户手册 | ||
操作手册 | ||||
维护修改建议 | ||||
软件需求(规格)说明书 | ||||
开发文档 | 软件需求(规格)说明书 | |||
数据要求说明书 | ||||
概要设计说明书 | ||||
详细设计说明书 | ||||
可行性研究报告 | ||||
项目开发计划 | ||||
管理文档 | 项目开发计划 | |||
测试计划 | ||||
测试报告 | ||||
开发进度月报 | ||||
开发总结报告 |
阶段 文档 |
可行性药酒与计划 | 需求分析 | 设计 | 代码编写 | 测试 | 运行与维护 |
可行性研究报告 | ||||||
项目开发计划 | ||||||
软件需求说明 | ||||||
数据要求说明 | ||||||
概要设计说明 | ||||||
星系设计说明 | ||||||
测试计划 | ||||||
用户手册 | ||||||
操作手册 | ||||||
测试分析报告 | ||||||
开发进度月报 | ||||||
项目开发总结 | ||||||
维护修改建议 |
上述十三个文档都在一定程度上回答了这六个方面的问题。这可从表中看到。
表 文档所回答的问题
所提问题 文档 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
至此,我们对文档的作用有了进一步的理解。每一个文档的任 务也是明确的,任何一个文档都此是多余的。