decision-doc-sync について
decision-doc-syncは、構造上の決定やコード変更に合わせてプロジェクト文書を整えるスキルです。変更の種類に応じて既存文書やADRを選び、事実の重複を避けながら決定を記録します。
主な機能
- 01構造上の決定の分類
- 02変更内容と文書の対応付け
- 03既存文書のみ更新
- 04長期的な決定をADRに記録
- 05実装と文書の照合
活用シーン
- 01アーキテクチャ変更の記録
- 02UIやUX規約の更新
- 03ワークフローやスクリプト規約の記録
- 04横断的な変更後の文書確認
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ c3sc0-v4113/ scaffold --skill decision-doc-syncインストール後、Claude Code で/decision-doc-syncを入力して読み込まれたか確認します。
同梱ファイルreferences/doc-map.md
詳細
意思決定ドキュメントの同期
適用条件
変更によって、アーキテクチャ、UI/UX 標準、スクリプトや品質ゲート、または複数の領域にまたがる規約などの構造的な意思決定が導入または変更される場合に、このスキルを読み込みます。
厳守事項
- 編集する前に、どのドキュメントが存在するかを確認します。存在するドキュメントのみを更新し、以下のルールで必要とされる場合に限り、新しいドキュメントを作成します。
- 各事実は1つのドキュメントに記載し、重複させる代わりに、ほかのドキュメントからリンクします。
- 変更履歴ではなく、意思決定そのものを記録します。
- 変更後に、ドキュメントの記述がコードと矛盾した状態を決して残しません。
意思決定の判断基準
| 変更の種類 | ドキュメント |
|---|---|
| アーキテクチャ、フォルダー構成、スクリプト | README.md |
| ビジュアルまたは UX の標準、トークン、コンポーネントの使用方法 | DESIGN.md |
| エージェントのワークフロー、コマンド、運用ガイダンス | AGENTS.md |
| 選択肢と結果を含む長期的な意思決定 | docs/adr/ に新しい記録を作成 |
実行手順
README.md、DESIGN.md、AGENTS.md、docs/adr/のうち、どれが存在するかを確認します。- 上の表に従って変更を分類します。1つの変更が複数の行に該当する場合もあります。
- 影響を受ける各ドキュメントのうち、存在するものを更新します。
- ADR については、
docs/adr/の既存の番号付けと形式に従います。references/doc-map.md を参照してください。 - 編集したセクションをコードと照らし合わせて再確認します。
出力条件
更新、作成、または意図的に更新を見送ったすべてのドキュメントを、それぞれ1行の理由とともに列挙します。
参考資料
- references/doc-map.md — ADR の形式と例外事項。
コメント
Markdown 対応