把操作过程写清楚,核心是让读者能按顺序复现:先写清起点和结果,再按“观察—判断—处理—复查”四步拆开,每一步只写一个动作,并给出判断依据。下面直接说明具体写法。
操作过程写不清,最常见的原因是起点和终点没交代。动笔前先回答两个问题:做这件事之前,读者手上应该有什么;做完之后,读者应该看到什么。例如写“修改页面标题”,起点是“已打开可编辑的页面模板文件”,终点是“保存后页面源代码中标题已替换”。起点和终点都写成可观察的状态,而不是“了解相关知识”这类无法核对的描述。
每一步都按固定顺序写,读者就不容易跳步:
判断这一步最容易被省略。只写“修改标题”,读者不知道自己遇到的情况是否该改、改到什么程度算完成。把判断条件写出来,操作过程才可复现。
“优化一下”“调整到合适”这类说法无法执行。替换成可核对的结果:改成什么、在哪里看、看到什么算通过。例如不要写“把标题改得更好”,而写“把标题改为包含目标词的一句话,长度以在搜索结果中不被截断为准,改完后在页面源代码中确认”。如果涉及多个可能原因,要区分“可能原因”和“已经定位的原因”,不要一上来就断言唯一原因。
复查不只是“再看一遍”。要写明:如果结果不符合预期,回到哪一步。例如“若刷新后标题未变,先确认文件是否保存,再确认修改的是当前生效的模板”。这样读者遇到问题时知道往哪里退,而不是从头重来。复查项最好控制在两三条,每条都能用“是/否”回答。
写完操作过程后,按这份清单逐条检查。任何一条答不上来,就补上对应内容。下一步,挑一个你熟悉的操作,按“观察—判断—处理—复查”写成四段,再请一个没做过的人照着做一遍,看他卡在哪一步,那里就是需要补写的地方。