用户使用手册编写模板
- 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。
用户操作手册
XXXX年XX月
文档信息
修订记录
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.测试计划;
2.软件概述
2.1目标
2.2功能
达到实际设计功能。
2.3性能
需满足现网用户实际需求。
3.运行环境
3.1硬件
当前系统生成环境的硬件,详细见网络拓扑。
3.2支持软件
当前系统软件环境,详细见系统设计文档。
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举例
5.操作命令一览表
【业务编码,即输入的业务编码查询到对应的业务。】
6.用户操作举例
【截图,并做操作步骤说明】