资源描述
六、用户操作手册
1.引言 1
1.1编写目标 1
1.2项目背景 2
1.3定义 2
1.4参考资料 2
2.软件概述 2
2.1目标 2
2.2功效 2
2.3性能 2
3.运行环境 2
3.1硬件 2
3.2支持软件 3
4.使用说明 3
4.1安装和初始化 3
4.2输入 3
4.3输出 3
4.4犯错和恢复 3
4.5求援查询 3
5.运行说明 3
5.1运行表 3
5.2运行步骤 3
6.很规过程 3
7.操作命令一览表 3
8.程序文件(或命令文件)和数据文件一览表 3
9.用户操作举例 3
1.引言
1.1编写目标
【说明编写手册目标,指明读者对象。】
1.2项目背景
【应包含项目标起源、委托单位、开发单位和主管部门。】
1.3定义
【列出手册中所用到专门术语定义和缩写词原文。】
1.4参考资料
【列出相关资料作者、标题、编号、发表日期、出版单位或资料起源,可包含:
a. 项目标计划任务书、协议或批文;
b. 项目开发计划;
c. 需求规格说明书;
d. 概要设计说明书;
e. 具体设计说明书;
f. 测试计划;
g. 手册中引用其它资料、采取软件工程标准或软件工程规范。】
2.软件概述
2.1目标
2.2功效
2.3性能
a. 数据正确度【包含输入、输出及处理数据精度。】
b. 时间特征【如响应时间、处理时间、数据传输时间等。】
c. 灵活性【在操作方法、运行环境需做一些变更时软件适应能力。】
3.运行环境
3.1硬件
【列出软件系统运行时所需硬件最小配置,如
a. 计算机型号、主存容量;
b. 外存放器、媒体、统计格式、设备型号及数量;
c. 输入、输出设备;
d. 数据传输设备及数据转换设备型号及数量。】
3.2支持软件
【如:
a. 操作系统名称及版本号;
b. 语言编译系统或汇编系统名称及版本号;
c. 数据库管理系统名称及版本号;
d. 其它必需支持软件。】
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求援查询
【说明怎样操作。】
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.很规过程
【提供给急或很规操作必需信息及操作步骤,如犯错处理操作、向后备系统切换操作和维护人员须知操作和注意事项。】
7.操作命令一览表
【按字母次序逐一列出全部操作命令格式、功效及参数说明。】
8.程序文件(或命令文件)和数据文件一览表
【按文件名字母次序或按功效和模块分类次序逐一列出文件名称、标识符及说明。】
9.用户操作举例
展开阅读全文