操作手册写法.docx
《操作手册写法.docx》由会员分享，可在线阅读，更多相关《操作手册写法.docx（22页珍藏版）》请在冰豆网上搜索。
操作手册写法
杭州新世纪信息技术股份有限公司
操作手册写法和注意事项
文档作者:
新世纪烟草事业部OA运维组
当前版本：
1.0
杭州新世纪信息技术股份有限公司
二○一二年七月
文档控制
文档名称杭州新世纪操作手册写法和注意事项
文档代码T-C-01
文档描述操作手册具体写法和需要注意的事项
版本信息
修改日期版本描述作者
2012年08月01日V1.0创建蒋业成
文档阅读说明
颜色说明备注
黄色重点内容，没有时间看完整的就看这部分内容
红色待定需要修改的地方
.
1.操作手册编写内容模块介绍4
1.1操作手册标题页面内容模块4
1.2正文内容—系统操作内容模块7
1.3正文内容—业务流程内容模块9
1：
选中要插入图片的单元格，右键--》自动调整--》固定列宽
2：
选中要插入图片的单元格，右键--》表格属性--》行--》指定高度（自己设）--》行高值设成固定值
.
1.操作手册编写模块介绍
名词解释
操作手册需要包含的内容组成部分。
编写文档时候需要将所列模块写
模块
入文档。
编辑内容模块中需要书写的内容范围，编写文档模块时候需要写的内容范围
备注模块书写内容的具体样例
模块内容表现形式，可取素材。
表现形式主要是文字和图片，可取素
内容形式材是内容的来源，主要是历史项目文档资料和根据自己的理解进行描
述
1.1操作手册标题页面模块
图片1
.
图片2
模块
编辑内容
备注
内容形式
比如三项工作项目
内容形式：
文字
编写文档主标题内容（虚线红框
1）：
1
来源1：
项目组提供需
样例：
项目名称
求文档
浙江中烟三项工作项目
编写文档副标题（虚线红框
2）：
内容形式：
文字
如果客户要求将所有流程操作手册写成
来源1
：
自己编写
一份，建议按照以下形式填写副标题：
来源2
：
直接复制本步
骤中的内容
2副标题内容：
用户培训-操作手册
编写文档副标题（虚线红框2）：
样例：
内容形式：
文字
如果客户要求按照业务模块进行编写，建比如：
操作手册-物资采购来源1：
项目组提供需
求文档
议按照以下形式填写副标题：
流程
.
3
.
副标题内容：
操作手册-XXXX（业务模块
名称）
编写文档副标题（虚线红框
2）：
比如：
物资采购业务模块
如果客户要求按照业务流程（业务模块-
下有业务流程
内容形式：
文字
业务流程）进行编写，建议按照以下形式
填写副标题：
样例：
来源1：
项目组提供需
求文档
操作手册—省公司年度采
副标题内容：
操作手册—XXXX流程（业务
购计划填报审（编号）
流程名称）
3）：
样例1：
内容形式：
文字
编写文档编辑作者
（虚线红框
浙江中烟三项工作项目组
来源1：
项目组提供需
由于操作手册文档往往不是一个人编写
样例2：
求文档
来源2：
公司组织机构
完成，建议以项目组的名称或者部门名称
杭州新世纪烟草事业部OA
文档
作为文档编辑作者
运维组
来源3：
4
5
6
7
编写版本号（虚线红框4）：
版本号的制定规则，当文档发生内容上的
变化，就需要保留老版本，建立新版本进
行修改。
版本号的编写建议按照以下方式
进行编写：
当前版本：
1.0（数字编号）
公司的标志图标（虚线红框5）：
复制到文档中
内容形式：
图片
公司名称信息（虚线红框6）：
杭州新世纪信息技术股份有限公司
文档编辑时间（虚线红框7）：
样例：
内容形式：
文字
当前版本：
1.0
来源1：
自己填写
当前版本：
1.1
内容形式：
图片
样例：
来源1：
公司提供
内容形式：
文字
来源1：
公司组织机构
文档
内容形式：
文字
样例：
来源1：
自己填写
.
文档编辑时间二○一二年七月
8更换到第二页，进行“文档控制”和“版本信息”设计
8）：
样例：
编写文档控制内容（虚线红框
文档名称：
浙江中烟三项工
文档名称：
文档名称信息，需要步骤
2
9
中的意思保持一致
内容形式：
文字
作省公司物资采购操作手册
来源1：
自己填写
文档编号：
填写文档统一编号
文档描述：
浙江中烟三项工
文档描述：
本次文档需编写的目的
作省公司物资采购操作说明
编写版本信息（虚线红框
9）：
样例：
10
日期：
编写文档/修改文档日期信息
内容形式：
文字
版本1.0
来源1：
自己填写
版本：
版本信息，最新的版本信息需要
版本1.1
与步骤4中的版本进行对应
1.2正文内容—系统操作模块
图片1
.
模块编辑内容
编写图标说明（虚线红框1）：
系统中出现的图标（icon），需要进
行截取图片加以说明。
说明内容建议
1按照以下字段进行解释：
功能：
图标所代表的功能说明信息图标：
图标图片（icon）
说明：
对图标的说明信息
介绍系统功能模块：
2
将系统模块功能作用介绍一遍
编写系统共用部分功能操作方法
3（虚线红框3）：
系统中出现高频使用的功能，操作方
图片2
备注
内容形式
如果开发提供
ICON图
内容形式1：
文字
标，可以利用
来源1：
数据库表，详细设计，
样例：
概要设计文档
功能：
密码修改
来源2：
根据页面进行记录
图标：
内容形式2：
图片
说明：
此按钮可修改登
来源1：
页面截图
陆用户的当前密码
来源2：
开发人员提供
内容形式1：
文字
来源1：
开发人员提供详细设
计，概要设计文档
来源2：
根据页面进行记录
内容形式2：
图片
来源1：
页面截图
来源2：
开发人员提供
样例：
内容形式1：
文字
用户登陆功能
来源1：
页面记录
⋯⋯
来源2：
概要设计，详细设计
.
法相似或者相同。
建议分成
2快进行
内容形式2：
图片
描述：
来源1：
页面截图
图片：
系统页面截图，需要在截图中
来源2：
详细设计
进行必要的标记（如第二张图片中红
色实现框1）
文字：
具体操作动作解释同时也要将
标记的内容在文档中加以体现。
（比
如第二张图片中步骤2登陆系统，就
需要说明实线红框1中操作动作）
1.3正文内容—业务流程模块
1.3.1业务描述模块
总体结构图
图片1
.
图片2
模块
编辑内容
备注
内容形式
编写业务流程标题（虚线红框1）：
内容形式1：
文字
来源1：
数据库表，详细设
业务流程标题是操作手册非常重要的
样例：
计，概要设计文档
1
部分，因此要求业务流程标题保持和项
来源2：
根据页面进行记录
省公司年度采购计划填
目组所描述的业务流程一致，
建议书写
报审（INV_WZ_001）
内容形式2：
图片
的形式：
来源1：
页面截图
业务流程名称（业务流程编号）
来源2：
开发人员提供
编写业务描述（虚线红框
2）：
业务描述主要内容是描述该业务流
内容形式1：
文字
2
程需要处理什么业务:
来源1：
数据库表，详细设
业务流程：
业务流程名称
（业务流程
计，概要设计文档
编号）
流程作用：
处理业务的目标
.
1.3.2流程环节模块
图片1
模块编辑内容备注内容形式
图片流程模块（虚线红框1图片流
程）：
内容形式2：
图片
1以图片的形式显示一条业务流程，用图来源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：
文字
中
来源1：
项目组历史文档
步骤（1.3.2图片页面中实线红框
1），
的流程名称与1.3.3
中
要求两者内容保持一致
虚线红框1中内容相同
系统指向模块（虚线红框
2）：
内容形式
1：
文字
2
业务流程对应系统中功能指向，
以及该
样例：
来源1：
项目组历史文档
过程所对应的角色
来源2：
按照系统中录入
操作步骤图片流程模块（虚线红框3）：
操作步骤页面截图主要目标就是让客
户熟悉流程步骤对应的页面有一个形
样例：
内容形式
2：
图片
3
象的认识。
页面截图建议：
1.将系统页
图片2中，实线红框是
来源1：
系统截图
面进行截图2.在页面上用实线红色的
在图片中标明操作顺序
来源2：
开发人员提供页面
方框对需要进行的操作动作的顺序进
行标记
.
样例：
升级会员 