操作基础手册模板.doc

操作手册模板

文档编号：操作手册模板
文档信息：企业等级模板文件
文档名称：操作手册模板
文档类别：工程过程类
密 级：
版本信息：1.0
建立日期：

创 建 人：
审 核 者：
批 准 人：
同意日期：

保 管 人：
存放位置：

文档修订统计
版本编号或更改统计编号
*改变
状态
简明说明（变更内容和变更范围）
日期
变更人
审核日期
审核人
1.0
A
新建
-10-1
彭毅

*改变状态：A——增加，M——修改，D——删除

文档同意信息
序号
同意人
角色
同意日期
签字
备注

目录
1. 引言 4
1.1 编写目标 4
1.1.1 背景 4
1.2 关键业务名词和术语定义 4
1.3 参考文件 * 4
1.4 文档组织 4
2. 系统概述 5
2.1 系统介绍 5
2.2 系统功效介绍 5
2.3 系统运行环境 5
2.3.1 软件环境 5
2.3.2 硬件环境 5
3. 系统基础操作说明 5
3.1 概述 5
3.2 系统登录 5
3.3 菜单介绍 6
3.4 界面显示特征 6
3.5 鼠标通用操作 6
3.6 键盘通用操作 6
3.7 退出系统 6
4. <***子>系统<1>操作说明 6
4.1 概述 * 6
4.2 模块名称1 6
4.3 模块名称2 7
5. <***子>系统<2>操作说明 * 7
6. 附录 * 7
6.1 错误提醒信息 7
6.2 命令速查表 7
6.3 数据文件格式 7
6.4 其它信息 7

1. 引言
1.1 编写目标
关键说明本文档作用，指出读者对象（通常为授权使用本系统系统管理员、业务操作员等）。
1.2 背景
关键说明该手册所描述软件系统名称；本项目标任务提出者、开发者、用户等。
1.3 关键业务名词和术语定义
对本文档中所使用专业或行业术语所指对象或含义进行解释性说明，尤其是对在本文档中为描述业务方便而自行定义部分名词如“**类别”、“**状态”等进行说明，在后文叙述中可直接加以引用。
1.4 参考文件 *
列明制订本文档所参考资料清单（包含项目标立项汇报、协议或招投标文件；软件开发计划；用户需求说明书；软件需求规格说明书；系统设计说明书；手册中引用其它资料、采取软件工程标准或软件工程规范），说明其作者和出版日期。
编号
资料名称
介绍
作者
日期
出版单位

1.5 文档组织
说明本手册组织形式，尤其应说明第四章‘具体操作说明’组织形式。
如：在每个具体业务模块操作说明中，根据“业务办理条件”、“业务功效说明”、“操作步骤”、“业务处理结果”、“注意事项”等条目加以说明。其中，“业务办理条件”关键说明使用此功效模块业务先决条件和进入方法；“业务功效说明”关键说明本业务模块所实现功效，包含对数据处理概述；“操作步骤”关键说明界面内容分类、具体操作步骤次序、输入限制、业务分支选择等信息；“业务处理结果”关键说明本业务模块办理完成后系统处理结果。“注意事项”关键说明其它需要操作员注意部分。
2. 系统概述
2.1 系统介绍
关键说明系统实现关键功效；系统所采取关键技术。
2.2 系统功效介绍
说明系统功效划分，列举划分子系统，对子系统功效做简短说明，说明子系统功效划分，列明子系统所包含下一级业务处理单元。
2.3 系统运行环境
2.3.1 软件环境
说明为运行本软件所需要支持软件，如：
Ø 操作系统名称、版本号
Ø 程序语言编译／汇编系统名称和版本号
Ø 数据库管理系统名称和版本号
Ø 中间件平台名称和版本号
Ø 其它支持软件
2.3.2 硬件环境
列出软件系统运行时所需硬件最小配置，如：
Ø 计算机型号、主存容量
Ø 外存放器、媒体、统计格式、设备型号及数量
Ø 输入、输出设备
Ø 数据传输设备及数据转换设备型号及数量
3. 系统基础操作说明
3.1 概述
3.2 系统登录
描述系统开启、登录实际操作步骤，并合适附上实际界面。
3.3 菜单介绍
描述各菜单及子菜单结构。
3.4 界面显示特征
说明界面共性。如相同名称按钮共同含义，常见提醒信息说明、怎样切换页面等。
3.5 鼠标通用操作
介绍鼠标操作，包含鼠标拖放动作和指针状态描述等
3.6 键盘通用操作
描述经过键盘操作系统方法，包含正常输入和系统提供快捷方法等
3.7 退出系统
描述怎样退出系统实际操作步骤
4. <***子>系统<1>操作说明
是操作手册主体，应具体介绍软件功效和实际操作步骤。
对于不一样子系统，能够分不一样章节进行介绍。
4.1 概述 *
若分不一样章节对子系统进行介绍，则应首先说明怎样开启该子系统。
4.2 模块名称1
能够参考下面内容，对模块进行具体描述：
Ø 业务办理条件：关键说明使用此功效模块业务先决条件和进入方法；
Ø 业务功效说明：关键说明本业务模块所实现功效；
Ø 操作步骤（开启è输入信息è点击按钮è结束）：关键说明界面内容分类、具体操作步骤次序、输入限制、业务分支选择等信息；
Ø 业务处理结果：关键说明本业务模块办理完成后系统处理结果（如输出信息，在哪个模块能够查询到相关处理结果等）；
Ø “注意事项”：关键说明其它需要操作员注意部分。
4.3 模块名称2
5. <***子>系统<2>操作说明 *
6. 附录 *
在操作手册中，有些知识和信息能够经过附录形式提供给用户，方便于用户查阅，如：
6.1 错误提醒信息
通常能够以表形式根据一定次序，比如按犯错提醒信息编号次序、或按犯错提醒信息字母次序，给出犯错提醒信息编号、提醒信息、对应解释、犯错原因和处理措施。能够参考下表：
犯错提醒信息编号
提醒信息
对应解释
犯错原因
处理措施

6.2 命令速查表
通常能够以表形式根据一定次序给出多种命令概要（包含命令名称、多种参数、及对应功效介绍），以帮助有一定经验用户进行快速查找所需信息。
能够参考下表：
序号
命令名称
多种参数
对应功效介绍

6.3 数据文件格式
能够经过附录介绍用户必需了解或能够了解多种输入数据文件、输出结果文件、中间数据文件格式、限制范围、合适解释等。
6.4 其它信息
任何其它有利于用户使用我们软件、方便用户信息全部能够以附录形式提供给用户。