软件开发文档 15 用户手册（GB8567——88）.pdfVIP

1 引言2 1.1 编写目的2 1.2 背景2 1.3 定义2 1.4 参考资料2 2 用途2 2.1 功能2 2.2 性能3 2.2.1 精度3 2.2.2 时间特性3 2.2.3 灵活性3 2.3 安全保密3 3 运行环境3 3.1 硬设备3 3.2 支持软件3 3.3 数据结构4 4 使用过程4 4.1 安装与初始化4 4.2 输入4 4.2.1 输入数据的现实背景4 4.2.2 输入格式4 4.2.3 输入举例5 4.3 输出对每项输出作出说明5 4.3.1 输出数据的现实背景5 4.3.2 输出格式5 4.3.3 输出举例5 4.4 文卷查询6 4.5 出错处理和恢复6 4.6 终端操作6 1 用户手册（ —— ） GB8567 88 1 引言 1.1 编写目的 说明编写这份用户手册的目的，指出预期的读者。 1.2 背景 说明： a. 这份用户手册所描述的软件系统的名称； b. 该软件项目的任务提出者、开发者、用户（或首批用户）及安装此软件的计算中心。 1.3 定义 列出本文件中用到的专门术语的定义和外文首字母组词的原词组。 1.4 参考资料 列出有用的参考资料，如： a. 项目的经核准的计划任务书或合同、上级机关的批文； b. 属于本项目的其他已发表文件； c. 本文件中各处引用的文件、资料，包括所要用到的软件开发标准。列出这些文件资 料的标题、文件编号、发表日期和出版单位，说明能够取得这些文件资料的来源。 2 用途 2.1 功能 结合本软件的开发目的逐项地说明本软件所具有各项功能以及它们的极限范围。 2 2.2 性能 2.2.1 精度 逐项说明对各项输入数据的精度要求和本软件输出数据达到的精度，包括传输中的精度 要求。 2.2.2 时间特性 定量地说明本软件的时间特性，如响应时间，更新处理时间，数据传输、转换时间，计 算时间等。 2.2.3 灵活性 说明本软件所具有的灵活性，即当用户需求（如对操作方式、运行环境、结果精度、时 间特性等的要求）有某些变化时，本软件的适应能力。 2.3 安全保密 说明本软件在安全、保密方面的设计考虑和实际达到的能力。 3 运行环境 3.1 硬设备 列出为运行本软件所要求的硬设备的最小配置，如： a. 处理机的型号、内存容量； b. 所要求的外存储器、媒体、记录格式、设备的型号和台数、联机／脱机； c. I ／O 设备（联机／脱机？）； d. 数据传输设备和转换设备的型号、台数。 3.2 支持软件 说明为运行本软件所需要的支持软件，如： a ．操作系统的名称、版本号； b ．程序语言的编译／汇编系统的名称和版本号； c ．数据库管理系统的名称和版本号； d ．其他支持软件。 3 3.3 数据结构 列出为支持本软件的运行所需要的数据库或数据文卷。 4 使用过程 在本章，首先用图表的形式说明软件的功能同系统的输入源机构、输出接收机构之间的 关系。 4.1 安装与初始化 一步一步地说明为使用本软件而需进行的安装与初始化过程，包括程序的存储形式、安 装与初始化过程中的全部操作命令、系统对这些命令的反应与答复。表征安装工作完成的测 试实例等。如果有的话，还应说明安装过程中所需用到的专用软件。 4.2 输入 规定输入数据和参量的准备要求。 4.2.1 输入数据的现实背景 说明输入数据的现实背景，主要是 a. 情况——例如人员变动