项目记录里最容易丢失的,不是已经完成的部分,而是没有做完的部分。
一项检查为什么没有执行,某个接口为什么暂时用了模拟数据,目标服务器为什么还没有部署,开发者当时通常都知道。但过几周再回来,记忆已经不可靠,新的参与者更无从判断。
我会把结果分成几类。已经完成并检查过的,写明版本、环境和结果;尝试过但失败的,保留第一处真实错误;因为缺少账号、网络、数据或授权而没有运行的,标为 NOT_RUN;暂时无法判断的,保留未知状态。
NOT_RUN 不是失败,也不是完成。它只表示这项检查没有发生。这样写看起来不够漂亮,却能避免别人把空白误读成通过。
记录还应该说明怎样继续。缺哪个账号,需要谁确认,下一条命令是什么,恢复前要先核对哪些数据。做到这一步,交付才不依赖某个人一直在线解释。
没有做完的事情并不可耻。把它藏起来,才会让后来的风险变大。对一个人工作室来说,清楚的记录也是让我能够在多个项目之间安全切换的方法。