给项目留一份可查找的工作日志

236 字
1 分钟
给项目留一份可查找的工作日志
项目记录的价值不是证明做过多少事,而是让关键上下文不必依赖记忆。
只记录值得回看的信息
一份有效的工作日志通常只需要回答四个问题:
- 当时要解决什么问题?
- 有哪些限制或已知条件?
- 最终选择了什么方案,为什么?
- 结果如何,还有哪些事情没有完成?
让标题可以被搜索
“修复问题”不是一个好标题。“修复 GitHub Pages 刷新文章页后 404”则包含了场景、平台和现象。几个月后,后者更容易通过搜索被找到。
把过程留在合适的位置
短期任务可以留在提交记录中,稳定的知识适合写进文档,跨项目仍然有价值的经验则值得整理成博客文章。记录的层次越清楚,查找的成本就越低。
文章分享
如果这篇文章对你有帮助,欢迎分享给更多人!

