review-documentation

Audit project documentation for accuracy, completeness, and consistency.

Updated Feb 15, 2026

Search Tags:#documentation #API #readme #quality #review #accuracy

Ready to run

npx skills add https://github.com/tvishwanadha/skills --skill review-documentation-tvishwanadha

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: review-documentation
Source: https://github.com/tvishwanadha/skills/tree/main/plugins/reviewer/skills/review-documentation
Command: npx skills add https://github.com/tvishwanadha/skills --skill review-documentation-tvishwanadha

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

The skill helps teams ensure documentation accuracy, completeness, and clarity across README, API docs, changelogs, and guides by systematically reviewing content and identifying gaps.

Core Features & Use Cases

Automated documentation reviews for README, API references, and guides
Consistency checks across sections, terminology, and examples
Cross-reference with code to verify feature coverage and accuracy
Use Case: QA teams and developers ensure docs match implemented behavior

Quick Start

Specify the file or directory to review, for example reviewer:review-documentation README.md or reviewer:review-documentation docs/

Frequently Asked Questions about review-documentation

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

FAQPage Schema

How do I audit documentation for accuracy and completeness?▼

To audit documentation for accuracy, you can review README, API docs, and changelogs to verify consistency, coverage, and correctness by cross-referencing text with code and producing structured findings.

What is the best way to check if API docs match implemented behavior?▼

The best way to check if API docs match implemented behavior is by running an automated documentation review that cross-references content with code to verify feature coverage and accuracy.

Can I review an entire docs directory instead of a single file?▼

Yes, you can review an entire docs directory instead of a single file by specifying the directory path, allowing the tool to systematically review content and identify gaps across the project.

Does documentation review check for consistency across terminology and examples?▼

Documentation review does check for consistency across sections, terminology, and examples, ensuring clarity and uniformity throughout README files, API references, and guides.

What types of documentation files are supported for quality review?▼

Supported documentation files for quality review include README, API docs, changelogs, and project guides, which are systematically analyzed to identify gaps and verify correctness.