操作手册写法.docx

1、操作手册写法杭州新世纪信息技术股份有限公司操作手册写法和注意事项文档作者 : 新世纪烟草事业部 OA运维组当前版本： 1.0杭州新世纪信息技术股份有限公司二一二年七月文档控制文档名称 杭州新世纪操作手册写法和注意事项文档代码 T-C-01文档描述 操作手册具体写法和需要注意的事项版本信息修改日期 版本 描述 作者2012 年 08 月 01 日 V1.0 创建 蒋业成文档阅读说明颜色 说明 备注黄色 重点内容，没有时间看完整的就看这部分内容红色 待定需要修改的地方.1. 操作手册编写内容模块介绍 41.1 操作手册标题页面内容模块 41.2 正文内容系统操作内容模块 71.3 正文内容业务流程

2、内容模块 91：选中要插入图片的单元格，右键 - 自动调整 - 固定列宽2：选中要插入图片的单元格，右键 - 表格属性 - 行 - 指定高度（自己设） - 行高值设成固定值.1.操作手册编写模块介绍名词解释操作手册需要包含的内容组成部分。编写文档时候需要将所列模块写模块入文档。编辑内容 模块中需要书写的内容范围，编写文档模块时候需要写的内容范围备注 模块书写内容的具体样例模块内容表现形式，可取素材。表现形式主要是文字和图片，可取素内容形式 材是内容的来源，主要是历史项目文档资料和根据自己的理解进行描述1.1 操作手册标题页面模块图片 1.图片 2模块编辑内容备注内容形式比如三项工作项目内容形式

3、：文字编写文档主标题内容（虚线红框1）：1来源 1：项目组提供需样例：项目名称求文档浙江中烟三项工作项目编写文档副标题（虚线红框2）：内容形式：文字如果客户要求将所有流程操作手册写成来源 1：自己编写一份，建议按照以下形式填写副标题：来源 2：直接复制本步骤中的内容2副标题内容：用户培训 - 操作手册编写文档副标题（虚线红框 2）： 样例：内容形式：文字如果客户要求按照业务模块进行编写，建 比如：操作手册 - 物资采购 来源 1：项目组提供需求文档议按照以下形式填写副标题： 流程.3.副标题内容：操作手册 -XXXX（业务模块名称）编写文档副标题（虚线红框2）：比如：物资采购业务模块如果客户要

4、求按照业务流程（业务模块-下有业务流程内容形式：文字业务流程）进行编写，建议按照以下形式填写副标题：样例：来源 1：项目组提供需求文档操作手册省公司年度采副标题内容： 操作手册 XXXX流程（业务购计划填报审（编号）流程名称）3）：样例 1：内容形式：文字编写文档编辑作者（虚线红框浙江中烟三项工作项目组来源 1：项目组提供需由于操作手册文档往往不是一个人编写样例 2：求文档来源 2：公司组织机构完成，建议以项目组的名称或者部门名称杭州新世纪烟草事业部 OA文档作为文档编辑作者运维组来源 3：4567编写版本号（虚线红框 4）：版本号的制定规则，当文档发生内容上的变化，就需要保留老版本，建立新版

5、本进行修改。版本号的编写建议按照以下方式进行编写：当前版本： 1.0 （数字编号）公司的标志图标（虚线红框 5）：复制到文档中内容形式：图片公司名称信息（虚线红框 6）：杭州新世纪信息技术股份有限公司文档编辑时间（虚线红框 7）：样例：内容形式：文字当前版本： 1.0来源 1：自己填写当前版本： 1.1内容形式：图片样例：来源 1：公司提供内容形式：文字来源 1：公司组织机构文档内容形式：文字样例：来源 1：自己填写.文档编辑时间 二一二年七月8更换到第二页， 进行“文档控制” 和“版本信息”设计8）：样例：编写文档控制内容（虚线红框文档名称：浙江中烟三项工文档名称：文档名称信息，需要步骤29

6、中的意思保持一致内容形式：文字作省公司物资采购操作手册来源 1：自己填写文档编号：填写文档统一编号文档描述：浙江中烟三项工文档描述：本次文档需编写的目的作省公司物资采购操作说明编写版本信息（虚线红框9）：样例：10日期：编写文档 / 修改文档日期信息内容形式：文字版本 1.0来源 1：自己填写版本：版本信息，最新的版本信息需要版本 1.1与步骤 4 中的版本进行对应1.2 正文内容系统操作模块图片 1.模块 编辑内容编写图标说明（虚线红框 1）：系统中出现的图标（ icon ），需要进行截取图片加以说明。说明内容建议1按照以下字段进行解释：功能：图标所代表的功能说明信息图标：图标图片（ ico

7、n ）说明：对图标的说明信息介绍系统功能模块：2将系统模块功能作用介绍一遍编写系统共用部分功能操作方法3（虚线红框 3）：系统中出现高频使用的功能，操作方图片 2备注内容形式如果开发提供ICON 图内容形式 1：文字标，可以利用来源 1：数据库表，详细设计，样例：概要设计文档功能：密码修改来源 2：根据页面进行记录图标：内容形式 2：图片说明：此按钮可修改登来源 1：页面截图陆用户的当前密码来源 2：开发人员提供内容形式 1：文字来源 1：开发人员提供详细设计，概要设计文档来源 2：根据页面进行记录内容形式 2：图片来源 1：页面截图来源 2：开发人员提供样例：内容形式 1：文字用户登陆功能来

8、源 1：页面记录来源 2：概要设计， 详细设计.法相似或者相同。建议分成2 快进行内容形式 2：图片描述：来源 1：页面截图图片：系统页面截图，需要在截图中来源 2：详细设计进行必要的标记（如第二张图片中红色实现框 1）文字：具体操作动作解释同时也要将标记的内容在文档中加以体现。 （比如第二张图片中步骤 2 登陆系统，就需要说明实线红框 1 中操作动作）1.3 正文内容业务流程模块1.3.1 业务描述模块总体结构图图片 1.图片 2模块编辑内容备注内容形式编写业务流程标题 ( 虚线红框 1) ：内容形式 1：文字来源 1：数据库表，详细设业务流程标题是操作手册非常重要的样例：计，概要设计文档1

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

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

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