说明写在仓库里

「说明写在仓库里」。

聊天记录会沉。仓库里的说明还在。短一点也比没有强。

记录里保留失败的那一次。只写成功,别人学不到边界。失败时的输出、当时的配置、本来期望发生什么,三样放在一起。修好之后补一句:如果再出现,先看哪一行。没有这句,这篇就只是故事。

这篇按可以照着做的顺序写。每一步都写期望看到什么,不写‘然后应该就可以了’。出错时先留下完整输出、当时的配置、你期望发生什么。说明放在仓库里,不放在聊天记录里。给别人之前,在干净目录自己走一遍。

这次按时间写。先发生什么,中间查了什么,最后留下什么。不把后来才知道的结论写成一开始就想到了。查的时候把猜的和已经验证的分开,避免第二天把猜测当成事实。验证用的是改之前的同一条路径,不是换一组更容易过的输入。

复查「说明写在仓库里」时按这四步,不靠感觉。用改之前的同一组输入再走一遍,结果要变成预期的那样。在日志里打出实际读到的配置名、端口或库名,确认不是另一个还没关的进程。换一个干净环境再做一次。最后把现象、改动、确认方法写成三行放进仓库。

补充记录。步骤按别人能跟着做来写。每一步只有一个动作,并写明做完应该看到什么。看不到就停,不要写‘然后应该就可以了’。开始前列出需要的运行时和配置样例,样例用假值。结束前在干净目录自己走一遍,走不通就改步骤,不增加口头补充。出错时要求留下三样:完整输出、当时的配置、期望结果。说明放在仓库,不放在聊天。第一周的目标只到能跑、能提交、知道去哪问,不要把整套结构塞进第一篇。

操作顺序。1. 写明给谁看,以及做完他能做什么。2. 列出运行时和一份用假值填好的配置样例。3. 每步只有一个动作,并写期望看到的输出。看不到就停在这一步。4. 在干净目录自己走完全程。5. 把走不通的地方改步骤,而不是在聊天里补一句。6. 出错时要求留下完整输出、配置和期望。7. 说明随代码放进仓库。第一周只要求能跑起来、能提交、知道去哪问,不把整套结构放进第一步。

7 个赞

说明放进仓库。聊天里的步骤几天后就找不到了。

2 个赞