操作手册模板
操作手册模板
文档编号：操作手册模板 文档信息：公司级别模板文件 文档名称：操作手册模板 文档类别：工程过程类 密 级： 版本信息：1.0 建立日期：
创 建 人： 审 核 者： 批 准 人： 批准日期：
保 管 人： 存放位置：
1.
1.1
引言 ............................................. 4
编写目的 .................................................................. 4 1.1.1 背景 ................................................................ 4 1.2 主要业务名词和术语定义 .................................................... 4 1.3 参考文献 * ................................................................ 4 1.4 文档组织 .................................................................. 4
2.
2.1 2.2 2.3
系统概述 ......................................... 5
系统简介 .................................................................. 5 系统功能简介 .............................................................. 5 系统运行环境 .............................................................. 5 2.3.1 软件环境 ............................................................ 5 2.3.2 硬件环境 ............................................................ 5
3.
3.1 3.2 3.3 3.4 3.5 3.6 3.7
系统基本操作说明 ................................. 5
概述 ...................................................................... 5 系统登录 .................................................................. 5 菜单介绍 .................................................................. 5 界面显示特性 .............................................................. 6 鼠标通用操作 .............................................................. 6 键盘通用操作 .............................................................. 6 退出系统 .................................................................. 6
4.
4.1 4.2 4.3
系统操作说明 ........................... 6
概述 * .................................................................... 6 模块名称1 ................................................................ 6 模块名称2 ................................................................ 7
5.
6.
6.1 6.2 6.3 6.4
系统操作说明 * ......................... 7
附录 * ........................................... 7
错误提示信息 .............................................................. 7 命令速查表 ................................................................ 7 数据文件格式 .............................................................. 7 其它信息 .................................................................. 7
1. 引言
1.1
编写目的
主要说明本文档的作用，指出读者对象（通常为授权使用本系统的系统管理员、业务操作员等）。
1.2 背景
主要说明该手册所描述的软件系统的名称；本项目的任务提出者、开发者、用户等。
1.3 主要业务名词和术语定义
对本文档中所使用的专业或行业术语所指对象或含义进行解释性的说明，特别是对在本文档中为描述业务方便而自行定义的一些名词如“**类别”、“**状态”等进行说明，在后文论述中可直接加以引用。
1.4 参考文献 *
列明制定本文档所参考的资料清单（包括项目的立项报告、合同或招投标文件；软件开发计划；用户需求说明书；软件需求规格说明书；系统设计说明书；手册中引用的其它资料、采用的软
1.5 文档组织
说明本手册的组织形式，特别应说明第四章‘具体操作说明’的组织形式。
如：在每个具体业务模块的操作说明中，按照“业务办理条件”、“业务功能说明”、“操作步骤”、“业务处理结果”、“注意事项”等条目加以说明。其中，“业务办理条件”主要说明使用此功能模块的业务先决条件和进入方式；“业务功能说明”主要说明本业务模块所实现的功能，包含对数据处理的概述；“操作步骤”主要说明界面内容的分类、具体操作步骤的顺序、输入限制、业务分支选择等信息；“业务处理结果”主要说明本业务模块办理完毕后系统的处理结果。“注意事项”主要说明其他需要操作员注意的部分。
2.1
系统简介
主要说明系统实现的主要功能；系统所采用的主要技术。
2.2 系统功能简介
说明系统功能的划分，列举划分的子系统，对子系统功能做简短说明，说明子系统的功能划分，列明子系统所包含的下一级业务处理单元。
2.3 系统运行环境
2.3.1 软件环境
说明为运行本软件所需要的支持软件，如：
操作系统的名称、版本号
程序语言的编译／汇编系统的名称和版本号 数据库管理系统的名称和版本号 中间件平台的名称和版本号 其他支持软件
2.3.2 硬件环境
列出软件系统运行时所需的硬件最小配置，如：
计算机型号、主存容量
外存储器、媒体、记录格式、设备型号及数量 输入、输出设备
数据传输设备及数据转换设备的型号及数量
3. 系统基本操作说明
3.1 3.2
概述 系统登录
描述系统启动、登录的实际操作步骤，并适当附上实际界面。
3.3 菜单介绍
描述各菜单及子菜单的结构。
说明界面的共性。如相同名称按钮的共同含义，常见的提示信息说明、如何切换页面等。
3.5 鼠标通用操作
介绍鼠标的操作，包括鼠标的拖放动作和指针状态的描述等
3.6 键盘通用操作
描述通过键盘操作系统的方法，包括正常输入和系统提供的快捷方式等
3.7 退出系统
描述如何退出系统的实际操作步骤
4. 系统操作说明
是操作手册的主体，应详细介绍软件的功能与实际操作步骤。 对于不同的子系统，可以分不同的章节进行介绍。
4.1 概述 *
若分不同的章节对子系统进行介绍，则应首先说明如何启动该子系统。
4.2 模块名称1
可以参考下面的内容，对模块进行具体的描述：
业务办理条件：主要说明使用此功能模块的业务先决条件和进入方式； 业务功能说明：主要说明本业务模块所实现的功能；
操作步骤（启动输入信息点击按钮结束）：主要说明界面内容的分类、具体操
作步骤的顺序、输入限制、业务分支选择等信息；
业务处理结果：主要说明本业务模块办理完毕后系统的处理结果（如输出信息，在哪
个模块可以查询到相关的处理结果等）；
“注意事项”：主要说明其他需要操作员注意的部分。
5. 系统操作说明 * 6. 附录 *
在操作手册中，有些知识和信息可以通过附录的形式提供给用户，以便于用户查阅，如：
6.1 错误提示信息
通常可以以表的形式按照一定的顺序，例如按出错提示信息编号顺序、或按出错提示信息的字母顺序，给出出错提示信息的编号、提示信息、相应的解释、出错原因和解决办法。
6.2 命令速查表
通常可以以表的形式按照一定的顺序给出各种命令的概要（包括命令名称、各种参数、及相应的功能介绍），以帮助有一定经验的用户进行快速查找所需信息。 6.3 数据文件格式
可以通过附录介绍用户必须了解或可以了解的各种输入数据文件、输出结果文件、中间数据文件的格式、限制范围、适当的解释等。
6.4 其它信息
任何其它有利于用户使用我们的软件、方便用户的信息都可以以附录的形式提供给用户。