create-adr について
create-adrは、確定済みの決定をArchitecture Decision Record(ADR)として記録するワークフロー型スキルです。必須項目の確認、形式と番号の選択、起草、品質チェックを案内し、ADRを履歴記録として扱います。
主な機能
- 01ADRの必須項目の検証
- 02MADR、Nygard、Y-Statementに対応
- 03連番の文書番号を割り当て
- 04トレードオフと品質の確認
- 05書き込み前の確認
活用シーン
- 01確定したアーキテクチャ決定の記録
- 02チーム記録用のADR形式の選択
- 03新しいADRによる旧決定の置き換え
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ emiliosheinz/ agent-skills --skill create-adrインストール後、Claude Code で/create-adrを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
README.mdreferences/formats.mdnumbering.mdprocess.mdquality.mdtemplates/adr-madr.mdadr-nygard.mdadr-y-statement.md詳細
ADR の作成
1 回の実行につき ADR を 1 つ作成します。ADR には、すでに下された決定を記録します。決定がまだ確定していない場合は、/create-rfc を使用してください。5 つのステップを順番に進めます。ステップ 2 では必須項目を検証し、すべての項目がそろったらドラフトの作成を開始します。
厳守事項
- 事実を決して作り出さないでください。 必須項目が不足している場合は、質問してください。もっともらしい内容で「コンテキスト」「決定」「結果」を埋めてはいけません。
- 決定を変更するために既存の ADR を編集してはいけません。 新しい ADR で置き換え、元の ADR へのリンクを記載してください。ADR は履歴記録です。
- トレードオフを省略してはいけません。 結果は正直に記載してください。何が容易になるかだけでなく、何が難しくなるかも含めてください。
- ユーザーが使っている言語で記述してください。 文書のすべてのセクションに適用します。
手順
プロセスを順番に実行してください。作業に取りかかる前に、該当する参照ファイルを最後まで読んでください。そのステップの手引きです。
| ステップ | 読むファイル | 目的 |
|---|---|---|
| 1 — コンテキストの収集 | references/process.md | 決定、形式、ステータス、置き換え対象について質問する |
| 2 — 必須項目の検証 | references/process.md | タイトル、日付、ステータス、コンテキスト、決定、結果がそろっていることを確認する |
| 3 — 形式の選択 | references/formats.md | MADR(デフォルト)/Nygard/Y-Statement |
| 4 — 番号の割り当て | references/numbering.md | ディレクトリをスキャンし、次の連番を割り当てる |
| 5 — 生成と配置 | references/process.md + templates/adr-{madr,nygard,y-statement}.md のいずれか | テンプレートを埋め、品質チェックリストを実行し、ファイルの配置場所を確認する |
最終決定の前に、品質チェックリスト(references/quality.md)を実行してください。
タイトル、正直なトレードオフ、実際に比較した選択肢、命名規則を確認します。
テンプレート
純粋な Markdown のひな形です。選択した形式のものだけを読み込んでください。
| 形式 | テンプレート |
|---|---|
| MADR(デフォルト) | templates/adr-madr.md |
| Nygard | templates/adr-nygard.md |
| Y-Statement | templates/adr-y-statement.md |
共通ルール
- 誠実さ。 トレードオフ、不明点、未解決の質問を正直に記録してください。作り出した回答で不足を補ってはいけません。項目を埋められない場合は、質問するか、イタリック体のプレースホルダー(
*to be confirmed*)を残してください。 - 不変性。 ADR は履歴記録です。事後に決定を編集してはいけません。新しい ADR で置き換え、古い ADR に
Superseded by ADR-{NNN}とリンクを記載してください。 - 簡潔に。 200~500 語が理想です。それより長くなる場合は、詳細をリンク付きの設計ドキュメントまたは RFC に移してください。
- すべてに日付を付ける。 今は明白に思えることも、3 年後にはそうとは限りません。
- 書き込む前に確認する。 ステップ 5 でファイルパスを提案し、ユーザーが配置場所を確認してから書き込んでください。
関連スキル
プロセスのどの段階でも、次のスキルを利用できます。
/create-rfc— 決定がまだ下されていない場合に使用します。RFC で選択肢を提案し、フィードバックを集め、合意形成を進めます。決定後、/create-adrに戻って記録してください。/forge— 仕様駆動の実装に使用します。ADR の決定後、対象を構築する必要がある場合は、/forge specify | design | plan | executeを使用してください。ADR は、forge のdesign.mdにリンクとして記載されることがよくあります。
クレジット
Tech Leads Club による create-adr を基にしています。ライセンスは CC-BY-4.0 です。原作に変更を加えています。
コメント
Markdown 対応