怎么记录排错经验?
04-04 怎么记录排错经验?
Section titled “04-04 怎么记录排错经验?”这一课把错误变成资产。学员已经会提交完整报错、识别常见错误、写复现路径。现在要把这次排错记录到项目里,下一次遇到类似问题可以更快处理。
排错经验记录是个人编程能力增长的关键证据。每记录一次,学员对项目的掌控感就会增加一点。
这一课的成果是一份「排错经验卡」。
- 能记录错误现象。
- 能记录错误原因。
- 能记录修复动作。
- 能记录下次预防方式。
- 能把排错经验保存到
logs或 README。
- 建议时长:18 到 25 分钟。
- 接上一课的错误复现继续演示。
- 让 AI 根据报错协作卡和修复过程整理经验。
- 老师要示范人工补充“下次预防”。
- 收尾把记录放进项目文件夹。
- 报错协作卡。
- 常见错误排查表。
- 错误复现记录。
- 修复后的项目。
logs文件夹。
可以这样开场:
“错误修好以后,很多人会立刻松一口气,然后把这件事忘掉。下一次同样的错误再出现,又重新慌一次。今天我们把错误留下来,让它变成经验。”
排错经验卡写五块。
第一,错误现象。
用学员看得懂的话描述。比如“点击转换后结果区空白”。
第二,错误类型。
根据上一节判断,写路径错误、目录错误、依赖缺失、语法错误等。
第三,原因。
比如“脚本读取的输入框 id 和页面实际 id 不一致”。
第四,修复动作。
写清改了哪个文件,改了什么。不用逐行描述,但要能让未来的自己看懂。
第五,下次预防。
比如“修改页面 id 后,同时检查 JS 里的选择器”“每次运行前确认当前目录”。
这里要强调:
“经验记录是在给未来的自己留路标。”
可以让 AI 先整理,再人工补充。AI 很适合把散乱过程写成清单,但真实原因和预防动作,要由学员根据现场确认。
最后收束:
“每一条排错记录,都是你在数字工坊墙上贴的一张小纸条。以后再遇到同类问题,你会更稳。”
屏幕演示流程
Section titled “屏幕演示流程”- 打开上一课错误复现记录。
- 打开修复后的运行结果。
- 让 AI 根据全过程整理排错经验。
- 人工检查错误原因是否准确。
- 补充下次预防动作。
- 保存到
logs/debug-notes.md。 - 在 README 里补一条常见问题链接或摘要。
给 AI 的协作卡
Section titled “给 AI 的协作卡”请根据下面的报错协作卡、复现记录和修复结果,整理一份排错经验卡。
请包含:1. 错误现象2. 错误类型3. 错误原因4. 修复动作5. 下次预防6. 可以写入 README 的一句提醒
请用普通人能看懂的语言写。- 日期:
- 错误现象:
- 错误类型:
- 错误原因:
- 修复动作:
- 修改文件:
- 修复后结果:
- 下次预防:
- README 提醒:
让学员把前面模拟错误整理成排错经验卡。
要求:
- 写清错误原因。
- 写清修复动作。
- 至少写一条下次预防。
- 保存到
logs。
- 学员只写“已解决”:补充现象、原因、动作。
- AI 写得太技术:要求改成普通人能看懂的版本。
- 原因仍不确定:标注“当前判断”,并写下一步观察。
- 记录散落在聊天里:统一放进项目
logs。
完成一份主项目排错经验卡。
提交内容:
- 排错经验卡。
logs文件截图。- README 中的常见问题提醒。
- 第 1 页:错误修好以后,把经验留下
- 第 2 页:现象、类型、原因、动作、预防
- 第 3 页:AI 整理,人来确认
- 第 4 页:写入 logs 和 README
- 第 5 页:排错经验卡