adr について
adr は、プロジェクトのアーキテクチャ決定記録(ADR)を管理するコマンドスキルです。開発チームが記録用ディレクトリを整え、決定を文書化して状態を追跡できます。
主な機能
- 01ADR ディレクトリ構成の初期化
- 02ADR の作成と置き換え
- 03プロジェクト内 ADR の一覧と検索
- 04個別 ADR の表示
- 05提供された ADR テンプレートの利用
活用シーン
- 01プロジェクトに決定記録を導入
- 02新たなアーキテクチャ選択の記録
- 03過去の決定の検索や確認
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ jellydn/ my-ai-tools --skill adrインストール後、Claude Code で/adrを入力して読み込まれたか確認します。
同梱ファイルtemplates/adr-template.md
詳細
アーキテクチャ決定記録(ADR)
アーキテクチャ決定記録を管理するための統一インターフェースを提供します。
使用方法
/adr <ACTION> [ARGUMENTS]
アクション
- init [DIRECTORY] - ADR ディレクトリ構造を初期化します
- new - 指定したタイトルで新しい ADR を作成します
- supersede <NUMBER> <TITLE> - 既存の ADR に取って代わる ADR を作成します
- list - プロジェクト内のすべての ADR を一覧表示します
- search - 内容から ADR を検索します
- view - 指定した ADR を表示します
ADR とは?
アーキテクチャ決定記録(ADR)は、プロジェクトの開発中に行われた重要なアーキテクチャ上の決定を記録する短い文書です。チームにとって、次のようなことに役立ちます。
- 決定の背景と理由を記録する
- アーキテクチャ上の選択の変遷を追跡する
- 新しいチームメンバーのオンボーディングを行う
- 次に進む前に、決定事項が確定したことを示す
ADR の構成
各 ADR には通常、次の内容が含まれます。
- タイトル:決定の概要
- ステータス:提案、承認、非推奨、置き換え済み
- 背景:決定が必要となった状況
- 決定:選択した解決策
- 結果:肯定的および否定的な影響
ADR テンプレート
テンプレートは $SKILL_PATH/templates/adr-template.md にあります。
# [NUMBER]. [TITLE]
Date: [DATE]
## Status
[Proposed | Accepted | Deprecated | Superseded by [ADR-NUMBER]]
## Context
[Describe the context and problem statement]
## Decision
[Describe the decision and solution]
## Consequences
### Positive
- [Positive outcome 1]
- [Positive outcome 2]
### Negative
- [Negative outcome 1]
- [Risk or trade-off]
ADR ディレクトリの検出
確認する一般的な ADR の保存場所:
doc/adr/(デフォルト)docs/adr/docs/architecture/decisions/architecture/decisions/
プロセスの例
新しい ADR を作成:
/adr new "Use PostgreSQL for primary database"
すべての ADR を一覧表示:
/adr list
ADR を検索:
/adr search "database"
特定の ADR を表示:
/adr view 5
コメント
Markdown 対応