用户操作手册
文件编号: 项目名称 文档名称 项目编号 编写人 审核人 批准人 版本号 编写日期 审核日期 批准日期 备注 变更记录
序号 修改条款 修改单号 页号 修改人/日期 批准人/日期 实施日期 证其可追溯性。
注:对该文件内容增加、删除或修改均需填写此变更记录,详细记载变更信息,以保目 录
1. 引言 .......................................................................................................................................... 1 1.1 1.2 1.3 2.1 2.2 2.3 3.1 3.2 4.1 4.2
编写目的 ........................................................................................................................... 1 定义 ................................................................................................................................... 1 参考资料 ........................................................................................................................... 1 目标 ................................................................................................................................... 1 功能 ................................................................................................................................... 1 性能 ................................................................................................................................... 1 硬件环境 ........................................................................................................................... 1 支持软件 ........................................................................................................................... 1 安装和初始化 ................................................................................................................... 2 输入 ................................................................................................................................... 2
数据背景..................................................................................................................... 2 数据格式..................................................................................................................... 2 输入举例..................................................................................................................... 2 数据背景..................................................................................................................... 2 数据格式..................................................................................................................... 2 举例............................................................................................................................. 2
2. 软件概述 .................................................................................................................................. 1
3. 运行环境 .................................................................................................................................. 1
4. 使用说明 .................................................................................................................................. 2
4.2.1 4.2.2 4.2.3 4.3 4.3.1 4.3.2 4.3.3 4.4 4.5 5.1 5.2
输出 ................................................................................................................................... 2
出错和恢复 ....................................................................................................................... 2 求助查询 ........................................................................................................................... 2 运行表 ............................................................................................................................... 3 运行步骤 ........................................................................................................................... 3
运行控制..................................................................................................................... 3 操作信息..................................................................................................................... 3 输入/输出文件 ........................................................................................................... 3 启动或恢复过程......................................................................................................... 3
5. 运行说明 .................................................................................................................................. 3
5.2.1 5.2.2 5.2.3 5.2.4
6. 程序文件(或命令文件)和数据一览表 .............................................................................. 3
1. 引言 1.1 编写目的
阐明编写用户手册的目的,指明读者对象。 1.2 定义
列出手册中使用的专门术语的定义和缩写词的原意。 1.3 参考资料
列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源。 2. 软件概述 2.1 目标 2.2 功能 2.3 性能
1. 数据精确度[包括输入、输出及处理数据的精度。 2. 时间特性[如响应时间、处理时间、数据传输时间。
3. 灵活性[在操作方式、运行环境需做某些变更时软件的适应能力。 3. 运行环境 3.1 硬件环境
软件系统运行时所需的硬件最小配置。 3.2 支持软件
操作系统名称及版本号、语言编译系统及版本号、数据库管理系统的名称及版本 号、其它必要的支持软件。
1
4. 使用说明 4.1 安装和初始化
给出程序的存储形式、操作命令、反馈信息及其含意、表明安装完成的测试实例以 及安装所需的软件工具。 4.2 输入
给出输入数据或参数的要求。 4.2.1 数据背景
说明数据来源、存储媒体、出现频度、和质量管理等 4.2.2 数据格式
如:a.长度;b.格式基准;c.标号;d.顺序;e.分隔符;f.词汇表;g.省略和重复;h.控制。 4.2.3 输入举例 4.3 输出
给出每项输出数据的说明 4.3.1 数据背景
说明输出数据的去向、使用频度、存放媒体及质量管理等。 4.3.2 数据格式
详细阐明每一输出数据的格式,如:首部、主体和尾部的具体形式。 4.3.3 举例 4.4 出错和恢复
给出:a.出错信息及其含意;b.用户应采取的措施,如修改、恢复、再启动。 4.5 求助查询
说明如何操作。
2
5. 运行说明 5.1 运行表
列出每种可能的运行情况,说明其运行目的。 5.2 运行步骤
按顺序说明每种可能的运行情况,说明其运行目的。 5.2.1 运行控制 5.2.2 操作信息
a.运行目的 ;b.操作要求;c.启动方法;d.预计运行时间;e.操作命令格式及说明;f.其它事项。 5.2.3 输入/输出文件
给出建立或更新文件的有关信息,如:
a. 文件的名称及编号;b.记录媒体;c.存留的目录;d.文件的支配。
说明确定保留或废弃文件的准则,分发文件的对象,占用硬件的优先级及保密控制 等。
5.2.4 启动或恢复过程
6. 程序文件(或命令文件)和数据一览表
按文件名字字母顺序或按功能与模块分类顺序逐个列出文件名称、标识符及说明。
3