操作手册写法.docx

1、操作手册写法杭州新世纪信息技术股份有限公司操作手册写法和注意事项文档作者:新世纪烟草事业部OA运维组当前版本：杭州新世纪信息技术股份有限公司二一二年七月文档控制文档名称杭州新世纪操作手册写法和注意事项文档代码T-C-01文档描述操作手册具体写法和需要注意的事项版本信息修改日期版本描述作者2012年08月01日创建蒋业成文档阅读说明颜色说明备注黄色重点内容，没有时间看完整的就看这部分内容红色待定需要修改的地方1：选中要插入图片的单元格，右键-自动调整-固定列宽2：选中要插入图片的单元格，右键-表格属性-行-指定高度（自己设）-行高值设成固定值1. 操作手册编写模块介绍名词解释模块操作手册需要包含

2、的内容组成部分。编写文档时候需要将所列模块写入文档。编辑内容模块中需要书写的内容范围，编写文档模块时候需要写的内容范围备注模块书写内容的具体样例内容形式模块内容表现形式，可取素材。表现形式主要是文字和图片，可取素材是内容的来源，主要是历史项目文档资料和根据自己的理解进行描述1.1 操作手册标题页面模块图片1图片2模块编辑内容备注内容形式1编写文档主标题内容（虚线红框1）：项目名称比如三项工作项目样例：浙江中烟三项工作项目 内容形式：文字来源1：项目组提供需求文档2编写文档副标题（虚线红框2）：如果客户要求将所有流程操作手册写成一份，建议按照以下形式填写副标题：副标题内容：用户培训-操作手册内容

3、形式：文字来源1：自己编写来源2：直接复制本步骤中的内容编写文档副标题（虚线红框2）：如果客户要求按照业务模块进行编写，建议按照以下形式填写副标题：副标题内容：操作手册-XXXX（业务模块名称）样例：比如：操作手册-物资采购流程内容形式：文字来源1：项目组提供需求文档编写文档副标题（虚线红框2）：如果客户要求按照业务流程（业务模块-业务流程）进行编写，建议按照以下形式填写副标题：副标题内容：操作手册XXXX流程（业务流程名称）比如：物资采购业务模块下有业务流程样例：操作手册省公司年度采购计划填报审（编号）内容形式：文字来源1：项目组提供需求文档3编写文档编辑作者（虚线红框3）：由于操作手册文档

4、往往不是一个人编写完成，建议以项目组的名称或者部门名称作为文档编辑作者样例1：浙江中烟三项工作项目组样例2：杭州新世纪烟草事业部OA运维组内容形式：文字来源1：项目组提供需求文档来源2：公司组织机构文档来源3： 4编写版本号（虚线红框4）：版本号的制定规则，当文档发生内容上的变化，就需要保留老版本，建立新版本进行修改。版本号的编写建议按照以下方式进行编写：当前版本：（数字编号）样例：当前版本：当前版本：内容形式：文字来源1：自己填写5公司的标志图标（虚线红框5）：复制到文档中内容形式：图片样例：内容形式：图片来源1：公司提供6公司名称信息（虚线红框6）：杭州新世纪信息技术股份有限公司内容形式：

5、文字来源1：公司组织机构文档7文档编辑时间（虚线红框7）：文档编辑时间样例：二一二年七月内容形式：文字来源1：自己填写8更换到第二页，进行“文档控制”和“版本信息”设计9编写文档控制内容（虚线红框8）：文档名称：文档名称信息，需要步骤2中的意思保持一致文档编号：填写文档统一编号文档描述：本次文档需编写的目的样例：文档名称：浙江中烟三项工作省公司物资采购操作手册文档描述：浙江中烟三项工作省公司物资采购操作说明内容形式：文字来源1：自己填写10编写版本信息（虚线红框9）：日期：编写文档/修改文档日期信息版本：版本信息，最新的版本信息需要与步骤4中的版本进行对应样例：版本版本内容形式：文字来源1：自

6、己填写1.2 正文内容系统操作模块图片1图片2模块编辑内容备注内容形式1编写图标说明（虚线红框1）：系统中出现的图标（icon），需要进行截取图片加以说明。说明内容建议按照以下字段进行解释：功能：图标所代表的功能说明信息图标：图标图片（icon）说明：对图标的说明信息如果开发提供ICON图标，可以利用样例：功能：密码修改图标：说明：此按钮可修改登陆用户的当前密码内容形式1：文字来源1：数据库表，详细设计，概要设计文档来源2：根据页面进行记录内容形式2：图片来源1：页面截图来源2：开发人员提供2介绍系统功能模块：将系统模块功能作用介绍一遍内容形式1：文字来源1：开发人员提供详细设计，概要设计文档

7、来源2：根据页面进行记录内容形式2：图片来源1：页面截图来源2：开发人员提供3编写系统共用部分功能操作方法（虚线红框3）：系统中出现高频使用的功能，操作方法相似或者相同。建议分成2快进行描述：图片：系统页面截图，需要在截图中进行必要的标记（如第二张图片中红色实现框1）文字：具体操作动作解释同时也要将标记的内容在文档中加以体现。（比如第二张图片中步骤2登陆系统，就需要说明实线红框1中操作动作）样例：用户登陆功能内容形式1：文字来源1：页面记录来源2：概要设计，详细设计内容形式2：图片来源1：页面截图来源2：详细设计1.3 正文内容业务流程模块1.3.1 业务描述模块总体结构图图片1图片2模块编辑

