documenting-decisions について
コード内の重要な開発上の判断を記録し、レビュー用にまとめるスキルです。開発者やコーディングエージェントが、レビュー対象の判断と通常の変更を区別し、ADRやチケットへの反映を進められます。
主な機能
- 016種類の判断タグ
- 02PR向け判断ログの作成
- 03ADRの追加対応ガイド
- 04完了後のチケット反映
- 05差分ハンクの分類モード
活用シーン
- 01アーキテクチャやインターフェース変更の記録
- 02セキュリティや不可逆な変更の要約
- 03判断カテゴリ別の差分レビュー
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ pandoscope/ skills --skill documenting-decisionsインストール後、Claude Code で/documenting-decisionsを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
README.mdreferences/canary-signals.mddecision-markers.mdirreversible-operations.mdmarker-examples.mdpre-approval-gate.mdscope-interpretation.mdsecurity-protocol.md詳細
意思決定の記録
チェックポイントタグ
| タグ | 記録するタイミング |
|---|---|
ARCH | 新しい抽象化、依存関係、データモデル、コンポーネントの境界など、長期的な構造を形作るもの。 |
SCOPE | タスクの曖昧さを解消するために、解釈を選択した場合。 |
IFACE | 公開 API、設定スキーマ、CLI フラグ、環境変数、ワイヤ形式を変更した場合。 |
SEC | 認証、暗号化、権限、ネットワークへの公開、入力検証に触れた場合。 |
IRREV | マイグレーション、データ削除、デプロイのトリガー、外部への副作用を作成した場合。 |
NOVEL | 従うべき既存のリポジトリパターンがなく、学習データから推測して補った場合。 |
定型的な変更(既存パターンに従った変更、ボイラープレート、リファクタリング)には記録しないでください。
形式
このスキルの references/ にある decision-markers.md と、必要に応じて marker-examples.md を参照してください。
タスク完了後
変更したファイル内のマーカーから意思決定ログを生成し、PR の説明に追加してください。
## Decisions requiring review
- **TAG** `file:line` — explanation
## Routine (skip review)
[One-line summary]
ARCH または IRREV マーカーが writing-adrs の基準(元に戻すのが難しい、背景を知らないと意外に感じる、実質的なトレードオフの結果である)を満たす場合は、そのスキルに従って ADR も作成してください。
駆動元のチケットとの整合
チケットに基づく作業の場合、クローズする前にチケットを更新してください。逸脱、中盤で追加されたスコープ、上記の意思決定(またはそれらの ADR/用語集への参照)を反映します。to-tickets の再現性に関する不変条件に従い、課題のストリームを再生すると初稿ではなく最終状態が構築されるようにしてください。
差分分類モード
ユーザーから差分のレビューを依頼された場合は、各ハンクを6つのタグのいずれか、または ROUTINE に分類してください。行範囲を付けて File: path — TAG 形式で提示してください。
参照ファイル
references/canary-signals.md— 自動チェックポイント検出用の CI スクリプト(リポジトリのセットアップ用であり、ランタイム用ではありません)。references/marker-examples.md— 複数の言語によるマーカーの例。references/内のその他のファイルは、AGENTS.md で明示的に言及されている場合、またはユーザーから求められた場合にのみ関係します。
コメント
Markdown 対応