ツールのバージョンに結合したスキル・ドキュメントの正本はツール本体のパッケージに同居させ、他配布経路はミラーにする
設計判断
ドキュメント
プラグイン
判断
CLI やライブラリの使い方を AI エージェントに教えるスキル・ドキュメントが、そのツールのバージョンに強く結合している場合(コマンド体系・入出力形式・exit code 契約・語彙などを記述している場合)、正本はツール本体のパッケージ内に置き、リリース時に同じコミットで更新する。プラグインや別リポジトリなど他の配布経路には正本を置かず、リリース済みテンプレートからのミラー同期に限定する。
判断基準
- 文書の記述が「ツールを変えたら必ず一緒に変わる内容」なら正本はツール側。ツールと独立に変わる内容(組織の運用ルール、プロジェクト固有の文脈)なら別置きでよい。
- ツールが公開パッケージなら、スキルをツール側から自己設置コマンド等で提供することで、私的なプラグインを入れていない利用者にも届く。配布範囲の広い側に正本を置く。
- 逆向き(プラグイン側を正本にしてツールへ反映)は、ツール変更のたびに別リポジトリへの反映を人が思い出す必要があり、同期漏れが起きやすい。ツール→ミラーの一方向だけにする。
- バージョン不一致(古いツール + 新しいミラー文書)は起こりうる前提で、文書側に「記載コマンドが無ければ古いバージョン。明示バージョン指定で実行するか更新する」というフォールバック文言を仕込む。
なぜ
文書とツールの整合はリリース単位でしか保証できない。同じリポジトリ・同じコミットで更新される配置なら、レビューと CI が整合を自然に守る。分離した正本は「動くが文書が古い」状態を検出する機構がない。
検証
ツールの機能追加 PR に文書更新が同梱されているかをレビュー観点にする。ミラー側は同期元バージョンをコミットメッセージ等に記録し、diff が description・本文とも同期元と一致することを確認する。