把操作过程写清楚,核心是让读者不依赖猜测就能复现每一步:先交代起点和终点,再按真实执行顺序拆成动作,每个动作写清对象、条件、结果和异常处理。摘要优化不是把步骤压短,而是删掉不影响复现的枝节,保留判断依据和关键参数。
要查的是操作起点和完成标准。把当前摘要交给一位没参与过该项目的人,请他口头复述第一步和最后一步。如果他说不出“在什么状态下开始”“看到什么算完成”,说明边界缺失。结果说明什么:起点缺失会让读者误用前置条件,终点模糊会让读者不知道何时停止。补充时用可观察状态描述,例如“页面已加载出列表”比“准备好后”更可核对。
要查的是步骤之间是否存在隐含依赖。逐条读操作过程,问三个问题:这一步的输入是否来自上一步的输出;两步能否互换;互换后是否出现错误。怎么查:把步骤编号写在纸上,尝试交换相邻两步,在测试环境执行一次。结果说明什么:若交换后失败,说明顺序是硬约束,应在摘要中保留编号;若交换后仍成功,说明这两步可以合并或降为并列项。适用条件是操作具有可逆性;不可逆操作如删除、发布、付款,不要用交换法验证,应改为检查前置确认项。
要查的是单步信息完整度。用“对什么、做什么、看到什么”三项核对每一步。例如“打开设置页,在搜索框输入缓存,若出现清理按钮则点击,若没有则跳过”。这里对象是设置页搜索框,动作是输入,判断结果是出现或没有出现按钮。结果说明什么:缺少对象,读者会点错位置;缺少判断结果,读者无法确认是否成功。短例子:把“调整参数”改成“把超时时间从默认值改为 30 秒,保存后重新加载页面,确认数值仍为 30”。适用条件:涉及界面或配置时,写可观察的数值和状态;涉及人工判断时,写出判断依据,不写“适当调整”。
要查的是失败、跳过和回退三种情况。怎么查:对每个关键步骤问“如果条件不满足会怎样”“如果执行到一半中断如何恢复”“如果结果不符合预期先检查什么”。结果说明什么:只写顺利路径的摘要,读者一旦遇到报错就会停住;写出分支后,读者能自行判断是继续、重试还是回退。可执行清单式核对如下:
适用条件:操作涉及数据写入、外部依赖或多人协作时,异常分支必须写;纯阅读类操作可以只保留失败提示。
要查的是冗余与缺失的边界。逐句标记三类内容:影响复现的参数和判断,保留;背景介绍和重复解释,删除或移到正文;操作者的主观感受,删除。怎么查:遮住摘要中的形容词和铺垫句,看剩余内容能否让读者完成操作。结果说明什么:若遮住后仍能复现,说明被遮内容不影响操作;若遮住后无法判断,说明删多了,应补回条件或结果。不要用同义词替换来压缩步骤,那不会增加新信息,只会让判断依据变模糊。
下一步:拿一份现有操作摘要,按“起点终点、步骤顺序、单步三要素、异常分支、冗余删除”五项各改一遍,再请一位未参与的人照着执行,记录他卡住的位置,回到对应检查项继续修改。