Documentation Review(ドキュメントレビュー)
SkillDocs & knowledgeDocumentation-focused review agent. Verifies consistency between README / docs / AGENTS.md and the implementation, correspondence between API docs and code, accuracy of usage and examples, i18n (JA/EN) consistency, and terminology unification.
Use Documentation Review(ドキュメントレビュー) in Claude, ChatGPT or Ahel Desktop
Free. Sign in, add Documentation Review(ドキュメントレビュー) and connect your AI. About a minute.
Also: Claude Code · Cursor · Codex
Then ask your AI: use the Documentation Review(ドキュメントレビュー) skill
Details
Instructions available. Your AI can read the instructions. Execution depends on the setup they require.
Account requirements not reviewed. Check the skill instructions before use; Ahel provides instructions and does not run this skill.
No other account needed.
Add Ahel to your AI once: Claude, ChatGPT, Cursor, Claude Code or Codex. Then ask it to use this.
What this skill tells your AI
The instructions your AI receives, as published by hashgraph-online/awesome-codex-plugins in plugins/s977043/river-review/skills/agent-skills/river-review-docs/SKILL.md and read by Ahel’s review.
ドキュメントと実装の整合性、翻訳パリティ、用語統一を検証する。
When to Use / いつ使うか
- README / docs / AGENTS.md / ガイドの変更時
- コードの公開インターフェース(CLI フラグ、API、設定キー)が変わったが、対応するドキュメントが更新されていない可能性があるとき
- 多言語(JA/EN)ドキュメントの一方のみが更新されたとき
- 用語・命名(プロダクト名、コマンド名など)の揺れが疑われるとき
Review Viewpoints / レビュー観点
- 実装との整合性: ドキュメントが記述するコマンド・フラグ・設定キー・パス・バージョンが、実際のコード(CLI ヘルプ、設定スキーマ、ソース)と一致しているか。古い・誤った記述を検出する。
- API ドキュメントとコードの対応: 公開関数・スキーマ・出力フォーマットの説明が実装と一致しているか。欠落した項目(未文書化のフラグ・コマンド・設定)を検出する。
- usage / 例の正確性: コード例・コマンド例がそのまま実行可能か。存在しないファイル・廃止された手順を参照していないか。
- i18n 整合性: JA/EN のペアで、一方にあるセクション・表・注記が他方に欠落していないか。バージョンピンや手順の食い違いがないか。
- 用語統一: プロダクト名・コマンド名・固有名詞の表記が統一されているか(例: 旧称の残存)。
Output / 出力
他の専門スキルと同じ finding 契約に従って出力する。各 finding には以下を含める。
severity(critical/major/minor/info)/file/line/message(Finding 本文)impact: そのドキュメント不整合が読者・利用者に与える影響fix: 推奨する修正(どのドキュメントをどう直すか)evidence: ドキュメントと実装の不一致では、対応する実装側の根拠(ファイル・行・該当記述)confidence: 確信度(推測が含まれる場合は明示する)
差分に存在しない箇所への推測に基づく指摘は行わない。
Notes / 注意
- 文章スタイル(textlint / markdownlint)の機械的チェックは既存の lint が担うため、本スキルは内容の整合性に集中する。
- 多言語パリティの指摘では、SSoT(通常は JA)を基準に欠落を示す。
- レンダリング文脈を無視したリンク形式の指摘はしない(#1464 / #1493)。
pages/配下から repo 内の非公開領域(skills//docs/など)への絶対 GitHub URL は Docusaurus 配信の制約による意図的選択であり、相対化を提案しない。逆にskills/からdocs/への参照は相対リンクが正典(#1494)。bare#N化は.mdレンダリングで常に非リンク化するため、一律で簡約の提案を禁止する。詳細と canary はdoc-hygieneの「False-positive guards」を参照。 - 観点5(用語統一)で severity の内部語彙とスキーマ語彙を混同しない(#1502)。SKILL.md 内の
blocker/warning/nitと出力スキーマのcritical/major/minorは.claude/rules/review-core.mdが定義する意図的な二層語彙であり、「表記揺れ」として一方への統一を提案しない。詳細と canary はdoc-hygieneの「False-positive guards」を参照。
Signals
- GitHub stars
- 1k
- Forks
- 316
- Last commit
- Oct 2026
Advanced
- Item type
- skill
- Key
river-review-docs- Source
- github.com/hashgraph-online/awesome-codex-plugins
github.com/hashgraph-online/awesome-codex-plugins
More in Docs & knowledge
Skill · mattpocock
More in Docs & knowledgecanvas-design
Skill · anthropics
More in Docs & knowledgedoc-coauthoring
Skill · anthropics
More in Docs & knowledgepopups
Skill · coreyhaines31
More in Docs & knowledgewriting-for-agents
Skill · mattpocock
More in Docs & knowledgespec-driven-development
Skill · addyosmani
More in Docs & knowledge