如何写出让人一看就懂的操作说明

阅读约需1分钟

客户不断联系客服,新员工反复问同样的问题,“按照说明”完成的任务还是会出错。问题通常出在说明本身:写它的人对任务太熟悉了,看不出新手会在哪里卡住。下面七条规则能让操作说明第一次就奏效,无论是用户手册、帮助中心文章还是工作流程。

清晰操作说明的 7 条规则

1. 一份说明只讲一项任务

“如何设置您的账户”范围太大。“如何修改密码”和“如何添加团队成员”是两份独立的说明。读者只找一项任务,找到、完成,然后离开。

2. 先说结果和所需条件

在开头两行说明读者将达成什么,以及开始前需要准备什么:访问权限、某个文件、密码、十分钟的时间。没有什么比做到第 7 步才发现一开始就缺了东西更让人恼火的了。

3. 编号步骤,每步一个操作

每一步只有一个操作,并以动词开头:“打开设置”“点击保存”。如果一个步骤里出现了“然后”,那就是两步。编号让读者不会跟丢,也让客服可以说“请看第 4 步”。

4. 用读者的语言,而不是您的

按钮和菜单的名称要与读者在屏幕上看到的完全一致。避免内部行话和缩写;如果某个术语无法避免,第一次出现时就加以解释。

5. 说明应该出现什么结果

在重要步骤之后描述结果:“出现一条绿色提示:已保存”。读者能确认自己走对了,一旦出问题也能立刻发现。

6. 警告放在步骤之前,而不是之后

“点击删除之前,请先导出数据:删除的数据无法恢复。”放在步骤之后的警告就来得太晚了。

7. 找新手测试

把说明交给一个从没做过这项任务的人,在旁边观察,不要提供帮助。凡是对方犹豫、提问或出错的地方,都需要重写。五分钟的测试发现的问题,比一小时的反复阅读还多。

配图和结构

  • 截图用于屏幕上的操作步骤,并标出要点击的按钮;界面变化时及时更新。
  • 小标题用于较长的流程,让读者可以直接跳到需要的部分。
  • “如果……怎么办”部分放在末尾,解答常见问题:“如果没有收到邮件,请检查垃圾邮件文件夹”。

总结

一项任务,先说结果和条件,编号且每步一个操作,使用读者的语言,说明预期结果,及时给出警告,并找真人测试。如果您需要撰写手册、一组帮助文章或工作流程,可以订购用户手册和 SOP:您介绍产品或流程,即可收到清晰、结构分明的操作说明。只有在您验收后才会放款。