用户手册 版本 修订历史记录 日期 版本 修订说明 作者 1
1 用户手册 版本 修订历史记录 日期 版本 修订说明 作者
1引言… 1.1编写目的. 1.2适用范围. 1.3定义. 14参考资料 1.5概述 2.项目信息… 3.产品概述… 错误!未定义书签。 3.1产品 错误!未定义书签。 3.2主要功能和性能 错误!未定义书签。 4.验收测试环境 错误!未定义书签。 4.1硬件. 错误!未定义书签。 4.2软件. 错误!未定义书签。 4.3文档. 错误!未定义书签。 4.4人员 错误!未定义书签。 5.验收及测试结果 错误!未定义书签。 5.1功能验收 错误!未定义书签。 5.2性能验收.… 错误!未定义书签。 5.3文档验收 错误!未定义书签。 6.验收总结. 错误!未定义书签。 2
2 1 引言..................................................................................................................................................1 1.1 编写目的...................................................................................................................................1 1.2 适用范围...................................................................................................................................1 1.3 定义...........................................................................................................................................1 1.4 参考资料...................................................................................................................................1 1.5 概述...........................................................................................................................................1 2. 项目信息........................................................................................................................................1 3. 产品概述..................................................................................................... 错误!未定义书签。 3.1 产品........................................................................................................ 错误!未定义书签。 3.2 主要功能和性能.................................................................................... 错误!未定义书签。 4. 验收测试环境............................................................................................. 错误!未定义书签。 4.1 硬件........................................................................................................ 错误!未定义书签。 4.2 软件........................................................................................................ 错误!未定义书签。 4.3 文档........................................................................................................ 错误!未定义书签。 4.4 人员........................................................................................................ 错误!未定义书签。 5. 验收及测试结果.........................................................................................错误!未定义书签。 5.1 功能验收................................................................................................ 错误!未定义书签。 5.2 性能验收................................................................................................错误!未定义书签。 5.3 文档验收................................................................................................错误!未定义书签。 6. 验收总结..................................................................................................... 错误!未定义书签
用户手册 1.引言 1.1编写目的 说明:编写这份文档目的,并指出预期的读者。 1.2适用范围 列出此文档适用的软件应用程序、特性或其他子系统分组、与其相关的用例模型,以及 受到此文档影响的任何其他产品。 1.3定义 列出本文件中用到的专门术语的定义和外文的首字母缩写词。可以引用项目词汇表来提 供。 1.4参考资料 列出本文中各处引用的文档资料,包括每个文档的标题、文档编号、发表日期和出版单 位并列出能够得到这些文件资料的来源。 1.5概述 说明本文件中其他各部分包含的内容,与本文件的内容组织方式。 2.软件概述 对整个软件进行概要描述,可从《可行性研究报告》、《软件需求规约》中提取相关信息。 2.1软件构成 说明最终制成的产品,包括:
1 用户手册 1.引言 1.1 编写目的 说明:编写这份文档目的,并指出预期的读者。 1.2 适用范围 列出此文档适用的软件应用程序、特性或其他子系统分组、与其相关的用例模型,以及 受到此文档影响的任何其他产品。 1.3 定义 列出本文件中用到的专门术语的定义和外文的首字母缩写词。可以引用项目词汇表来提 供。 1.4 参考资料 列出本文中各处引用的文档资料,包括每个文档的标题、文档编号、发表日期和出版单 位并列出能够得到这些文件资料的来源。 1.5 概述 说明本文件中其他各部分包含的内容,与本文件的内容组织方式。 2. 软件概述 对整个软件进行概要描述,可从《可行性研究报告》、《软件需求规约》中提取相关信息。 2.1 软件构成 说明最终制成的产品,包括:
程序系统中各个程序的名字,它们之间的层次关系 ● 所建立的每个数据库 2.2主要功能和性能 列出本软件产品所实际具有的主要功能和性能。 3.运行环境 对软件系统运行所依赖的软件和硬件资源进行描述。 3.1硬件环境 列出为运行本软件所要求的硬件设备的最小配置,如: 处理机的型号、内存容量: 所要求的外存储器、媒体、记录格式、设备的型号和台数、联机/脱机: ● 网络环境。 3.2支持软件 说明运行本软件所需要的支持软件,如: 。操作系统的名称、版本号: 程序语言的编译/汇编系统的名称和版本号: 数据库管理系统的名称和版本号: ●其他支持软件。 3.3数据结构 列出为支持本软件的运行所需要的数据库或文件。 4.使用过程 4.1安装与初始化 一步一步地说明为使用本软件而需进行的安装与初始化过程,包括程序的存储形式、安 装与初始化过程中的全部操作命令、系统对这些命令的反应与答复。表征安装工作完成的测 2
2 程序系统中各个程序的名字,它们之间的层次关系 所建立的每个数据库 2.2 主要功能和性能 列出本软件产品所实际具有的主要功能和性能。 3. 运行环境 对软件系统运行所依赖的软件和硬件资源进行描述。 3.1 硬件环境 列出为运行本软件所要求的硬件设备的最小配置,如: 处理机的型号、内存容量; 所要求的外存储器、媒体、记录格式、设备的型号和台数、联机/脱机; 网络环境。 3.2 支持软件 说明运行本软件所需要的支持软件,如: 操作系统的名称、版本号; 程序语言的编译/汇编系统的名称和版本号; 数据库管理系统的名称和版本号; 其他支持软件。 3.3 数据结构 列出为支持本软件的运行所需要的数据库或文件。 4. 使用过程 4.1 安装与初始化 一步一步地说明为使用本软件而需进行的安装与初始化过程,包括程序的存储形式、安 装与初始化过程中的全部操作命令、系统对这些命令的反应与答复。表征安装工作完成的测
试实例等。如果有的话,还应说明安装过程中所需用到的专用软件。 4.2输入 如果系统工作必须依赖指定的输入,则在此处描述规定输入数据的准备要求。 ●输入数据的特点 ●输入格式:说明对初始输入数据和参量的格式要求,包括语法规则和有关约定 ● 输入举例:为每个完整的输入形式提供样本 4.3输出 如果系统的功能中包含了成批的结果输出,则通过此处进行说明。 输出数据的特点 输出格式 输出举例 4.4帮助信息获取 说明如何获取帮助信息 5.运行说明 5.1运行步骤 针对每一个功能,提供详细的描述,一般采用图文并茂的方式进行。 5.2非常规过程 提供应急或非常规操作的必要信息及操作步骤,如出错处理操作、向后备系统切换操作 以及维护人员须知的操作和注意事项。 3
3 试实例等。如果有的话,还应说明安装过程中所需用到的专用软件。 4.2 输入 如果系统工作必须依赖指定的输入,则在此处描述规定输入数据的准备要求。 输入数据的特点 输入格式:说明对初始输入数据和参量的格式要求,包括语法规则和有关约定 输入举例:为每个完整的输入形式提供样本 4.3 输出 如果系统的功能中包含了成批的结果输出,则通过此处进行说明。 输出数据的特点 输出格式 输出举例 4.4 帮助信息获取 说明如何获取帮助信息 5. 运行说明 5.1 运行步骤 针对每一个功能,提供详细的描述,一般采用图文并茂的方式进行。 5.2 非常规过程 提供应急或非常规操作的必要信息及操作步骤,如出错处理操作、向后备系统切换操作 以及维护人员须知的操作和注意事项