用户操作手册编写规范.docx

用户操作手册编写规范.docx

《用户操作手册编写规范.docx》由会员分享，可在线阅读，更多相关《用户操作手册编写规范.docx（7页珍藏版）》请在冰豆网上搜索。

用户操作手册编写规范

编号：

版本号：

发放号：

文件名称：

用户操作手册编写规范

变更记录

序号

修改条款

修改单号

页号

修改人/日期

批准人/日期

实施日期

注：

对该文件内容增加、删除或修改均需填写此变更记录，详细记载变更信息，以保证其可追溯性。

用户操作手册编写规范

用户操作手册旨在告诉软件的使用者在使用本软件时所应采用的方法与程序，并提供有关的信息，如系统结构、软件功能、操作流程等，以协助软件的使用。

用户操作手册的重点章节是‘第四章功能概述与操作说明’。

操作说明必须尽量地详尽，以便使用者易于掌握。

第一章简介

本章将简要地说明用户操作手册（以下简称本手册）的目的、范围、名词定义和参考文件。

1、手册目的

本手册的目的在于告诉某某系统软件的使用者，本系统软件提供了哪些功能，以及如何正确地、有效地来使用这些功能。

2、手册范围

☞本手册首先简要地介绍本系统软件的结构以及软件环境，然后说明本系统软件为使用者提供的各项功能及其详细的操作步骤。

☞本手册的使用者包括：

{在此罗列使用者……}

☞本手册各章节内容安排如下：

∙第一章简介：

简单说明本手册的目的、范围、名词定义和参考文件。

∙第二章系统概述：

简单说明本系统的结构及其执行环境。

∙第三章公共操作：

介绍开机、系统注册与退出、关机等公共操作，并指明为系统中各项操作所共有的屏幕属性、按钮定义及键盘定义。

∙第四章功能概述与操作说明：

逐一说明各项功能及其详细的操作步骤。

其中“第四章功能概述与操作说明”为本手册之重点,希望使用者能深入了解。

3、名词定义

这里定义为了准确地解释本手册所需要的字头词和缩写词。

这些信息也可以由手册的附录提供，或引用别的文档。

4、参考文件

☞参考文件清单。

☞每个参考文件的标题、索引号或文件号、发布或发表日期、出版单位等。

☞每个参考文件的来源。

这些信息也可以由手册的附录提供，或引用别的文档。

用户操作手册的参考文件至少应包括本系统的“软件需求分析报告”。

第二章系统概述

本章将简要说明本系统之目标、范围、结构、及软件环境。

1、系统目标

说明本系统主要目标。

2、系统范围

说明本系统之主要范围。

3、系统结构

说明本系统之软、硬构件结构。

4、软件环境

说明本系统的软件运作时所需环境。

第三章公共操作

本章介绍开机、系统注册，主菜单操作，退出，关机等公共操作，并指明为系统中各项操作所共有的屏幕属性、按钮定义及键盘定义。

1、开机/关机

描述系统开机/关机规程。

包括：

∙系统硬设备（包括主机、外部设备、网络设备等）的加电顺序。

∙加电过程中显示屏上出现的画面和正常/非正常消息。

∙加电注意事项及异常处理。

∙系统硬设备（包括主机、外部设备、网络设备等）的关电顺序。

∙关电注意事项及异常处理。

2、注册

描述系统注册规程。

包括：

∙应用系统的亮相画面。

∙应用系统的注册画面。

∙注册动作说明（如输入职工号、密码等）。

∙注意事项及异常处理。

3、主菜单操作

描述主菜单操作规程。

包括：

∙应用系统的主菜单画面。

∙主菜单说明：

菜单条上每一选项的简要说明；

如何选择一个选项（用鼠标器和用键盘）。

∙注意事项及异常处理。

4、退出

描述退出规程。

包括：

∙如何退出应用系统的主菜单画面（用鼠标器和用键盘）。

∙如何退出应用系统的注册画面（用鼠标器和用键盘）。

∙如何关闭操作系统（用鼠标器和用键盘）。

∙注意事项及异常处理。

5、屏幕画面的布局

描述系统屏幕画面布局，主要分为系统主画面和系统功能画面。

6、公共画面属性

描述系统画面公共的属性，例如画面主体颜色、主要按钮状态等等。

7、提示窗

描述在系统操作期间出现的提示窗的信息。

如下表：

提示窗信息类型

标题

图标

图标颜色

信息内容

注：

所显示的信息应该取自系统的消息库，不应由编程人员随意定义。

表3.1提示窗信息

8、按钮定义

描述在系统功能画面上可能出现的按钮。

如下表：

按钮名称

按钮形状

按钮含义

表3.2屏幕按钮

9、键盘定义

描述在本系统中能够使用的快捷键。

第四章功能概述与操作说明

本章对系统所提供的各项功能作一一概述,并针对每一项功能，详细地说明其操作方法。

1、功能概述

这里罗列本系统软件所提供的各项主要功能，并进行简要说明。

注意：

只需说明软件结构树上的第一级功能，对它们的下级功能则不需细加说明。

‘4.3节操作说明’将对每一个第一级功能，均有一小节详细说明。

2、操作规程

这里说明软件操作所需遵循的操作规程。

例如，需先执行必要的初始设置，某些操作必须首先被执行，然后才可以执行其他操作，等等。

3、操作说明

3.1功能1

☞功能模块

这里仅仅罗列出该功能所包含的子功能，对这些子功能并不进行描述。

☞操作流程

采用文字形式或流程图形式，说明该功能的操作流程。

☞功能主画面

这里给出该功能的操作主画面（通常也就是系统主画面,但菜单条上对应于本功能的菜单已经处于下拉状态）。

☞操作说明

∙功能模块1

1、功能描述

这里简要介绍功能模块1所提供的功能。

2、画面格式

这里给出功能模块1的真实操作画面。

3、操作步骤

这里详细说明功能模块1的操作步骤。

∙功能模块2

………………

3.2功能2

………………