记录 Specful ADR
ADR(架构决策记录)记录了一个持久决策背后的原因:驱动力、可信的替代方案以及后果。它既不是需求(软件必须做什么),也不是设计(系统如何运作);如果变更涉及“做什么”或“如何做”,请使用 specful-requirement 或 specful-design。保持决策级别:不包含任务序列、文件清单或进度笔记。
工作流
- 阅读
docs/adr/及其索引,了解编号、状态和已有记录;一条与已有记录相矛盾的新 ADR 应替代它,而不是默默反对。 - 使用
specful new adr --title <TITLE>创建新记录。切勿手动分配标识符;命令负责管理计数器。 - 完成占位符。以现在时陈述决策;如实呈现可信的替代方案,而不是为偏好答案设置稻草人;记录负面后果时与正面后果同等重视。没有可信替代方案或没有缺点的 ADR 是广告,而非决策记录。
- 生命周期由维护者管理:新记录默认为“提议”状态,只有维护者才能“接受”、“拒绝”或“替代”。
- 运行
specful index,然后specful validate;将重新生成的视图与变更一起提交。当采用仓库需要实质性审查或用户要求时,使用specful-review。
有关完整的 ADR 配置文件和逐字段指导,请参阅 https://unkos-dev.github.io/specful/。