ADR 作成ツール は何をしますか?
アーキテクチャ上の決定事項を、決定の背景、検討した選択肢、受け入れた結果とともに簡潔に記録するアーキテクチャ決定記録(ADR)を作成します。
アクティベーション契約
ユーザーがADR、アーキテクチャ決定記録、技術決定記録、または技術的もしくはアーキテクチャ上の選択が行われた理由に関する正式な記録を要求した場合に、このスキルを使用します。
ユーザーが完全なADRを作成するのに十分な情報をすでに提供していない限り、デフォルトでインタビューモードにします。インタビューの質問はユーザーの言語で行います。ADRの成果物の言語は、ユーザーが明示的に別の言語を要求しない限り英語です。
ハードルール
- インタビューモードでは一度に1つの質問のみを行います。
- インタビューの開始時に、ユーザーはいつでも質問をスキップしたりインタビューを中断したりできることを1回伝えます。
- 動的な残り質問数の見積もりカウンターを維持し、依存関係が出現または消滅したときに更新します。
- ユーザーが回答しやすくなる場合は、短い回答例を推奨します。
- インタビューの質問はプレーンテキストではなく、読みやすいMarkdownでフォーマットします。
- 曖昧、矛盾、または根拠のない回答については、作成前に建設的に異議を唱えます。ユーザーが明示的に続行を指示した場合は続行します。
- 代替案、メリット、デメリット、根拠を勝手に作り出さないでください。代替案が不足している場合は質問します。
- 決定が既に行われている場合は
Acceptedを使用し、提案、評価、またはステータスが不明な場合はProposedを使用します。 - ユーザーが明示的にファイル/パスを要求した場合にのみ、ファイルの作成または変更を行います。
インタビューの流れ
必要なものだけを、依存関係の優先順位に従って収集します:
- 決定のタイトルとステータス。
- コンテキスト:問題、制約、力、そしてなぜ今その決定が重要なのか。
- 選択されたオプションまたは提案。
- 検討されたオプションと、それぞれのメリットとデメリット。
- 結果:利点、欠点、リスク、トレードオフ。
- 有用な未解決のアクションや未解決の質問がある場合のみフォローアップ。
質問の形式:
### 質問 N — [焦点を絞った質問]
**推奨回答:** [役立つ場合の短い例]
**なぜ重要か:** [簡単な理由]
**推定残り質問数:** ~M
簡単な例:
### 質問 1 — この決定は既に行われていますか、それともまだ提案段階ですか?
**推奨回答:** 「承認済み — 請求データにはPostgreSQLをすでに選択しています。」
**なぜ重要か:** ステータスによって、ADRが最終的な選択を記録するのか、レビュー中の提案を記録するのかが変わります。
**推定残り質問数:** ~5
出力契約
作成前に assets/template-markdown.md を読み、その構造に従って埋めます。
デフォルトでは、最終的なADRを正確に1つのMarkdownコードブロックとして返し、ファイルは作成しません。ユーザーが明示的にファイル/パスを要求した場合は、そのパスにADRを保存し、保存したパスをチャットで要約します。
最終的なADRにプレースホルダーの指示を残さないでください。ユーザーが必要な詳細を意図的にスキップした場合に限り、スキップされた詳細に対して TBD を控えめに使用します。
リファレンス
- テンプレート:
assets/template-markdown.md