工程文档与决策记录

工程文档与决策记录

这篇笔记还在编辑中,内容可能会继续补充、调整或重写。

核心认识

工程文档说明如何开发、测试、发布和排障,决策记录则保存重要技术选择的背景、方案和后果。文档应靠近代码、明确负责人,并随变更一起评审。

学习重点

  • 优先把可机械判断的规则交给工具自动执行
  • 让规范具备清晰动机、渐进落地方式和例外处理机制
  • 确保本地检查与 CI 使用相同命令和配置

实践检查

  • 能用自己的话解释“工程文档与决策记录”
  • 能在最小项目中完成一次与“工程文档与决策记录”相关的验证
  • 能记录常见问题、取舍依据和排查方法