先记录现象

写清楚期望行为、实际行为,以及可以稳定复现的步骤。必要时记录运行环境和相关版本。

再记录原因

把确认的原因与尝试过的猜测区分开。给出一段最小代码或具体输入,通常比堆叠日志更有帮助。

最后记录验证

说明修复后如何验证原问题,以及是否仍有已知限制。让下一次遇到相似问题的人能快速判断这份笔记是否适用。

示例写作结构:现象 → 复现 → 原因 → 修改 → 验证。