使用方法
- 复制安装命令,在自己的智能体环境安装前先检查源码包。
- 从原始文档核对所需工具、凭据和支持的宿主。
- 说明输入材料与期望交付物,并对照来源检查输出。
npx skills add https://github.com/alexbruno/dev-skills --skill decision-records开始前需了解
- 安装不包含模型订阅、API 额度或访问文件的权限。
- 仓库星数和安装量反映活跃情况,不等于独立质量或安全测试。
按源仓库内容呈现,保留标题、案例、代码、表格、链接以及原文引用的演示图片。
Decision Records (ADRs)
Capture why important technical decisions were made—along with alternatives considered and trade-offs accepted—in concise, immutable Markdown records.
When to Create an ADR
Create an ADR when a change involves:
- A hard-to-reverse architectural or data-model choice.
- A cross-cutting trade-off affecting multiple modules, services, or teams.
- Adding or replacing a core dependency, protocol, storage engine, or integration pattern.
Skip ADRs for routine implementation details, local refactorings, or easily reversible choices—those belong in workflow/PLAN.md or code comments.
Storage & Naming
- Store records in
docs/decisions/(ordocs/adr/if the repository already uses that convention). - Name files sequentially with a lowercase hyphenated slug:
docs/decisions/0001-short-decision-title.md
- Start from the template in ADR.md.
Rules
- Link with `workflow/`: Reference the ADR from
workflow/PLAN.md(andworkflow/SPEC.mdif applicable) so design context stays connected. - Keep it concise: Focus on context, decision, alternatives rejected, and consequences—avoid turning an ADR into a tutorial or full specification.
- Immutable history: Once accepted, do not rewrite an old ADR's intent; if a decision changes later, create a new ADR that marks the previous one as
Superseded by <ADR-XXXX>.