mcpField
L
ln-600-docs-auditor

ln-600-docs-auditor

github.com/levnikolaevichドキュメント58449 回インストール2 日前に更新
リポジトリ

ln-600-docs-auditor について

ln-600-docs-auditorは、技術スタックを問わずプロジェクト文書の構成、正確性、内容を監査します。階層や重複を確認し、意味内容の検証はln-601に委任します。

主な機能

  1. 01文書階層とリンクの確認
  2. 02単一情報源のレビュー
  3. 03圧縮と形式の確認
  4. 04コードと文書の整合性確認
  5. 05ln-601への意味監査の委任

活用シーン

  1. 01プロジェクトのMarkdown文書監査
  2. 02孤立ページやリンク切れの発見
  3. 03コードに照らした文書記述の確認

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/levnikolaevich/claude-code-skills --skill ln-600-docs-auditor

インストール後、Claude Code で/ln-600-docs-auditorを入力して読み込まれたか確認します。

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

diagram.html
references/
audit_checklist.md
size_limits.md

詳細

パス: ファイルパス(shared/、references/、../ln-*)はスキルリポジトリのルートからの相対パスです。CWD に見つからない場合は、この SKILL.md ディレクトリを探し、1 つ上の階層をリポジトリルートとしてください。

ドキュメント監査

プロジェクトのドキュメント品質を監査します。あらゆる技術スタックで利用できます。

目的

  • 積極的に圧縮する - 価値を維持しながらサイズを削減できる機会をすべて見つけます
  • 意味のない内容、重複する内容、冗長な内容を排除します
  • 散文を構造化形式(表、リスト)に変換します
  • CLAUDE.md をルートとして、ドキュメントの階層を検証します
  • 重複を検出し、Single Source of Truth を徹底します
  • ドキュメントが現在のコードの状態と一致していることを確認します
  • 意味的検証 - ln-601 に委任し、内容が SCOPE およびコードベースの実態と一致するか検証します

呼び出し方法

  • 直接: ドキュメント品質のレビューをユーザーが呼び出します
  • パイプライン: ln-100-documents-pipeline から呼び出されます(Phase 5、auditDocs=true の場合)

