|
|
|
软件产品由可运行的程序、数据和文档组成。文档是软件的一个重要组成部分。
|
|
|
|
在软件的整个生命周期中，会用到许多文档，在各个阶段中以文档作为前阶段工作成果的体现和后阶段工作的依据。在软件的开发过程中，软件开发人员需根据工作计划和需求说明书由粗而细地进行设计，这些需求说明书和设计说明书构成了开发文档。为了使用户了解软件的使用、操作和对软件进行维护，软件开发人员需要为用户提供详细的资料，这些资料称为用户文档。而为了使管理人员及整个软件开发项目组了解软件开发项目安排、进度、资源使用和成果等，还需要制定和编写一些工作计划或工作报告，这些计划和报告构成了管理文档。软件文档的分类结构图如下图所示。
|
|
|
|
|
|
|
|
|
|
. 可行性研究报告：说明该软件开发项目的实现在技术上、经济上和社会因素上的可行性，评述为了合理地达到开发目标可供选择的各种可能实施的方案，说明并论证所选定实施方案的理由。
|
|
|
|
. 项目开发计划：为软件项目实施方案制定出具体计划，应该包括各部分工作的负责人员、开发的进度、开发经费的预算、所需的硬件及软件资源等。项目开发计划应提供给管理部门，并作为开发阶段评审的参考。
|
|
|
|
. 软件需求说明书：也称软件规格说明书，其中对所开发软件的功能、性能、用户界面及运行环境等作出详细的说明。它是用户与开发人员双方对软件需求取得共同理解的基础上达成的协议，也是实施开发工作的基础。
|
|
|
|
. 数据库设计说明书：只对使用数据库的软件适用，该说明书应给出数据库的整体架构及各个数据表中的逻辑关系。
|
|
|
|
. 概要设计说明书：该说明书是概要设计阶段的工作成果，它应说明功能分配、模块划分、程序的总体结构、输入输出以及接口设计、运行设计、数据结构设计和出错处理设计等，为详细设计奠定基础。
|
|
|
|
. 详细设计说明书：着重描述每一模块是怎样实现的，包括实现算法、逻辑流程等。
|
|
|
|
. 用户手册：本手册详细描述软件的功能、性能和用户界面，使用户了解如何使用该软件。
|
|
|
|
. 测试计划：计划应包括测试的内容、进度、条件、人员、测试用例的选取原则、测试结果允许的偏差范围等。
|
|
|
|
. 测试分析报告：测试工作完成以后，应提交测试计划执行情况的说明。对测试结果加以分析，并提出测试的结论意见。
|
|
|
|
. 开发进度月报：该月报是软件人员按月向管理部门提交的项目进展情况报告。报告应包括进度计划与实际执行情况的比较、阶段成果、遇到的问题和解决的办法以及下个月的打算等。
|
|
|
|
. 项目开发总结报告：软件项目开发完成以后，应与项目实施计划对照，总结实际执行的情况，如进度、成果、资源利用、成本和投入的人力。此外还需对开发工作作出评价，总结出经验和教训。
|
|
|
|
. 操作手册：本手册为操作人员提供该软件各种运行情况的有关知识，特别是操作方法的具体细节。
|
|
|
|
. 维护修改建议：软件产品投入运行以后，发现了需对其进行修正、更改等的问题，应将存在的问题、修改的考虑以及修改的估计影响作详细的描述，写成维护修改建议，提交审批。
|
|
|
|
以上这些文档是在软件生存期中，随着各阶段工作的开展适时编制的。其中有的仅反映一个阶段的工作，有的则需跨越多个阶段。
|
|
|
|
开发文档的测试在“软件生命周期测试策略”一章中已进行了详述，这里不再重复，本章以下部分将主要就用户文档的测试进行描述。
|
|
|
