AGENT SKILL

river-review-docs

ドキュメント観点のレビューエージェント。 README / docs / AGENTS.md と実装の整合性、API ドキュメントとコードの対応、 usage や例の正確性、i18n(JA/EN)整合性、用語統一を検証する。

License 许可
MIT
最近更新
2026-11-13
Stars
★ 1.6k
Forks
483

01 前言 Front Matter

id
river-review-docs
name
river-review-docs
tags
[ "docs", "documentation", "i18n" ]
phase
[ "midstream" ]
applyTo
[ "**/*.md", "**/*.mdx", "README*", "AGENTS.md", "docs/**/*", "pages/**/*" ]
license
MIT
version
0.1.0
category
midstream
severity
minor
outputKind
[ "findings", "actions" ]
description
ドキュメント観点のレビューエージェント。 README / docs / AGENTS.md と実装の整合性、API ドキュメントとコードの対応、 usage や例の正確性、i18n(JA/EN)整合性、用語統一を検証する。
inputContext
[ "diff", "fullFile" ]

02 资源文件 1

03 SKILL.md 正文

Documentation Review(ドキュメントレビュー)

ドキュメントと実装の整合性、翻訳パリティ、用語統一を検証する。

When to Use / いつ使うか

  • README / docs / AGENTS.md / ガイドの変更時
  • コードの公開インターフェース(CLI フラグ、API、設定キー)が変わったが、対応するドキュメントが更新されていない可能性があるとき
  • 多言語(JA/EN)ドキュメントの一方のみが更新されたとき
  • 用語・命名(プロダクト名、コマンド名など)の揺れが疑われるとき

Review Viewpoints / レビュー観点

  1. 実装との整合性: ドキュメントが記述するコマンド・フラグ・設定キー・パス・バージョンが、実際のコード(CLI ヘルプ、設定スキーマ、ソース)と一致しているか。古い・誤った記述を検出する。
  2. API ドキュメントとコードの対応: 公開関数・スキーマ・出力フォーマットの説明が実装と一致しているか。欠落した項目(未文書化のフラグ・コマンド・設定)を検出する。
  3. usage / 例の正確性: コード例・コマンド例がそのまま実行可能か。存在しないファイル・廃止された手順を参照していないか。
  4. i18n 整合性: JA/EN のペアで、一方にあるセクション・表・注記が他方に欠落していないか。バージョンピンや手順の食い違いがないか。
  5. 用語統一: プロダクト名・コマンド名・固有名詞の表記が統一されているか(例: 旧称の残存)。

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」を参照。

04 同仓库更多 Skills

hashgraph-online
hashgraph-online/awesome-codex-plugins

migrate-to-e2e

Moves an existing Playwright, Cypress, Selenium, Appium, Detox, Maestro, or TesterArmy suite to e2e one slice at a time, with the old suite running beside the new one until each ported test is proven. Keeps a MIGRATION.md progress file so any later session resumes where the last stopped. Optionally plants a defect to show both suites catch it. Use for /migrate-to-e2e, "migrate our tests to e2e", "port these Maestro flows", "move our TesterArmy tests", or when a project has an e2e config and an older suite still running.

★ 1.6k
hashgraph-online
hashgraph-online/awesome-codex-plugins

e2e

Writes, runs, and debugs end-to-end tests for web and mobile apps with e2e, the agentic test runner, which mixes agent.act goals with exact locator assertions on a Playwright browser or an iOS or Android device. Also drives a project's running app live over the e2e MCP server to look at a screen, check a UI change, take a screenshot or record a video, and try a locator; and runs bug bashes, parallel e2e explore runs with each bug proven by a repro test. Use when a project depends on e2e or has an e2e.config.ts, when asked for end-to-end, browser, mobile, or agentic UI tests, to check a change in the running app, to QA or bug bash an app or branch, or when an e2e run fails.

★ 1.6k
hashgraph-online
hashgraph-online/awesome-codex-plugins

create-verification-skill

Generate a project-local verify-<app> skill on top of e2e, so any coding agent can launch the app, check it is worth driving, exercise a feature the way a user does, keep evidence, and bug bash it. Writes the skill, a feature map with one explore charter per feature, and proves it once. Use for /create-verification-skill, "make a verification skill for this repo", or when a project has no scripted way to prove UI behavior.

★ 1.6k
hashgraph-online
hashgraph-online/awesome-codex-plugins

deja-search

deja-vu memory — search the user's past AI coding sessions with the deja CLI. Holds what they already settled and never wrote into the repo (naming rules, banned or already-tried tools, required checks before merge, preferred values, who owns what). Use before your first edit in a task, before you call a change done or ready to merge, before you recommend a tool, library, design or reviewer, before re-debugging an error that may already be solved, when they say 'didn't we fix this before', 'what did we decide about X' or 'I already have that', and before telling them something on this machine does not exist.

★ 1.6k
hashgraph-online
hashgraph-online/awesome-codex-plugins

deja-reflect

End-of-session reflection and memory curation with deja-vu. Review what was decided, what commands broke and what repaired them, and record durable project rules or decisions with deja remember so the next session starts with them.

★ 1.6k
hashgraph-online
hashgraph-online/awesome-codex-plugins

revid

Make, edit, export and post AI videos with Revid (revid.ai) through the Revid MCP server. Use whenever the user wants a short-form or long-form video made (from an idea, a script, a URL, an article, a PDF, a tweet, a product page, their own clips, or a song), wants to find what is going viral on TikTok, YouTube, Instagram or X before making something, wants to edit or re-export an existing Revid project, generate a standalone AI image or clip, make a series episode, or publish and schedule a finished video to connected social accounts. Covers setup (hosted MCP with OAuth, or an API key), the 36 tools, credits, polling and the rules for publishing. Routes to the more specific revid-* skills when one fits.

图像与多媒体Skill与智能体开发
★ 1.6k