给以后的自己,留下一条决策线索。
用 Markdown 记录代码做了什么,也留下当时为什么这样选择。
本篇目录
这是一篇演示文章,不代表 Matt 的真实开发经历。文中方法和例子都是可替换的示例素材。
代码之外还有背景
代码保留了最终选择,却可能没有留下被放弃的方案。几个月以后,一个看起来奇怪的取舍,可能原本是为了适应当时明确的约束。
写下三个足够具体的问题
一次简短记录可以围绕下面三个问题:现在的问题是什么,当时有哪些约束,以及什么变化会让这个决定值得重新讨论?
不必把每次提交都写成文章。记录对理解产品有帮助的变化,读者才能在信息里找到重点。
把结论连接到文章
产品介绍负责说明正在做什么,开发手记负责解释为什么这样做。它们互相连接,就能让一段实现细节回到真实使用场景里。