要把操作过程写清楚,核心是让读者在不询问任何人的情况下,按顺序完成每一步并判断自己是否做对。具体做法是:先写清目标与前置条件,再按动作顺序拆解步骤,每步只做一件事,并给出现象判断和出错处理。下面这份清单可以直接对照执行。
要查的是操作起点。把文案给一位不了解背景的人看,观察他能否说出第一步之前需要准备什么。结果说明:如果他问“要先登录吗”“需要什么权限”,说明前置条件缺失;如果他能直接动手,说明起点清楚。
要查的是动作顺序。把每个步骤写成“动词+对象+结果”的形式,例如“点击保存,页面提示已更新”。逐条检查是否出现先写结果后写动作、或两个动作挤在一句话里的情况。结果说明:顺序颠倒会让读者卡在中间,动作混装会让读者无法判断哪一步没做。
要查的是单步可执行性。用下面的检查项逐条核对:
结果说明:四项都满足,读者可以独立完成并自我校验;缺少现象描述,读者会反复尝试;缺少失败处理,读者一旦出错就会中断。
假设要说明“修改文章标题”这个操作,可以这样写:
这个例子的判断依据是:每一步都有动作对象,第三步给出了成功现象和失败现象。适用条件是操作本身只有少量步骤;如果步骤超过七步,应拆成若干小节,每节用一个小标题说明该节要达成什么。
要查的是同一事物是否始终用同一个名称。通读全文,把指代同一对象的词列出来,例如“标题栏”“标题输入框”“标题字段”混用时,读者会怀疑它们是不是不同位置。结果说明:名称统一,读者不需要反复确认;名称混用,步骤再细也会产生歧义。同时检查“它”“这里”“上面”等指代词,确认每个指代都能找到明确对象。
下一步:拿一篇现有操作说明,按上面的检查项逐条标记,先改前置条件和步骤顺序,再补每步的现象描述和失败处理。