jpskill.com
✍️ ライティング コミュニティ

doc-consistency-reviewer

コードの実装とドキュメントの内容が一致しているかをチェックし、READMEやAPIドキュメントの正確性を検証して、過不足なく最新の状態に保つことを支援するSkill。

📜 元の英語説明(参考)

文档一致性审核官，检查代码实现与文档说明的一致性。当用户请求审查文档与代码的一致性、检查 README/docs 是否过时、验证 API 文档准确性时使用此技能。适用于：(1) 审查 README 与实现一致性 (2) 检查 docs/ 目录文档是否过时 (3) 验证 API/配置文档准确性 (4) 生成文档一致性报告。触发词包括：文档审查、doc review、文档一致性、documentation consistency、检查文档过时、verify docs。

🇯🇵 日本人クリエイター向け解説

一言でいうと

コードの実装とドキュメントの内容が一致しているかをチェックし、READMEやAPIドキュメントの正確性を検証して、過不足なく最新の状態に保つことを支援するSkill。

※ jpskill.com 編集部が日本のビジネス現場向けに補足した解説です。Skill本体の挙動とは独立した参考情報です。

⚡ おすすめ: コマンド1行でインストール(60秒)

下記のコマンドをコピーしてターミナル(Mac/Linux)または PowerShell(Windows)に貼り付けてください。 ダウンロード → 解凍 → 配置まで全自動。

🍎 Mac / 🐧 Linux 
mkdir -p ~/.claude/skills && cd ~/.claude/skills && curl -L -o doc-consistency-reviewer.zip https://jpskill.com/download/19227.zip && unzip -o doc-consistency-reviewer.zip && rm doc-consistency-reviewer.zip
🪟 Windows (PowerShell) 
$d = "$env:USERPROFILE\.claude\skills"; ni -Force -ItemType Directory $d | Out-Null; iwr https://jpskill.com/download/19227.zip -OutFile "$d\doc-consistency-reviewer.zip"; Expand-Archive "$d\doc-consistency-reviewer.zip" -DestinationPath $d -Force; ri "$d\doc-consistency-reviewer.zip"

完了後、Claude Code を再起動 → 普通に「動画プロンプト作って」のように話しかけるだけで自動発動します。

💾 手動でダウンロードしたい(コマンドが難しい人向け)
  1. 1. 下の青いボタンを押して doc-consistency-reviewer.zip をダウンロード
  2. 2. ZIPファイルをダブルクリックで解凍 → doc-consistency-reviewer フォルダができる
  3. 3. そのフォルダを C:\Users\あなたの名前\.claude\skills\(Win)または ~/.claude/skills/(Mac)へ移動
  4. 4. Claude Code を再起動
⬇ .zip でダウンロード(推奨) ⬇ .skill 形式(上級者用) 元のソース ↗

⚠️ ダウンロード・利用は自己責任でお願いします。当サイトは内容・動作・安全性について責任を負いません。

🎯 このSkillでできること

下記の説明文を読むと、このSkillがあなたに何をしてくれるかが分かります。Claudeにこの分野の依頼をすると、自動で発動します。

📦 インストール方法 (3ステップ)

  1. 1. 上の「ダウンロード」ボタンを押して .skill ファイルを取得
  2. 2. ファイル名の拡張子を .skill から .zip に変えて展開(macは自動展開可)
  3. 3. 展開してできたフォルダを、ホームフォルダの .claude/skills/ に置く
    • · macOS / Linux: ~/.claude/skills/
    • · Windows: %USERPROFILE%\.claude\skills\

Claude Code を再起動すれば完了。「このSkillを使って…」と話しかけなくても、関連する依頼で自動的に呼び出されます。

詳しい使い方ガイドを見る →
最終更新
2026-05-18
取得日時
2026-05-18
同梱ファイル
3

📖 Skill本文(日本語訳)

※ 原文(英語/中国語)を Gemini で日本語化したものです。Claude 自身は原文を読みます。誤訳がある場合は原文をご確認ください。

ドキュメント整合性レビュー担当者

目標

README + docs/ 内の「古くなった」または「実装と一致しない」記述を体系的に特定し、30項目以上の問題を出力します。

核心原則

  1. コードを真とする - ドキュメントとコードが衝突する場合、ソースコード/設定/契約ファイルを正とします。
  2. 証拠に基づいて結論を出す - 各問題は、コード/設定の場所を根拠として引用する必要があります。
  3. 契約優先 - OpenAPI/proto/schema/TS types を SSOT と見なします。
  4. セキュリティはデフォルトで厳しく - セキュリティ関連の不整合は、優先的に高重大度としてマークします。

レビュープロセス

1. ドキュメント列挙

# スキャン範囲
- README.md (ルートディレクトリ)
- docs/**/*.md (すべてのドキュメント)
- 契約ファイル: OpenAPI/proto/GraphQL schema/TS types

2. ドキュメントごとのレビュー