8、内容备注内容形式1编写业务流程标题(虚线红框1)：业务流程标题是操作手册非常重要的部分，因此要求业务流程标题保持和项目组所描述的业务流程一致，建议书写的形式：业务流程名称（业务流程编号）样例：省公司年度采购计划填报审（INV_WZ_001）内容形式1：文字来源1：数据库表，详细设计，概要设计文档来源2：根据页面进行记录内容形式2：图片来源1：页面截图来源2：开发人员提供2编写业务描述(虚线红框2)：业务描述主要内容是描述该业务流程需要处理什么业务:业务流程：业务流程名称（业务流程编号）流程作用：处理业务的目标内容形式1：文字来源1：数据库表，详细设计，概要设计文档1.3.2 流程环节模块图片1

9、模块编辑内容备注内容形式1图片流程模块(虚线红框1图片流程)：以图片的形式显示一条业务流程，用图片的好处是客户能够直观清晰的看到整条业务流程内容形式2：图片来源1：页面截图来源2：开发人员提供2文字流程模块(实线红框1文字流程)：以文字的形式体现业务流程中的步骤，本模块中需要编写的内容包括以下两个方面：1.业务流程步骤2.步骤对应的角色部门（建议最好能够对应到岗位）内容形式1：文字来源1：详细设计，概要设计文档1.3.3 操作步骤模块图片1图片2图片3模块编辑内容备注内容形式1操作步骤标题（虚线红框1）：操作步骤标题内容对应的就是中模块2文字流程模块中的业务流程步骤（图片页面中实线红框1），要

10、求两者内容保持一致样例：采购项目立项图片页面中实线红框1中的流程名称与中虚线红框1中内容相同内容形式1：文字来源1：项目组历史文档2系统指向模块（虚线红框2）：业务流程对应系统中功能指向，以及该过程所对应的角色样例：内容形式1：文字来源1：项目组历史文档来源2：按照系统中录入3操作步骤图片流程模块（虚线红框3）：操作步骤页面截图主要目标就是让客户熟悉流程步骤对应的页面有一个形象的认识。页面截图建议：1.将系统页面进行截图2.在页面上用实线红色的方框对需要进行的操作动作的顺序进行标记样例：图片2中，实线红框是在图片中标明操作顺序内容形式2：图片来源1：系统截图来源2：开发人员提供页面4操作步骤文

11、字流程模块（虚线红框4）：流程中操作的动作说明，需要将模块3中的图片实线红框标记的步骤进行说明样例：实线红框5标记的是一张表单，意思是需要在这张表单中填写数据。在图片3的文字流程表格中，步骤3对实线红框5需要填写的字段数据进行了解释和说明内容形式1：文字来源1：项目组文档来源2：按照系统进行录入5剩余的流程按照模块1-4的内容方法进行相同处理2. 操作手册准备工作项了解操作手册的具体内容模块之后，接下来就要进行操作手册编写的准备工作，这里先描述需要的工作事项 2.1 工作一，熟悉业务流程步骤过 程备注1阅读需求文档，整理业务流程。可以多人同时进行操作2按照业务流程操作，请将各个业务流程图截取放

12、入各自的PPT中，为中模块1的内容做准备可以多人同时进行操作3阅读过程中，请将各个业务文字流程整理在一份WORD文档中，按照中模块2的表样和内容进行准备，将用户信息放入表样备注中，为后续工作提供方便可以多人同时进行操作2.2 工作二，按照业务流程进行截图操作步骤过 程备注1根据中步骤2整理的业务文字流程表单，对各个业务流程进行截图操作。建议一个业务流程准备一份PPT文档用以存放截图。为中模块3内容做准备。可以多人同时进行操作2在截图过程中，遇到出现频率高的页面，截图后存放在一个PPT中，为中模块3中图片做准备3在截图过程中，出现图标（ICON），截图后存放在WORD中，为中模块1中图片做准备2

13、.3 工作三，截图处理步骤过 程备注1根据中步骤，将截图进行红色实线方框标记，要求通过标记的次序能够将业务步骤进行体现。为模块3和模块3图片做准备可以多人同时进行操作2.4 工作四，文字内容准备步骤过 程备注1根据中步骤3整理的业务文字流程表单，对各个业务流程中的字段进行整理，将字段进行解释说明，为中模块4做准备。所有的字段建议放入文本文件中可以多人同时进行操作2整理流程文字（名称，过程），直接将步骤3中的内容拷贝并放入文本文件中。为模块1中文字部分做准备，为中模块2文字部分做准备3根据项目需求说明书，整理业务流程业务描述这块内容为中模块2文字部分做准备4根据系统页面，整理功能名称，为中模块2

14、做准备，为中模块2文字部分做准备5根据项目组文档，为中为模块1-7进行准备2.5 工作五，文档排版步骤过 程备注1标题页面设计（字体大小，字体类型）2目录页面设计3正文内容多级项目编号设计，4编辑项目页眉页脚5文档插入页码3. 操作手册编写步骤过 程备注1根据排版完毕之后，进行页面内容编辑，根据中步骤5中整理的文档，进行标题页面的编辑和处理2根据中步骤2整理的文档进行标题的编辑，统一将所有的标题复制到编排好的文档中3根据中步骤2，3整理的文档将内容复制到对应的流程下。删除备注中用户信息4根据步骤3和4整理的文档，将流程环节模块和操作步骤模块中的对应位置文字进行编辑（复制）5进行图片复制，根据处理过后的图片，按照业务流程步骤将对应的图片复制到文档中6编写中模块3中的文字部分内容，编写中文字部分内容