把用户生成内容里的操作过程写清楚,核心是让读者能沿着“我看到了什么、我据此判断什么、我做了什么、做完后怎么复查”这条线走一遍。只写结果或只写结论,别人无法复现,也无法判断哪一步出了问题。下面按观察、判断、处理、复查四段来组织。
操作过程写不清楚,常见原因是把判断混进了观察。观察只记录时间、对象、动作和结果,不写“应该是”“可能是”。例如不要写“上传后系统卡住了”,而要写“选择文件后点击提交,页面停在加载状态超过一分钟,没有出现成功或失败提示”。
可以按这个清单收集:
如果只出现一次,先记为偶发现象;如果每次同样操作都出现,才适合当作可复现问题继续定位。
同一个现象往往有多种解释。以“提交后没有反应”为例,可能原因包括:文件超过限制、网络请求被中断、账号没有对应权限、前端校验未通过、服务端返回了错误但页面没有展示。这些只是可能原因,不能直接写成结论。
判断时要把证据和推测分开写。已经定位的原因,应当有可指认的证据,例如日志里某条错误记录、接口返回的状态码、页面控制台出现的具体报错。没有这些证据时,写成“待验证的怀疑方向”,并说明下一步用什么动作去验证。这样写出来的过程才经得起复查。
假设某次上传失败,记录可以这样写:观察是“选择 12MB 的 PDF 后点击提交,页面提示上传失败”;怀疑方向是“文件大小限制”;验证动作是“换成 2MB 的同类文件再提交一次”。如果小文件成功、大文件失败,说明限制条件与文件大小相关;如果小文件也失败,就要转向权限、网络或服务端错误继续查。这个例子只用于说明写法,不代表任何平台的真实限制。
处理过程不要只写“修复了问题”,要写清做了什么、依据什么、结果如何。可以按顺序写:
一次只改一个条件,是为了让结果可归因。同时改多个条件,即使问题消失,也说不清是哪一个起了作用。
复查不是再点一次按钮,而是按记录重走关键步骤,看结果是否一致。检查项包括:同样的输入是否得到同样的输出;原来的错误提示是否不再出现;有没有引入新的异常;记录里的时间、对象、动作是否完整。
如果复查结果与记录不符,不要直接改结论,先补充新的观察,再更新判断。把旧记录保留下来,能看出问题是稳定存在、间歇出现,还是已经变化。这样一份操作过程,既能帮自己回看,也能让其他人接手时少走弯路。
下一步,挑一个你最近遇到的具体问题,按观察、判断、处理、复查四段各写三行,重点检查观察里有没有混入判断、处理里有没有一次改多个条件。