「协议文本有更新」。
用之前再读一遍是否还能按你的方式用。别假设和去年一样。
给后来的人看,所以写能照着做的步骤,不写感受。每一步写期望看到什么。看不到,就停在这一步,不要继续往下猜。步骤结束以后,用干净环境再做一次。自己的机器上能过,只能说明自己的机器上能过。
动态只记会影响我们怎么用的那一部分:默认值变了、接口弃用了、协议变严了、维护窗口在哪天。不抄整份发布说明。升级前先搜自己有没有依赖旧行为。不紧急的排进周或季度,不要在维护窗口里发布。
收尾只留三行在仓库里:现象,改了哪一处,怎样确认。聊天记录会沉,仓库还在。三行对不上,就还没完,先不要告诉别人已经好了。对得上,别人才能在不找作者的情况下把同一件事再做一遍。
复查「协议文本有更新」时按这四步,不靠感觉。用改之前的同一组输入再走一遍,结果要变成预期的那样。在日志里打出实际读到的配置名、端口或库名,确认不是另一个还没关的进程。换一个干净环境再做一次。最后把现象、改动、确认方法写成三行放进仓库。
补充记录。只写会影响我们怎么用的变化。默认值变了,就搜自己的配置有没有依赖旧值。接口弃用了,就写替代和截止日期,新代码从现在停用旧的。协议变了,就按现在的用法重读,不用去年的印象。维护窗口写进日历,那段时间不发布。安全更新读影响范围,再决定是这周还是当天。示例仓库更新后,旧克隆会和文档对不上,要写明重新拉还是看差异。一篇动态如果不能回答‘我们要不要改、什么时候改’,就还是公告,不是记录。
操作顺序。1. 只摘会改变我们用法的点:默认值、弃用、协议、维护窗口、安全影响。2. 写我们要不要改,以及这周、本月还是下个季度。3. 升级前搜索自己是否依赖旧行为。4. 维护窗口写进日历,那段时间不发布。5. 示例或文档地址变了,就写明旧链接还会跳转多久。6. 把结论压成三行放在开头,细节放后面。读完三行仍不知道要不要行动,这篇就还是转载,不是我们自己的记录。