《操作手册模板.pdf》由会员分享,可在线阅读,更多相关《操作手册模板.pdf(11页珍藏版)》请在淘文阁 - 分享文档赚钱的网站上搜索。
1、 本资料仅供内部使用!项目名称 操作手册 年月日 修改记录 制定日期 生效日期 制定/修订内容摘要 页数 版本 拟稿 审查 批准 1 1 简介 1.1 手册目勺 1.2 手册范围 1.3 名词定义 1.4 参考文件 2 系统简述 3 公共操作 3.1 开关机 3.2 3.3 3.4 3.5 3.6 3.7 3.8 3.9 注册.主菜单操作.退岀.屏幕画面的布局 公共画面属性 提示窗.按钮定义.键盘定义.4 功能概述 5 功能模块1 5.1 子功能模块1 5.2 子功能模块2 6 功能2 7 功能3 8 附件 1简介 本章将简要地说明软件操作手册(以下简称本手册)的目的、范围、名词定义和参考文件
2、。1.1手册目的 本手册的目的在于告诉 XXXXXX 系统(以下简称本系统)的使用者,本系统提供了哪些功能,及如何正确地、有效地来使用这些功能。1.2手册范围 本手册首先简要地介绍本系统结构以及软件环境,然后说明本系统为使用者提供的各项功能及 其详细的操作步骤。关于系统详细软硬件结构、系统安装及系统运行维护方面的内容,请参考本系 统的系统安装手册及系统运行维护手册。本手册的使用者包括:这里罗列手册的使用者。例如 营业人员 帐务人员 网点操作员 本手册各章节内容安排如下:第一章 简 介:简单说明本手册的目的、范围、名词定义和参考文件。第二章 系统概述:简单说明本系统的结构及其执行环境。第三章 公
3、共操作:介绍系统注册与退出、关机等公共操作,并指明为系统中各项操作所共有的 屏幕属性、按钮定义及键盘定义。第四章功能概述 第五章 操作说明:逐一说明各项功能及其详细的操作步骤。其中“第四章 功能概述”与“第五章 操作说明”为本手册之重点,希望使用者能深入了解。1.3名词定义 这里定义为了准确地解释本手册所需要的字头词和缩写词。这些信息也可以由手册的附录提供,或引用别的文档。1.4参考文件 这一条应给出:参考文件清单;每个参考文件的标题、索引号或文件号、发布或发表日期、出版单位等;每个参考文件的来源。这些信息也可以由手册的附录提供,或引用别的文档。软件操作手册的参考文件至少应包括本系统的“软件需
4、求分析规格”2系统简述 简要描述本系统的结构、以及及软件运行环境(可以采用列表描述,这部分是重点)3公共操作 本章介绍系统注册,主菜单操作等公共操作,并指明为系统中各项操作所共有的屏幕属性、按 钮定义及键盘定义。3.1开关机 开机、关机的详细步骤与指令,以及该过程中出现的各种交互信息 保护、软件的退出/数据和文件的保存等提醒 3.2注册 描述系统注册规程。包括 应用系统的亮相画面 应用系统的注册画面 注册动作说明(如输入工号、密码等)注意事项及异常处理(如何处理开机异常)3.3主菜单操作 描述主菜单操作规程。包括、“系统概要设计规格”。特别注意关机之前的 应用系统的主菜单画面 主菜单说明:菜单
5、条上每一选项的简要说明 如何选择一个选项(用鼠标器和用键盘)注意事项及异常处理(测试通信等)3.4退出 描述退出规程。包括:如何退出应用系统的主菜单画面(用鼠标器和用键盘)如何退出应用系统的注册画面(用鼠标器和用键盘)如何关闭操作系统(用鼠标器和用键盘)注意事项及异常处理 3.5屏幕画面的布局 系统所提供的屏幕画面主要地可以分为两种:系统主画面和系统功能画面。这两种画面的基本 布局有所不同。系统主画面的布局 画面的首行(顶行)显示应用系统的名称和代号 画面的第二行显示菜单条 画面的底行留给操作系统 画面的剩余部分显示与系统有关的信息 请参阅 3.3 节主菜单操作。系统功能画面的布局 画面的首行
6、(顶行)显示画面的名称和代号 画面的第二行从左到右依次显示如下内容:提示信息,例如:请输入用户姓名 当前执行状态,例如:输入,选项(菜单),索引等 系统日期和时间 操作员工号 画面的底行留给操作系统 画面的倒数第二行提示功能彩旦 画面的剩余部分排放各个字段 请参阅第四章功能概述与操作说明及“编程规范”3.6公共画面属性 画面颜色 平面线框代表数据或按钮分组 下划线代表由系统提供数据 3.7提示窗 在操作期间,当需要显示操作错误之提示,严重后果之提示及版权之提示等时,系统将弹出一 个提示窗,仅当你点击了 确定按钮之后,才会返回原画面,继续操作。提示窗显示的信息分若干类,如下表所示:提示窗信息类型
7、 标题 图标 图标颜色 信息内容 警告信息 警告 黄底黑!警告信息说明(中文)提示信息 提示 兰底白i 提示信息说明(中文)错误信息 错误 红底白!错误代码及消息(中文)(一般为运行岀错或 数据库底层错误)版权信息 关于系统 如:移动计费营业系统 V1.0 版 权 所 有(C)1996-1997 公司 注所显示的信息应该取自系统的消息库,不应由编程人员随意定义。表 3.1 提示窗信息主底色:灰色 即画面的背景色 主色:黑色 即画面的前景色 必要色:红色 即必须输入的字段 金额 橙色 金额用橙色显示 结果色:兰色 显示信息为灰底蓝字 三维上凸(显)代表该按钮可按 三维上凸(隐)代表该按钮不可按
8、三维下凹(白底)代表可输入字段 三维下凹(灰底)代表系统计算结果 3.8按钮定义 在系统功能画面上,可能出现的按钮如下:按钮名称 按钮形状 按钮含义 确定(0K)取消(Cancel)C 取消 所作的输入/选择正确无误,予以确认。本屏所需之操作完 成。视应用需要退岀或不退岀本屏。取消所作的任何输入/选择/查询,视应用需要退岀或不退 岀本屏。退岀(Exit)X 退出 新增(Add)A 新增 退岀本屏,返回上一屏。当其他按钮没有退岀功能时才提 供此按钮。增添一个新记录 更改(Update)更新一个现有记录 删除(Delete)删除一个现有记录 査询(Inquiry)查询 L 查询 打印(Print)
9、打印 表 3.2 屏幕按钮 3.9键盘定义 所有画面操作(除了数据输入之外)均可通过鼠标器来实现。但是,本系统允许完全不用鼠标,而 只用键盘来操作。亦即,允许使用者利用键盘作为鼠标器的替代。具体规定如下:热键 一击打为按钮规定的热键,等于用鼠标器点选该按钮。即 单击 0 键等于用鼠标器单击 单击 C 键等于用鼠标器单击 取消按钮 单击 X 键等于用鼠标器单击 单击 A 键等于用鼠标器单击 单击 U 键等于用鼠标器单击 单击 D 键等于用鼠标器单击 删除按钮 单击 I 键等于用鼠标器单击查询按钮 单击 P 键等于用鼠标器单击打印按钮 TAB 键 单击 TAB 键等于用鼠标器把光标定位到下一个输入
10、字段(注意:最后一个字段的 这里仅仅罗列出该功能所包含的子功能,对这些子功能并不进行描述 下一个输入字段为第一个输入字段)出下拉式列表框或下拉式菜单 双击 ESC 键,等于用鼠标器单击退出按钮 标后退到上一行 标前进到下一行 标后退到上一字符 标前进到下一字符 4功能概述 这里用软件结构树罗列本软件所提供的各大功能,并简要说明之。注意只说明软件结构树上的 第一级功能,对它们的下级功能则不细加说明。说明软件操作所需遵循的操作规程。例如,需先执行必要的初始设置,某些操作必须首先被执行 然后才可以执行其他操作,等等。5功能模块1 描述 Enter 键一单击 Enter 等于用鼠标器单击所指按钮 到下
11、一个输入字段(若光标已定位于一个非下拉式字段内(若光标已定位于一个按钮),或把光标定位),或对下拉式列表框或下拉式菜单 激发 下拉(展开)动作,在下拉式列表框或下拉式菜单展开之后:点选光标所在的行 Esc 键 单击 Esc 键等于用鼠标器单击 取消按钮,或在下拉式列表框或下拉式菜单展开之后 Ins 键 单击 Ins 键等于用鼠标器单击新增按钮 DeL 键 单击 Del 键等于用鼠标器单击删除按钮 光标键 在菜单条上:光标向左移动一格,或在下拉式列表框或下拉式菜单展开之后 光标键 在菜单条上:光标向右移动一格,或在下拉式列表框或下拉式菜单展开之后 光标键 在菜单条上:光标向左移动一格,或在下拉式
12、列表框或下拉式菜单展开之后 光标键 在菜单条上:光标向右移动一格,或在下拉式列表框或下拉式菜单展开之后 Home 键一 在下拉式列表框或下拉式菜单展开之后:光标后退到行首 End 键 在下拉式列表框或下拉式菜单展开之后:光标前进到行末 PgUp 键一 在下拉式列表框展开之后:后退一屏 PgDn 键一 在下拉式列表框展开之后:前进一屏 如果还有其他功能模块,请按照 5/6/7 的功能章节样式进行详细描述。操作流程 采用文字形式或流程图形式,说明该功能的操作流程.功能主画面 这里给出该功能的操作主画面(通常也就是系统主画面,但菜单条上对应于本功能的菜单已经处 于下拉状态).操作说明 详细给出功能主
13、画面中的各种功能/菜单/按钮等可操作和执行的功能、以及填写域的输入参数类 型、参数范围、应出现的结果等。使得用户再看完本说明后,对本界面的各种操作没有疑问。5.1子功能模块1 功能描述 这里简要介绍子功能模块 1 所提供的功能详细描述。画面格式 用一行给出进入该画面的路径(操作菜单,如操作路径:插入 这里给出功能模块 1 的真实操作画面.操作说明 详细给出功能主画面中的各种功能/菜单/按钮等可操作和执行的功能、以及填写域的输入参数类 型、参数范围、应出现的结果等。使得用户再看完本说明后,对软件 5.2子功能模块2 6功能2 7功能3/图片/剪贴画/)/界面的各种操作没有疑问。与子功能模块 1 的格式相同。描述的内容格式、要求等,与模块 1 一样。描述的内容格式、要求等,与模块 1 的要求一样。8附件 附录 A 错误信息清单(错误代码参见编程规范,具体内容在详细设计)错误代码 说 明 解决办法 表 A.1 错误信息清单
限制150内