review-docs

Verify documentation claims against current code and run documented examples.

Updated Sep 3, 2026
One-click install
npx skills add https://github.com/JonusNattapong/A2A-MCP --skill review-docs-jonusnattapong
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: review-docs
Source: https://github.com/JonusNattapong/A2A-MCP/tree/main/src/agenttalk/skills/devkit/review-docs
Command: npx skills add https://github.com/JonusNattapong/A2A-MCP --skill review-docs-jonusnattapong

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Stale or inaccurate documentation misleads users more than missing docs. This Skill adversarially reviews READMEs, guides, and references by checking every claim against the actual code and running every documented example before approval. ## Core Features & Use Cases - Accuracy verification: Cross-checks signatures, parameters, flags, config keys, defaults, and version numbers against the current codebase, flagging drift as blocking. - Example execution: Runs every documented command and snippet (or confirms CI runs them) to reject illustrative-but-untested examples. - Fit and completeness checks: Validates Diataxis mode purity, audience fit, completeness, scannability, and drift guards like broken links and stale screenshots. - Use Case: After a code change that touched user-facing docs, run this review to severity-tag findings ([blocker]/[major]/[minor]/[nit]) and emit a structured review-result evidence profile. ## Quick Start Review the README and docs in this repository against the current code and report any inaccuracies with severity tags.

Frequently Asked Questions about review-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I review documentation for accuracy against code?▼

Check every documented claim against the current code: signatures, parameters, return values, flags, config keys, defaults, and version numbers. Run every example or command in the docs and flag any drift as a blocking finding.

What should a documentation review checklist include?▼

Cover accuracy against code, executed examples, Diataxis mode purity, audience fit, completeness for the stated task, and drift guards like broken links, stale screenshots, and outdated env-var names. Severity-tag all findings.

When should I use doc review instead of code review?▼

Use doc review when reviewing a README, guide, reference, or doc change, or after code changes touching user-facing docs. Use code review for logic changes and a writing skill for authoring or updating docs.

Why do documentation reviews reject unrun examples?▼

Illustrative-but-unrun examples often break silently as code evolves, and a confidently wrong example misleads users more than a missing one. Every snippet must be executed or confirmed covered by CI.

What are the limitations of adversarial doc review?▼

It verifies docs against the current code state but does not write or update documentation itself. It also depends on CI gates like markdownlint and link checkers actually running rather than being skipped.