Codex adr-writer 技能:记录难以逆转的架构决策
EnglishCodex 安装步骤
- 打开 GitHub 固定提交的 `.agents/skills/adr-writer/SKILL.md`,核对内容与使用条件。
- 在自己的项目中创建 `.agents/skills/adr-writer/`,把核对后的文件保存为 `.agents/skills/adr-writer/SKILL.md`。
- 在该项目根目录启动 Codex,输入 `$adr-writer` 并选择同名技能。
中文摘要
对照决策门槛将重要取舍写成 ADR,同时为依赖此决策的实施事项生成阻塞关系。
SKILL.md 中文导读
可复现示例
在 Codex 中选择 adr-writer。根据下列虚构的导览路线方案,先检查决策是否达到记录门槛,再写草稿。
repo ADR convention `docs/adr/` | next ID `ADR-004`
proposal=store route geometry as structured coordinates | option rejected `opaque image`
trade-off=export becomes larger; searchable coordinates enable downstream reports
reversal=would require migration after release | context=evidence from route report spec
ADR issue `ADR-004` | dependent implementation issue `IMP-014`工作步骤
- 对照决策门槛,写清理由与证据。
- 用项目约定组织背景、决定、排除方案、影响和状态。
- 添加稳定标识和依赖实施事项的阻塞关系。
验收方法
记下为何后续迁移代价高、无上下文难理解以及实际取舍。草稿保留 `opaque image` 作为排除方案,并将 `IMP-014` 标记为受 `ADR-004` 阻塞。
GitHub 原文 · 更新日期
适用环境
本地 Codex 项目中有 ADR 命名约定。准备决策、候选方案、取舍和可核对的证据。
常见问题
日常可逆的小调整需要写 ADR 吗?
按难以逆转、需要补充上下文和存在实质取舍三个条件检查。未达到门槛时可保留在普通设计记录中。