LIZH / 随手记
← 返回文章列表

小项目,也值得认真收尾

构建笔记1 分钟阅读

从能运行到能继续使用,中间还有几个容易被忽略的小步骤。

一个工具第一次运行起来,是令人高兴的时刻。但如果希望几周后仍然愿意使用它,还需要给它留一个清楚的收尾。

把入口留下来

写明怎样启动、配置放在哪里、正常结果是什么。不要假设自己一直记得那个只运行过一次的命令。

检查最普通的使用方式

第一次打开、没有数据、输入错误、重新启动,这些情况往往比复杂功能更值得先检查。一个明确的提示,比长时间没有反应要好。

给下一次修改留余地

  • 把内容和样式分开保存。
  • 修改前保留一个可以恢复的版本。
  • 把尚未完成的部分写清楚。
  • 删除不再使用的入口,避免新旧路径混在一起。

收尾并不是停止改进,而是让下一次开始时不必从头寻找线索。