10.4 交付阶段文档编写

10.4.1 交付清单的编写

在该文档中，我们将列出按照合同需要提交的各种交付物及其具体形态。其内容包括：

（1）文档清单：列出所交付的各种文档。

（2）软件清单：列出各个软件模块及其大小。

10.4.2 用户手册的编写

用户手册给出了软件系统安装、使用的具体环境和方法。它主要包含以下内容。

10．4．2．1 软件概述

对整个软件进行概要描述，可从可行性研究报告、软件需求规约中提取相关信息。

1）软件构成

说明最终制成的产品，包括：程序系统中各个程序的名字，它们之间的层次关系；所建立的每个数据库。

2）主要功能和性能

列出本软件产品实际所具有的主要功能和性能。

10．4．2．2 运行环境

对软件系统运行所依赖的软件和硬件资源进行描述。

1）硬件环境

列出为运行本软件所要求的硬件设备的最小配置，如：处理机的型号、内存容量；所要求的外存储器、媒体、记录格式、设备的型号和台数、联机／脱机；网络环境。

2）支持软件

说明运行本软件所需要的支持软件，如：操作系统的名称、版本号；程序语言的编译／汇编系统的名称和版本号；数据库管理系统的名称和版本号；其他支持软件。

3）数据结构

列出为支持本软件的运行所需要的数据库或文件。

10．4．2．3 使用过程

1）安装与初始化

一步一步地说明为使用本软件而需进行的安装与初始化过程，包括程序的存储形式、安装与初始化过程中的全部操作命令、系统对这些命令的反应与答复。描述安装工作完成的测试用例等。如果需要的话，还应说明安装过程中所需用到的专用软件。

2）输入

如果系统工作必须依赖指定的输入，则在此处描述规定输入数据的准备要求：输入数据的特点；输入格式：说明对初始输入数据和参量的格式要求，包括语法规则和有关约定；输入举例：为每个完整的输入形式提供样本。

3）输出

如果系统的功能中包含了成批的结果输出，则通过此处进行说明：输出数据的特点；输出格式；输出举例。

4）帮助信息获取

说明如何获取帮助信息。

10．4．2．4 运行说明

1）运行步骤

针对每一个功能，提供详细的描述，一般采用图文并茂的方式。

2）非常规过程

提供应急或非常规操作的必要信息及操作步骤，如出错处理操作、向后备系统切换操作以及维护人员须知的操作和注意事项。

10.4.3 软件验收报告的编写

软件验收报告是客户针对合同中的约定，对交付的材料和软件系统进行验收后形成的结论性意见。文档中应包含以下内容。

1）项目信息

列出以下项目相关的信息：项目名称；项目开发单位；项目开发时间；项目验收时间。

2）软件概述

此节与用户手册中的部分相同。

3）验收测试环境

提供对验收测试环境的描述。

（1）硬件，例如计算机、服务器、网络、交换机等。

（2）软件，例如操作系统、应用软件、系统软件、开发软件、测试程序等。

（3）文档，例如测试文档、技术文档、操作手册、用户手册等。

（4）人员，如客户代表、客户经理、项目经理、技术经理、开发人员、测试人员、技术支持人员以及第三方代表等。

4）验收及测试结果

（1）功能验收如表10-1所示。

（2）性能验收如表10-2所示。

（3）文档验收如表10-3所示。

5）验收总结

对验收结果进行总体描述。确定是否“通过”、“不通过”还是“有条件通过”。