コンテンツへスキップ
Documentation Audit

Documentation Audit

2パス抽出とパターン拡張を使って、ドキュメントのクレームを実際のコードベースに対して検証。

GitHub ← 全プロダクト

ドキュメントは一方を言い、コードは別のことをする。Documentation Audit は Claude Code プラグインで、マークダウンファイルからすべての検証可能なクレームを抽出し、コードベースに対してひとつひとつ確認します。存在しないファイルへの参照、誤ったデフォルト値、不足している環境変数、古くなった CLI フラグを検出し、手作業では見落とすパターンを表面化するために発見内容を拡張します。

インストール

/plugin install documentation-audit@2389-research

その後、「audit docs」、「verify documentation」、「check if docs are accurate」で呼び出してください。

機能

プラグインはプロジェクトのユーザー向けドキュメントに対して2パス監査を実行します。

パス1: 直接抽出。 各マークダウンファイルをスキャンしてクレームを抽出します — ファイルパス、設定のデフォルト値、環境変数、CLI コマンド、動作に関する記述。各クレームをコードベースに対して検証し、TRUE、FALSE、または NEEDS_REVIEW の評決を付けます。抽出は並列実行されます(ドキュメントごとに1エージェント)のでドキュメント量が多くてもボトルネックになりません。

パス2A: パターン拡張。 パス1で偽と判定されたクレームをタイプ別にグループ化します。プラグインはすべてのドキュメントで類似パターンを検索します。存在しないスクリプト参照が1つ見つかれば、すべてのスクリプト参照を探します。タイマーの間隔が1つ間違っていれば、すべての間隔クレームを確認します。この2番目のパスは1回のスキャンで見落とす問題をさらに10〜20%検出します。

パス2B: ギャップ検出。 コードベースに実際にあるものとドキュメント化されているものを比較します。存在するが記載されていないスクリプトと、削除されたファイルを参照しているドキュメントを見つけます。

クレームタイプと検証レベル:

  • 自動検証: ファイル参照、設定のデフォルト値、環境変数、CLI フラグ
  • 半自動: シンボル参照、バージョン要件
  • 人間によるレビュー: 動作に関するクレーム(「2分ごとに実行」)、制約

仕組み

プラグインは隔離された Plan エージェントコンテキスト内で実行され、抽出アーティファクトをメイン会話から分離します。各ドキュメントは抽出用の並列 Task エージェントを得ます。結果は docs/audits/AUDIT_REPORT_YYYY-MM-DD.md に単一の監査レポートとして集約されます。

レポートには精度率を含むエグゼクティブサマリー、行番号と修正提案付きの偽クレーム一覧、根本原因を示すパターン分析(例:「同じリファクタリングに由来する9つの存在しないスクリプト」)、自動検証できないクレームの人間レビューキューが含まれます。

必要要件

  • プラグインサポートを持つ Claude Code
  • 監査するマークダウンドキュメントを含むプロジェクト
GitHub で見る →
31 ページ · hugo 0.148.2 · 1ee4278 · 構築済み Aug 10 22:58
2389 Radio
2389 RADIO ステーションを選択