field note · no. 01

工具做给三个月后的自己

判断一个内部工具值不值得做,我只看一件事:三个月后还愿不愿意打开它。

写工具的时候,人很容易被”通用”吸引。

参数加一个、配置项再留一个、顺便支持另一种输入格式。功能表越来越长,第一次使用的路径也越来越长。

但工具真正的用户不是今天的我,是三个月后的我——那个已经忘了上下文、只想赶紧把事做完的人。

三个判断

三个月后还看得懂吗?

变量名和目录结构比注释更诚实。如果必须读注释才能明白,通常说明结构本身没想清楚。

打开就能用吗?

能少一个设置项就少一个。默认值不是偷懒,是把判断提前做完。

坏掉时会说话吗?

报错信息要指向下一步动作,而不是只宣布失败。“文件不存在”不如”文件不存在,检查 —input 路径”。

少做一点

一个工具只解决一个动作,比一个工具解决半套流程更耐用。

流程会变,动作不会。

工具做给三个月后的自己用。他不是更聪明,只是更没耐心。