博客

操作指南的步骤标题和说明怎么写才有人看

发布于 · 操作指南, 写作, 文档, 技巧

操作指南的步骤标题和说明怎么写才有人看

录制出来的操作指南会自动生成每一步的标题。把这些标题改成操作指令,补上原因和警告,并让每一步保持简短。

录制出来的操作指南,结构大多已经就位:按顺序排好的截图、点击处的标记、每一步的标题。它没有的是判断力。这些标题描述的是点了什么,而不是给跟着做的人的操作指令。花几分钟改一遍就能解决。

第一稿已经在那里了

InSnap 会用你点击的元素生成每一步的标题——「打开设置」「选择通知」「开启邮件提醒」。这是个有用的默认值,因为它来自真实界面,而不是你对界面的记忆。

但它不是操作指令。「选择通知」告诉读者发生了什么;「打开通知页面」告诉他们要做什么。只有一步时差别很小,二十步时就非常明显。

编辑步骤标题和说明 · 1280 × 800

把标题改成操作指令

三个习惯:

  • 用动词开头。「点击保存更改」,而不是「保存更改按钮」。「打开」「选择」「输入」「确认」很清楚;「这个」「那个」「这里」则不是。
  • 只写一个动作。 如果标题里需要「并」,这一步大概就该拆开。录下来的步骤本来就很细,改过之后也应该保持细。
  • 用读者看到的名称。 用界面上的标签,而不是你们内部对它的叫法。如果按钮写的是「发布」,就写「发布」,哪怕团队管它叫「上线」。

一个实用的长度测试:标题应该能在步骤列表里一行放下而不被截断。放不下,它大概是句子,而不是步骤。

补充原因,别重复显而易见的事

说明字段是指南从「截图堆」变成有用文档的地方。它的占位提示说得很准:「为什么有这一步,要注意什么」。

好的说明回答三个问题之一:

  • 这一步为什么存在?(「这样改动就不会影响正在上线的商品目录。」)
  • 之后什么会变?(「状态会变成待处理,直到下次同步。」)
  • 跳过会出什么问题?(「改动保存了,但永远不会发布。」)

糟糕的说明只是用更多字重复标题。如果这段说明不会改变读者要做的事,就删掉。

用提示块写警告

不是每条备注都该写成段落。InSnap 的指南编辑器有三种提示块——提示、警告和备注——在每种导出格式里都会渲染成带颜色的方框。

  • 警告用于可能造成数据丢失或状态损坏的事。
  • 提示用于捷径或更快的做法。
  • 备注用于有用但非必需的背景信息。

提示块不占步骤序号,所以不会打断顺序。那些你本来想塞进步骤标题括号里的话,放在这里正合适。

用子步骤拆开过长的步骤

如果一步里在同一屏上有好几个小动作——打开菜单、选择子菜单、确认——把第一个动作做成顶层步骤,其余做成子步骤。它们在导出里显示为 N.1、N.2 并缩进,读者能看到结构,序号也不用重新开始。

子步骤还能让主列表更好扫读:十个顶层步骤加几个子步骤,读起来比二十个平铺的步骤舒服。

指南编辑器里隐藏的步骤与备注

隐藏没有帮助的内容

录制会捎带进不属于流程的东西:点掉一条通知、误切的标签页、录制途中绕的远路。选中那一步并隐藏。隐藏的步骤在导出时跳过,序号保持连续。

如果这一步里有以后可能用得上的截图,隐藏比删除好;如果它会让读者困惑,隐藏比留着好。

导出前的检查清单

检查为什么
每个标题都以动词开头吗?它才是操作指令
每一步只有一个动作吗?其余用子步骤
每段说明都补充了新信息吗?没有就删掉
警告都放进提示块了吗?它们更醒目,也不占序号
无关的步骤都隐藏了吗?噪音更少,序号不变
姓名和 ID 都打码了吗?指南可能会发到团队之外

常见问题

自动生成的步骤标题能改吗?

能。点画布下方「标题与说明」面板里的标题字段改写即可。下面的说明支持带格式的文字、列表和链接,改动会随指南一起保存。

子步骤和提示块有什么区别?

子步骤属于编号序列(N.1、N.2),通常有自己的截图。提示块是不编号的提示、警告或备注块,用来补充上下文,本身不算一个步骤。

隐藏的步骤还会出现在导出里吗?

不会。隐藏的步骤会被跳过,剩下的步骤重新编号,导出的指南保持连续。这一步仍留在编辑器里,想恢复随时可以。

下一张截图,只需一个快捷键。

macOS 14.4+(Apple 芯片和 Intel)· Windows 10+(64 位)