ワークフロー

  1. スキャン: プロジェクト内のすべての .md ファイルを検索します(CLAUDE.md、README.md、docs/**)
  2. ツリー構築: CLAUDE.md からの外部リンクを基に階層を構築します
  3. 監査カテゴリ 1~7: 構造チェックを実行します(下記の監査カテゴリを参照)
  4. 意味的監査(カテゴリ 8): 各プロジェクトドキュメントについて、ln-601-semantic-content-auditor に委任します
  5. 採点: 各カテゴリのスコアを X/10 で算出します(ln-601 による意味的スコアを含む)
  6. コンテキスト検証: 検出結果を事後フィルタリングします(下記を参照)
  7. レポート: 検出結果と推奨アクションを出力します
Phase 4:意味的監査の委任

各プロジェクトドキュメントについて(tasks/、reference/、presentation/ を除く):

FOR doc IN [CLAUDE.md, docs/README.md, docs/project/*.md]:
    result = DELEGATE ln-601-semantic-content-auditor {
        doc_path: doc,
        project_root: project_root,
        tech_stack: detected_stack
    }
    semantic_findings.append(result.findings)
    semantic_scores[doc] = result.scores

対象ドキュメント: CLAUDE.md、docs/README.md、docs/documentation_standards.md、docs/principles.md、docs/project/*.md

除外対象: docs/tasks/、docs/reference/、docs/presentation/、tests/

監査カテゴリ

#カテゴリ確認項目
1階層とリンクCLAUDE.md がルートであること、すべてのドキュメントにリンク経由でたどり着けること、孤立ファイルがないこと、リンク切れがないこと
2Single Source of Truth内容が重複していないこと、重複箇所がソースへのリンクに置き換えられていること、明確な管理責任があること
3積極的な圧縮冗長な内容や重複する内容を排除すること、散文を表に変換すること、意味のない情報を削除すること、サイズ制限内のファイルも圧縮すること。size_limits.md を参照してください
4要件への準拠セクションが適切であること、サイズ制限内であること、コードブロックがないこと(表/ASCII 図/テキストのみ)、スタックに適したドキュメントへのリンクがあること
5最新性(重大)コードに照らして事実を検証すること: パスが存在すること、関数が一致していること、API が動作すること、設定が有効であること。古いドキュメントは、ドキュメントがないより悪いものです
6レガシーの整理履歴セクションがないこと、「変更されました」という注記がないこと、非推奨情報がないこと、現在の状態のみが記載されていること
7スタックへの適合リンク/参照がプロジェクトのスタックに一致していること、.NET プロジェクトに Python の例がないこと、正しいプラットフォームの公式ドキュメントが参照されていること
8意味的内容ln-601 に委任: 内容が SCOPE と一致していること、プロジェクトの目標に役立つこと、説明が実際のコードの動作と一致していること、アーキテクチャ/API ドキュメントが実態を反映していること
コンテキスト検証(事後フィルター)

必読: shared/references/context_validation.md を読み込みます

ルール 1 と、ドキュメント固有のインラインフィルターを適用します。

FOR EACH finding WHERE severity IN (HIGH, MEDIUM):
  # Rule 1: ADR/Planned Override
  IF finding matches ADR → advisory "[Planned: ADR-XXX]"

  # Doc-specific: Compression context
  IF Cat 3 (Compression) finding:
    - Skip if path in references/ or templates/ (reference docs = naturally large)
    - Skip if filename contains architecture/design/api_spec
    - Skip if tables+lists > 50% of content (already structured, not verbose prose)

  # Doc-specific: Actuality severity calibration
  IF Cat 5 (Actuality) finding:
    - Path/function COMPLETELY missing → CRITICAL (broken docs)
    - Path exists but deprecated/renamed → HIGH (not CRITICAL)
    - Example code outdated but concept valid → MEDIUM

Downgraded findings → "Advisory Findings" section in report.

出力形式

## Documentation Audit Report - [DATE]

### Compliance Score

| Category | Score | Issues |
|----------|-------|--------|
| Hierarchy & Links | X/10 | N issues found |
| Single Source of Truth | X/10 | N duplications |
| Proactive Compression | X/10 | N compression opportunities |
| Requirements Compliance | X/10 | N violations |
| Actuality | X/10 | N mismatches with code |
| Legacy Cleanup | X/10 | N legacy items |
| Stack Adaptation | X/10 | N stack mismatches |
| Semantic Content | X/10 | N semantic issues (via ln-601) |
| **Overall** | **X/10** | |

### Critical Findings

- [ ] **[Category]** `path/file.md:line` - Issue description. **Action:** Fix suggestion.

### Recommended Actions

| Priority | Action | Location | Category |
|----------|--------|----------|----------|
| High | Remove duplicate section | docs/X.md | SSOT |
| Medium | Add link to CLAUDE.md | docs/Y.md | Hierarchy |

採点アルゴリズム

必読: 統一された採点式について、shared/references/audit_scoring.md を読み込みます。

重大度の対応:

問題の種類重大度
古い内容(コードとの不一致)重大
リンク切れ、孤立したドキュメント高
意味的な不一致(ln-601 による)高
内容の重複中
圧縮機会の見落とし低

参照ファイル

完了の定義

  • プロジェクト内のすべての .md ファイルをスキャンし、CLAUDE.md に基づいて階層ツリーを作成する
  • カテゴリ 1〜7(構造)を監査し、それぞれに X/10 のスコアを付ける
  • カテゴリ 8(意味)を対象ドキュメントごとに ln-601 に委任し、スコアを集める
  • 全体コンプライアンススコア(8 カテゴリの平均)を算出する
  • ファイル名:行番号、カテゴリ、修正案を含む重大な指摘事項を列挙する
  • 優先度、アクション、場所、カテゴリを含む推奨アクションの表を作成する

重要な注意事項

  • ルールではなく内容を修正する: 違反を合格にするために、標準/ルールファイル(_standards.md、_rules.md、*_limits.md)を絶対に変更しないでください。必ず違反しているファイルを修正してください。
  • 事実をコードと照合する: ドキュメントに記載されているすべてのパス、関数名、API、設定を積極的に確認してください。コマンドを実行してください。古いドキュメントは誤解を招き、ドキュメントがないよりも有害です。
  • 常に簡潔にする: サイズ制限は上限であり、目標ではありません。300 行ではなく 100 行のファイルにできれば、それは成果です。常に簡潔にできる箇所を探してください。
  • 意味のない内容: つなぎ言葉、明白な記述、過度な説明を削除してください。価値を加えない内容は削除してください。
  • ドキュメントにコードを記載しない: ドキュメントでは、アルゴリズムを表や ASCII 図で説明します。コードはコードベースに記載します。
    • 禁止: コードブロック、実装スニペット
    • 許可: 表、ASCII 図、Mermaid、メソッドシグネチャ(1 行)
    • コードの代わりに: 「公式ドキュメントを参照」または「src/file.cs:42を参照」
  • 形式の優先順位: 表/ASCII 図 > リスト(列挙のみ) > テキスト(最後の手段)
  • 技術スタックへの適合: ドキュメントの参照先がプロジェクトの技術スタックと一致していることを確認してください。.NET プロジェクトに Python の例が含まれていてはいけません。公式ドキュメントへのリンクが適切なプラットフォームを指していることも確認してください(C# なら Microsoft のドキュメント、JS なら MDN など)。
  • コードが正: ドキュメントとコードが矛盾する場合は、必ずドキュメントを更新してください。ドキュメントに合わせてコードを「修正」してはいけません。
  • 修正後の SSOT 再確認: ドキュメントを変更した後は必ず、その修正によって単一の信頼できる情報源が保たれていることを再確認してください。内容が複数のファイルに存在する場合は、正規の情報源だけに残し、ほかの箇所はその情報源へのリンクに置き換えてください(例:[セクション](path#anchor)を参照)。内容をインラインで重複させず、必ずリンクしてください。正規の情報源の階層:CLAUDE.md → docs/README.md → docs/project/.md → docs/reference/.md。
  • アーカイブせず削除する: 古い内容は「archive」に移さず、削除してください。
  • 履歴を記載しない: ドキュメントには現在の状態のみを記載し、履歴は git で管理します。

バージョン: 4.0.0 最終更新日: 2026-01-28

コメント