学习网站优化教程时,工具操作部分最该记录的不是按钮在哪,而是输入、输出、判断标准和失败样例。多人协作场景下,一份记录要能让没参与操作的人复现同样的结果,否则每次交接都要重新问一遍,返工就从这里开始。下面给出具体该记什么、怎么记,以及不同协作强度下的取舍。
工具界面会随版本变化,写“点开左侧第三栏”这种记录很快失效;而输入和输出是稳定的。记录时应包含:
假设你用一个抓取工具检查页面标题,记录写成“抓取了站点前 200 个 URL,导出标题字段,其中 12 条为空”,比写成“打开工具点了抓取”有用得多。前者别人能核对,后者只能靠回忆。
多人协作的目标是减少返工,所以记录要经得起追问:
如果一条记录只能回答“我做过”,不能回答“你怎么复核”,它在协作里基本等于没记。
不是所有学习场景都要记到同等详细。可以按下面的条件做取舍:
代价也很直接:记录越细,前期花的时间越多。判断方法是看返工成本——如果一个问题被问第二次就要重新操作一遍工具,那这份记录就值得写细。
把下面几项固定成模板,每次学工具时填空:
目的:要判断什么
输入:数据来源、范围、参数
操作:关键步骤,不写界面位置
输出:结果形式与数量
判断:合格标准与不合格标准
失败样例:哪种输入会出错,现象是什么
复核方法:别人怎么验证这条记录
技术类记录里如果提到页面结构,用文字说明即可,例如“检查页面是否存在重复的 <h2> 标题”,不必粘贴大段代码。记录的目的是让人看懂判断过程,不是保存代码副本。
写完一条记录后,用下面几项自检:
如果最后一项做不到,优先补的是输入和判断标准,而不是补更多操作截图。
下一步:挑一个你最近学过的优化工具,用上面的模板完整写一条记录,再让一位协作者只看记录复现一次;他卡在哪一步,那一步就是你下次要补记的内容。