写过数万字的操作手册,聊聊用户使用说明书该怎么写?操作员

用户使用说明书,是为了能够让用户能更清晰地使用产品而编写的。作者提到了一个编写的小技巧,就是把它当成一个需求来处理,那么具体要如何编写,注意哪些细节?作者从明确需求的目的到最后的调整和完善都做出了详细的讲解,欢迎阅读。

01前言

最近主导了几个项目操作手册的编写。有新开发的项目,要重新编写操作手册;有中途接手别的项目,后来功能迭代,需要更新原操作手册;有客户对操作手册有意见,需要调整;零零散散写了数万字的手册。

其实写操作手册或者叫用户使用说明书可以当作一个需求来处理。既然是需求,那么处理需求的几个主要步骤对于产品经理来说就是轻车熟路了。

02明确编写目的、目标用户、使用场景

编写目的:操作手册就是介绍系统如何操作。对于交付型的项目,在交付的时候需要有这个文档。对于toB的项目,一般也会为客户提供该文档。即便目前有多种为用户介绍系统如何使用的方式,但是这个手册作为一个全面、详细的文档,在一些场景下还是有必要的。

目标用户:客服人员、系统用户(注意可能会有多个角色,比如管理员、操作员、被管理人员等)。

使用场景:客服人员多是软件的开发方的人员,当系统大到一定程度后,一些详细的规则单靠记忆很难覆盖,在遗忘的时候可以拿操作手册作为参考。一个是软件的实际使用人员,在遇到问题又找不到客服时,可通过操作手册进行快速查找。综合来看主要是两个场景:

03形成解决方案

针对编写目的、用户、场景,总结出操作手册必备的几个要素。

1.目录结构

一般操作手册会根据不同的人有不同的版本,但是如果为每个人单独写一份,这个工作量就太大了。最好在写的时候就按使用人来划分,这样就可以只写管理员(拥有系统全部权限)版本,然后将管理员版本中的部分摘出来即可形成多个版本。

比如一个系统有移动端和PC端,如果PC端作为管理、配置功能,给操作员用。PC端是展示,给管理者用,那么目录可以分移动端和PC端,然后再分更细的功能;如果同一个用户既可以在移动端完成该功能,又可以在PC端完成,那么目录可以按照功能进行划分。按照这样的逻辑划分就可以达到上述目的。

如果系统目录划分比较清晰,详细的功能可以按照目录来划分。这里toB系统的产品经理应该很熟悉。如果不清晰,建议先优化系统目录。或者系统功能本身很琐碎,操作手册可以按照事项来划分。

比如某项信息要在前端展示,需要经历信息的上传、审核、发布等流程。那么既可以分开介绍某各流程具体怎么操作,也可以将信息怎么发布作为一个模块来整体介绍,或者写一个整体的流程框架,具体某步骤参照某章节。具体写法需根据系统的实际情况来判断。

2.功能概述

可以如果流程较为复杂,可以用流程图等来辅助说明。

3.详细操作步骤

每一步具体怎么操作,点击哪个按钮,填写哪些字段。各个按钮点击有什么效果,字段填写有什么意义会影响到哪里。这些内容该怎么写,主要是根据页面和功能的种类。

这时候需要说明,否则用户在使用过程中会进行大量的提问。如果系统有专有名词,也需要进行描述。(最好单独用一小节对其进行统一介绍)

图片是操作手册的重要部分。但不能把系统上的图直接放在操作手册中。有几个需要注意的点:

做到这两点已经很清晰了。在大量的实践中,我发现最好把同一个功能里的几个步骤做一个长图,这样在文档中查看时不会形成大量的空白部分,能够更快的看出每个步骤是什么。如果客户没有看操作手册,直接问,客服可以把长图给他。

04验证并完善方案1.小范围发布

写好后,可以让公司其它小伙伴看一下,最好是目标用户。比如你手册的目标用户是运维,可以找其它产品线的运维伙伴来看。比如你的目标用户是客户,可以先小范围发给典型客户或关系较好的客户,收集问题,对操作手册进行调整。这个类似于产品的初步验证,用草图、原型各种能让用户理解体会到产品流程的方式,对产品进行初步的体验并提出意见。

2.根据反馈进行调整

目标用户对操作手册的反馈主要有两个方面。一个是用户的直接反馈,一个是用户的使用方式。

