写操作指引,最容易犯的错是站在写的人的角度,默认读者知道一些背景。结果读者卡在第二步,因为第一步里有个词他不认识。
诀窍之一是把自己当成第一次做这件事的人,从零开始走一遍,卡在哪就补哪。最好真找一个没做过的人照着念,他皱眉的地方就是需要改的地方。
每个步骤只做一件事。把“打开系统,找到设置,修改参数并保存”拆成三步,每步配一句说明和一个预期结果,读者能自己判断有没有做对。
还要写清楚出错怎么办。比如“如果没有看到这个按钮,说明权限没开,联系管理员”。提前把常见卡点写进去,能省掉大量重复答疑。
写操作指引,最容易犯的错是站在写的人的角度,默认读者知道一些背景。结果读者卡在第二步,因为第一步里有个词他不认识。
诀窍之一是把自己当成第一次做这件事的人,从零开始走一遍,卡在哪就补哪。最好真找一个没做过的人照着念,他皱眉的地方就是需要改的地方。
每个步骤只做一件事。把“打开系统,找到设置,修改参数并保存”拆成三步,每步配一句说明和一个预期结果,读者能自己判断有没有做对。
还要写清楚出错怎么办。比如“如果没有看到这个按钮,说明权限没开,联系管理员”。提前把常见卡点写进去,能省掉大量重复答疑。