各ドキュメントについて：

  1. 主要な宣言/コミットメント/設定/インターフェース項目をリストアップします。
  2. コード内で対応する実装を検索します。
  3. 差異を比較します：欠落/名前変更/動作の不整合/デフォルト値の不整合
  4. テンプレートに従って問題項目を記録します。

3. 横断的なクロスチェック

  • 契約ファイルからドキュメントを逆チェックします。
  • 設定ファイルからドキュメントを逆チェックします。

詳細なチェックリストは references/checklist.md を参照してください。

重大度レベル

レベル 定義 例
P0 セキュリティ問題/深刻な誤解 ドキュメントではサンドボックスが有効とされているが、コードでは有効になっていない
P1 コア機能の不整合 ドキュメント通りに操作すると失敗する
P2 サンプルが不完全/命名の不整合 使用を直接妨げない
P3 文言/書式/リンクの軽微な問題 機能に影響しない
証拠補充待ち 疑いがあるが証拠が不十分 さらなる調査が必要

出力形式

詳細なテンプレートは references/output-format.md を参照してください。

個々の問題項目

### [タイトル]
- **重大度レベル**: P0/P1/P2/P3/証拠補充待ち
- **場所**: `<ファイルパス>:<行番号>`
- **証拠**:
  - ドキュメント: [引用]
  - コード: [引用]
- **影響**: [誤解の結末]
- **提案**: [最小限の修正]
- **関連原則**: コードを真とする/契約優先/セキュリティはデフォルトで厳しく/...

レビュー結論

## レビュー結論
- **結論**: 合格/条件付き合格/不合格
- **要約**: P0:x P1:x P2:x P3:x 補充待ち:x
- **修正優先順位**: P0 → P1 → P2 → P3

マルチエージェント並列実行

高速化が必要な場合は、以下の次元で複数のエージェントに分割して並列実行できます。

  1. ドキュメントタイプ別分割 - README、API ドキュメント、開発ガイドにそれぞれ1つのエージェント
  2. モジュール別分割 - 異なる機能モジュールのドキュメントにそれぞれ1つのエージェント
  3. チェック方向別分割 - ドキュメントからコードをチェックするエージェントと、コードからドキュメントをチェックするエージェント

集約時には、重複排除と重大度レベルの統一が必要です。

実行

レビュー完了後、doc-consistency.md レポートファイルを出力します。

📜 原文 SKILL.md(Claudeが読む英語/中国語)を展開

Documentation Consistency Reviewer

目标

系统性找出 README + docs/ 中所有「过时」或「与实现不一致」的描述，输出 ≥30 条问题项。

核心原则

  1. 以代码为真 - 文档与代码冲突时，以源码/配置/合同文件为准
  2. 有证据再下结论 - 每条问题必须引用代码/配置位置作为依据
  3. 合同优先 - OpenAPI/proto/schema/TS types 视为 SSOT
  4. 安全默认收紧 - 安全相关不一致优先标记为高严重级别

审核流程

1. 文档枚举

# 扫描范围
- README.md (根目录)
- docs/**/*.md (所有文档)
- 合同文件: OpenAPI/proto/GraphQL schema/TS types

2. 逐文档审阅

对每份文档：

  1. 列出关键声明/承诺/配置/接口条目
  2. 在代码中搜索对应实现
  3. 对比差异：缺失/重命名/行为不一致/默认值不一致
  4. 按模板记录问题项

3. 横向交叉检查

  • 从合同文件反向检查文档
  • 从配置文件反查文档

详细检查清单见 references/checklist.md

严重级别

级别 定义 示例
P0 安全问题/严重误导 文档称已启用沙箱但代码未启用
P1 核心功能不一致 按文档操作会失败
P2 示例不完整/命名不一致 不直接阻断使用
P3 措辞/格式/链接小问题 不影响功能
待证据补充 有怀疑但证据不足 需进一步调查

输出格式

详细模板见 references/output-format.md

单个问题项

### [标题]
- **严重级别**: P0/P1/P2/P3/待证据补充
- **位置**: `<文件路径>:<行号>`
- **证据**:
  - 文档: [引用]
  - 代码: [引用]
- **影响**: [误导后果]
- **建议**: [最小修正]
- **关联原则**: 以代码为真/合同优先/安全默认收紧/...

审核结论

## 审核结论
- **结论**: 通过/有条件通过/不通过
- **汇总**: P0:x P1:x P2:x P3:x 待补充:x
- **修复优先级**: P0 → P1 → P2 → P3

多 Agent 并行

如需加速，可按以下维度拆分给多个 agent 并行执行：

  1. 按文档类型拆分 - README、API 文档、开发指南各一个 agent
  2. 按模块拆分 - 不同功能模块的文档各一个 agent
  3. 按检查方向拆分 - 一个从文档查代码，一个从代码查文档

汇总时需去重和统一严重级别。

执行

审阅完成后，输出 doc-consistency.md 报告文件。

同梱ファイル

※ ZIPに含まれるファイル一覧。`SKILL.md` 本体に加え、参考資料・サンプル・スクリプトが入っている場合があります。