给未来项目留一张地图
一个项目刚开始时,大家都觉得自己记得住所有决定:为什么这样建表,为什么选这个框架,为什么某个接口暂时没有做缓存。但过了几周,细节就会像潮水一样退下去。后来我养成了一个习惯:每做完一块功能,就写几行“给未来自己的地图”。不需要正式到像说明书,只要说明入口在哪里,关键约束是什么,哪些地方故意没有做。这样的文档不追求完整,却能在下一次回到项目时省下很多重新摸索的时间。代码会告诉你现在是什么样,提交记录会告诉你发生过什么,而这些简短的笔记,则能告诉你当时为什么那样选择。
一个项目刚开始时,大家都觉得自己记得住所有决定:为什么这样建表,为什么选这个框架,为什么某个接口暂时没有做缓存。但过了几周,细节就会像潮水一样退下去。后来我养成了一个习惯:每做完一块功能,就写几行“给未来自己的地图”。不需要正式到像说明书,只要说明入口在哪里,关键约束是什么,哪些地方故意没有做。这样的文档不追求完整,却能在下一次回到项目时省下很多重新摸索的时间。代码会告诉你现在是什么样,提交记录会告诉你发生过什么,而这些简短的笔记,则能告诉你当时为什么那样选择。