documentation

ドキュメント

概要

このスキルは、Documentation エージェントが使用する共通のドキュメント機能を提供します。 監査、ドリフト、検証、作成の各フローに必要な永続的な知識を単一のパッケージに集約することで、薄いラッパーが機能の説明をインラインで埋め込まず、モード固有のガイダンスを読み込めるようにします。

モードマップ

Documentation エージェントは、モードに応じて関連するスキルセクションを読み込む必要があります。

モード	主な読み込み対象	備考
audit	references/conventions.md、references/coverage-method.md、references/validation-toolchain.md、references/content-sensitivity.md	以前の Doc Ops ワークフローを、スキル主導の監査ループに置き換えます。
drift	references/conventions.md、references/code-doc-mapping.md、references/content-sensitivity.md	リポジトリ内のマッピング表とドリフトのヒューリスティクスを使用します。
validate	references/validation-toolchain.md、references/accessibility-checks.md、references/content-sensitivity.md、references/rai-guardrails.md	ドキュメントの検証を実行し、必要に応じて正式なレビューにエスカレーションします。
author	templates/guide.md、templates/reference.md、references/conventions.md、references/accessibility-checks.md、references/content-sensitivity.md、references/rai-guardrails.md	リポジトリに記載された規約に沿って、説明文書またはリファレンス文書を作成します。

成功基準

audit モードと validate モードでは、該当するローカルで安全に実行できるすべてのチェックの結果を記録し、既存の CI ステータスは別途記録してください。実行されなかった CI 管理のチェックは、それぞれ Pending CI、Skipped、Deferred、または Unavailable として扱い、Passed と報告しないでください。

対象外

このスキルでは、ADR、BRD、PRD、その他の計画成果物は作成しません。 また、アクセシビリティ、RAI、セキュリティ基準のロジックをインラインで埋め込まず、専用のリファレンスファイルを参照し、シナリオに応じて正式な評価を適切なプランナーに委ねます。

作業規約

• 重複する説明よりも、既存のリポジトリの指示やスクリプトを優先してください。
• audit モードと validate モードでは、ローカルで安全に実行できるチェックをデフォルトで実行し、既存の CI ステータスは別途要約してください。タスクで指定された CI 管理のレーンを再現するよう明確に求められた場合に限り、そのレーンをローカルで実行してください。
• ブラウザーのインストール、モデルまたはモデレーション環境、サービス、認証情報、対話型 UI は、自動的な失敗回復の対象ではなく、個別の前提条件として扱ってください。
• ドキュメントの変更は事実に基づき、現在のタスクの範囲内にとどめてください。
• モード固有の手法、ヒューリスティクス、チェックリストには、以下のリファレンスファイルを使用してください。
• 専門家による評価が必要な場合は、正式なアクセシビリティ、RAI、またはセキュリティレビューのためにプランナーへエスカレーションしてください。

停止ルール

audit モードと validate モードでは、ローカルで安全に実行できるチェックの結果と、別途得られた CI の証拠を記録したら停止してください。専門的なセットアップや必要な CI の証拠が不足している場合は、別途報告してください。推測したり、自動で用意したり、合格として報告したりしないでください。

セッションの追跡

標準的なセッションファイルの規約に従い、実行ごとに .copilot-tracking/documentation/ に {{YYYY-MM-DD}}-session.md ファイルを使用してセッション状態を記録してください。

参考ファイル

• references/conventions.md — リポジトリの Markdown、文体、Docusaurus の規約をまとめています。
• references/code-doc-mapping.md — コードとドキュメントの対応表、および差分を検出するためのヒューリスティックです。
• references/coverage-method.md — 監査モードでのギャップ分析と網羅性分析の方法です。
• references/validation-toolchain.md — 検証コマンドの一覧と結果の解釈です。
• references/accessibility-checks.md — インラインドキュメントのチェック項目と引き継ぎの基準です。
• references/content-sensitivity.md — 公開前の個人情報、シークレット、機密性、AI 開示に関するチェック項目です。
• references/rai-guardrails.md — インジェクション境界、帰属表示、人的レビュー、免責事項に関するガイダンスです。

テンプレート

• templates/guide.md — 説明形式のガイドとハウツーページの構成テンプレートです。
• templates/reference.md — リファレンスおよび API 形式のドキュメントの構成テンプレートです。