01
从有用的结果开始
决定访客应该能够做什么,应用程序需要哪些数据,以及它依赖哪些外部服务。静态网站、API 和后台任务有不同的要求。即使它们共享一个代码仓库,也要分别描述它们。
02
保持职责可见
将源代码、运行时设置和存储数据视为独立的关注点。代码应放入版本控制中。配置描述环境。持久数据需要备份和恢复流程。这种分离使得更改某个组件时不必重建其他所有组件。
03
使下一步可重复
记录构建命令、预期输出以及显示发布有效性的检查。其他维护人员应能够遵循相同的步骤。保留最后一个可用的发布版本,并提供实际可行的回退方法。这里的指南涵盖了从第一个项目到 API 访问的基本原则。