技能 documentation-audit
🔍
ドキュメントの乖離は混乱やバグの原因となります。このスキルは、パターン展開を伴う2パスアプローチを使用して、実際のコードベースに対してマークダウンドキュメント内の主張を体系的に検証し、類似の問題を検出します。
支援: Claude Codex Code(CC)
1
下載技能 ZIP
2
在 Claude 中上傳
前往 設定 → 功能 → 技能 → 上傳技能
3
開啟並開始使用
測試它
正在使用「documentation-audit」。 docs/内のドキュメントファイルの正確性を監査してください
預期結果:
- ドキュメント監査レポート - 生成日：2026-01-10
- エグゼクティブサマリー：12のドキュメントをスキャン、約180の主張を検証
- 検証済みTRUE：145件の主張（81%）
- 検証済みFALSE：31件の主張（17%）- 修正が必要
- 虚偽の主張 - CONFIGURATION.md:135 - 'claude-sonnet-4-5'は'claude-3-5-sonnet-latest'であるべきです
- 検出されたパターン：4つのファイルにわたる9件の無効なスクリプト参照
- 人間のレビューキュー：検証が必要な4件行動主張
安全審計
低風險v3 • 1/10/2026
Prompt-based skill using Plan agent for documentation verification. Operates through read-only filesystem operations and claim extraction without executing code or making network calls. No malicious patterns detected.
3
已掃描檔案
167
分析行數
2
發現項
3
審計總數
風險因素
📁 檔案系統存取 (3)
⚙️ 外部命令 (2)
審計者: claude 查看審計歷史 →
品質評分
38
架構
100
可維護性
81
內容
23
社群
90
安全
78
規範符合性
你能建構什麼
リリース前の検証
デプロイやリリース前に、すべてのドキュメントが正確であることを確認します
リファクタリング後のチェック
ファイルやサービスのリファクタリングや名前変更後にドキュメントの乖離を検出します
ドキュメント監査
ドキュメントを体系的にスキャンして、古い参照や時代遅れの主張を見つけます
試試這些提示
簡易監査
これらのドキュメントファイルの正確性を監査してください：[list files]
プロジェクト全体のスキャン
このプロジェクトのドキュメント監査を完了してください。ユーザー向けドキュメントのみに焦点を当てます。
リファクタリングチェック
最近のリファクタリング後にドキュメントが実態と一致するか確認してください。無効なスクリプト参照、名前変更されたサービス、時代遅れの設定デフォルトを探します。
パターンの検索
無効なスクリプト参照を見つけました。すべてのドキュメントで類似のパターンを検索し、それぞれを確認してください。
最佳實務
- 抽出に並列エージェントを使用して、複数のドキュメントで効率を最大化してください
- 常にパス2のパターン展開を実行してください - さらに10〜20%多くの問題を検出できます
- すべての判定に対して証拠（ファイル:行番号）を記録して、推奨される修正をサポートしてください
避免
- パス2のパターン展開をスキップすると、問題の検出が大幅に減少します
- 検証せずにドキュメントが「正しく見える」と信頼すると、隠れた乖離が発生します
- 設計ドキュメントや計画を監査するのではなく、ユーザー向けドキュメントを監査すると努力が無駄になります
常見問題
このスキルはどのような主張タイプを自動的に検証できますか？
ファイルパス、設定のデフォルト値、環境変数、CLIフラグは自動的に検証されます。行動に関する主張は人間のレビューが必要です。
このスキルはドキュメントファイルを変更しますか？
いいえ。このスキルはドキュメントのみを読み取り、監査レポートを生成します。ソースファイルを変更することは決してありません。
パス2のパターン展開とは何ですか？
虚偽の主張を見つけた後、このスキルは同様のパターンをすべてのドキュメントで検索して、最初のスキャンで見逃した問題を検出します。
完全な監査には多长时间かかりますか？
コードベースのサイズによって異なります。10〜20のドキュメントを持つ典型的なプロジェクトは、並列抽出を使用すると5〜10分で完了します。
CI/CDパイプラインに統合できますか？
直接的にはできません。リリース前に手動で実行するか、スキルを呼び出して生成された監査レポートを解析するスクリプトを使用してください。
リンティングや静的解析とどう異なりますか？
リンティングはコードの品質をチェックします。このスキルは、ドキュメントがコードベースの動作を正確に説明しているかを検証します。
開發者詳情
授權
MIT
引用
main
檔案結構