使い方
- インストールコマンドをコピーし、自分の環境へ導入する前にソースを確認します。
- 必要なツール、認証情報、対応環境を原文で確認します。
- 入力と成果物を指定し、出力を資料と照合します。
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>.