「周报不用再手抄」。
从完成的事项里生成一份草稿。我仍会改字,但不再从零写。
先留现场,再动手。把当时的输入、输出、配置名抄下来,确认同一条路径还能再出现一次。不能再出现的现象,改完也不知道是不是改对了。确认之后只改一处。改两处的话,结果变了也分不清是哪一处。改完用同一组输入再走,结果要变成预期的那样,而不是仅仅没有报错。
展示的是一个能用的小东西,不是计划。写清楚它解决哪一件具体的事,输入是什么,输出是什么,什么情况下不要用。边界没做完就直说。主路径通了就可以给别人试,不必等所有边角都齐。
判断分两层。第一层是现象:什么时候开始、影响谁、能不能再出现。第二层才是原因。很多时间浪费在还没写清现象就改代码。原因确定之后,改动尽量小,并写明怎样一分钟内确认它生效。确认不了的改动先不要合。
复查「周报不用再手抄」时按这四步,不靠感觉。用改之前的同一组输入再走一遍,结果要变成预期的那样。在日志里打出实际读到的配置名、端口或库名,确认不是另一个还没关的进程。换一个干净环境再做一次。最后把现象、改动、确认方法写成三行放进仓库。
补充记录。展示写给会用的人,不写给围观的人。第一段说明它解决的一件事。第二段写输入和输出,最好有一条最小例子。第三段写不要在什么情况下用,例如数据太大、需要外网、还没做的边界。主路径通了就可以给别人试,边角列在后面,不要等全部做完。错误提示写下一件事,而不只写代号。仓库里放怎么跑、怎么停。停不掉的小工具,不该算做完。
操作顺序。1. 用一段话说明它解决的一件事。2. 给出最小输入和对应输出。3. 写明不要在什么情况下用。4. 写怎么启动、怎么停、失败时看哪。5. 主路径通了就让别人试,没做的边界列在后面。6. 错误提示写成下一件事,而不是只给代号。7. 自己按说明从干净环境走一遍。走不通就改说明。展示的标准不是功能多,而是另一个人能在不问作者的情况下用起来并停掉。