用户阅读手册后,可以与用户沟通使用意见,看哪里不容易理解,哪里查看起来不方便,以此来调整手册的结构及表达方式。另外可以观察用户如何查阅手册,看针对几个特殊场景(初次使用时的整体阅读及查询某个细节时寻找解决方法)的使用情况,来发掘文档可能存在的优化点。这个相当于既要通过访谈的方式沟通用户对产品的意见,又要通过观察的方式找出用户在使用中遇到的问题。

05几点经验1.版本管理

首先有一个操作手册基线版本,在第一次写完后记录当前操作手册对应的系统版本。然后根据系统的升级情况,会逐步往操作手册中增加内容,此时需记录每次都增加了哪些内容,对应了系统的哪些版本。

2.明确/申明概念

3.格式统一

4.其它形式的操作手册

最好的操作手册是不用操作手册用户上手即会用。操作手册是系统的一部分,那么手册的理想状态是没有手册。通过优化系统、将提示融入系统等等方式可向这个理想艰难前行。

本文由@率然原创发布于人人都是产品经理。未经许可,禁止转载

题图来自Unsplash,基于CC0协议

该文观点仅代表作者本人,人人都是产品经理平台仅提供信息存储空间服务。

THE END
1.使用说明书格式(共6篇)四、使用说明(宋体四号,粗体) (介绍系统的使用方法叙述部分用宋体五号,单倍行距) 注: 1.该格式应由指导教师先进行理解,大体书写格式与本格式一致,但具体撰写细节(如网络类课题)由指导教师自行设计。 2.毕业设计说明书部分每一页均应设置页眉和页脚。 页眉:无 锡职业技术学院 毕业设计(论文)说明书 页脚:标明页码https://wenku.baidu.com/view/2c75642add80d4d8d15abe23482fb4daa58d1d1f.html
2.软件使用说明书怎么写软件需求规格说明书(范例) 3星 · 编辑精心推荐 《软件需求规格说明书》是软件开发过程中的重要文档,它详细描述了软件系统应具备的功能、性能、界面、接口等方面的需求,为后续的设计、开发、测试等阶段提供明确的指导。以下将根据提供的内容,详细解析软件需求规格说明书的关键部分。 1. **引言** - **目的**:这https://wenku.csdn.net/answer/bf8c546e7b0746b7930a90b5c62a2442
3.使用说明英文怎么写使用说明英语怎么说沪江词库精选使用说明英文怎么写、英语单词怎么写、例句等信息 direction for useinstruction 相似短语 in the direction 沿着…方向,朝着…方向 in the direction of 向…方向,在…方向 in the right direction 朝着正确的方向 compass direction 罗盘方向 direction bearing 探向方位 direction coefficient https://www.hujiang.com/ciku/262142_-1162567017/
4.产品使用说明书用英文怎么写?相似问题 产品使用说明书 英文 他告诉我这些产品没有说明书,用英文怎么说? 英语翻译:或许这些内容就是那些产品的说明书. 特别推荐 热点考点 2022年高考真题试卷汇总 2022年高中期中试卷汇总 2022年高中期末试卷汇总 2022年高中月考试卷汇总 二维码 回顶部?2021 作业帮?联系方式:service@zuoyebang.com?作业帮https://www.zybang.com/question/bd91fe65ee429ebce256a042ee08c2d5.html
5.使用说明书用英语怎么说翻译成英语参考资料: 1.百度翻译:使用说明书 2.有道翻译:使用说明书获赞5次 声明:内容版权归作者所有,未经授权不得任意转载 本文标题和链接: 使用说明书用英语怎么说-翻译成英语 https://yingyu.xiediantong.com/en/998572974026eb40/相关词汇 instruction list instruction statement instruction sheet instructions Using inshttps://yingyu.xiediantong.com/en/998572974026eb40/
6.离职证明有什么用,该怎么写离职证明劳动部《关于实行劳动合同制度若干问题的通知》规定:“在劳动者履行了有关义务终止、解除劳动合同时,用人单位应当出具终止、解除劳动合同证明书,作为该劳动者按规定享受失业保险待遇和失业登记、求职登记的凭证.证明书应写明劳动合同期限、终止或解除的日期、所担任的工作.如果劳动者要求,用人单位可在证明中客观地说明解https://mip.64365.com/zs/714066.aspx
7.个人使用说明书:如何让团队更好地“使用”你?二、个人说明书有什么作用? 加深自我认知? 用飞书文档写一份个人使用说明书,是一个深度探索自我认知的过程。通过了解自己、认识自己、使用自己的过程,能 360° 全面分析自己的优点和劣势。? 促成更有效的协作? 不需要花几个月的时间去揣摩对方的喜好、优势和弱点,就可以快速了解你能怎么帮助到对方,以及对https://www.feishu.cn/hc/zh-CN/articles/360048137813
8.考勤未打卡说明怎么写未加入考勤组可以使用考勤机打卡吗钉钉帮助中心为您提供考勤未打卡说明怎么写相关问题的回答,更多考勤未打卡说明怎么写问题相关解答可以注册咨询钉钉人工客服。https://www.dingtalk.com/qidian/help-keyword-22320.html
9.产品说明书怎么写(共4篇)(精简版)产品说明书怎么写(共4篇)产品说明书怎么写(共4篇)篇一:产品说明书的写法产品说明书的写法作者:**来自:百度贴吧点击:12566时间:2016-5-29(一)产品说明书概述产品说明书,是对商品的性能、用途、使用和保养方法以及注意事项等作书面介绍的文书。产品说明书,又叫商品说明书。产品说明书的作用:助和指导消费者正确地https://www.docin.com/p-1413703580.html
10.如何优雅的使用markdown写博客微博图床使用说明51CTO博客如何优雅的使用markdown写博客--微博图床使用说明 一: 我的理想 我一直有一个理想, 写博客就舒心的去写, 然后能够在知乎, 简书, csdn, 51CTO任意复制, 这是多么快意的人生. Markdown的出现, 满足了我90%的需求, 一个痛点就是图片的问题, 毕竟花40分钟写文章, 然后花半小时上传到不同平台的事情是不能够https://blog.51cto.com/yijiaobani/2867463
11.更换公章外壳怎么写说明更换公章外壳怎么写说明 更换公章外壳写说明方式:1、公章更换说明因本公司公章使用过多,模糊不清,遂更换新章。2、公章更换事项已在工商部门备案。3、更换前更换后,法定代表人签章:写上自己姓名。4、左下角或右下角写上日期。https://wenda.so.com/q/1679368117215241
12.汇川技术HMI触摸屏应用笔记使用说明–燕骏博客说明:该文档是基于当前产品的使用和注意事项,随着产品功能的不断更新,如果现场有遇到新的问题或得到新的经验,也请反馈给项目组。本文是汇川技术工程师总结,由Julius_wen发布 界面介绍 怎么查看是IOT屏还是标准型号屏 解决措施: 查看HMI屏幕背面Model:IT6070E-IOT是物联网HMI,型号是IT6070T/IT5070T则是标准触摸屏http://www.yanjuntech.cn/archives/2885
13.设备使用说明书模板.doc设备使用说明书模板.doc,设备使用说明书模板 篇一:设备说明书样本 尊敬的上海紫江用户: 您好!感谢您选购大连奥特马(ALTMA)工业有限公司生产的自动包装塑料袋涂胶机. 我公司专业为客户设计制造各种非标包装机械。为使我们的设备更好地发挥其卓越的性能为 贵公司生产服务,https://mip.book118.com/html/2016/0802/49971035.shtm
14.智慧校园服务大厅使用说明20200917*注:如果您要绑定QQ邮箱却收不到绑定邮件,建议更换其他邮箱比如北师大学生邮箱(使用说明:教职工邮箱,学生邮箱)、网易邮箱、139邮箱等。 3.绑定手机号码。 四、忘记密码怎么办? 点击登录页【忘记密码】,您有三种途径找回密码(查看操作演示): 途径1:问题找回——输入提示问题的正确答案即可重置密码; https://nic.bnuz.edu.cn/info/1106/1161.htm
15.摄像手表怎么操作录像手表使用说明详解→MAIGOO知识摘要:摄像手表是具备摄像、录音等功能的科技产物,是世界上第一款采用内置存储器的微型数码摄像手表。摄像手表小巧精致且隐蔽性高,不仅易于携带,而且使用操作简便,一经推出,即受到广大行业和个人用户的青睐。那么摄像手表怎么操作?下面小编就来介绍录像手表使用说明详解。 https://m.maigoo.com/goomai/165053.html