skills.rest
tomzx
tomzxCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

review-documentation

Audit documentation for completeness, accuracy, clarity, usability, and structure.

5|Updated Jul 25, 2025
Search Tags:#documentation#usability#quality#structure#completeness#review#accuracy
One-click install
npx skills add https://github.com/tomzx/agents --skill review-documentation-tomzx
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: review-documentation
Source: https://github.com/tomzx/agents/tree/main/skills/review-documentation
Command: npx skills add https://github.com/tomzx/agents --skill review-documentation-tomzx

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

A structured audit of documentation to ensure it is complete, correct, clear, usable, and well organized.

Core Features & Use Cases

  • Completeness checks against API surfaces, user workflows, and configuration options.
  • Accuracy verification by cross-referencing with source truth and versioned changes.
  • Clarity and readability assessment, including terminology consistency and audience-appropriate language.
  • Usability evaluation, focusing on findability, navigation, cross-references, and logical flow.
  • Structure alignment with recommended headings and documentation frameworks.

Quick Start

Provide an initial documentation audit by applying completeness, accuracy, clarity, usability, and structure checks to the given documents.

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 completeness and usability?▼

A documentation quality audit evaluates completeness, accuracy, clarity, usability, and structure. It cross-references source truth and versioned changes to identify gaps, verify terminology consistency, and assess audience-appropriate language across diverse project contexts.

How do I check API reference accuracy against source code changes?▼

You can check API reference accuracy by cross-referencing documentation against source truth and versioned changes. This structured approach identifies gaps and inconsistencies, ensuring configuration options and API surfaces are correctly documented.

What is the best way to structure an internal wiki for findability?▼

A documentation audit evaluates findability and navigation by assessing structure alignment with recommended headings and documentation frameworks. It ensures cross-references and logical flow are optimized across internal wikis and user manuals.

Can I use a structured documentation review for onboarding guides?▼

Yes, a structured documentation review applies completeness and clarity checks to onboarding guides. It assesses terminology consistency, audience-appropriate language, and alignment with user workflows to identify gaps and improve readability.

How do I generate a remediation plan after finding documentation gaps?▼

A documentation audit identifies gaps and inconsistencies across completeness, accuracy, clarity, usability, and structure. It then outputs a prioritized remediation plan that addresses these issues, providing a structured approach to improving documentation quality.

Related Skills

Explore More Content & Communication Skills→
open-circleopen-circle
1.1k

repo-website-api-review

Review API documentation routes against source code for accuracy.

Official
Intermediate
reasondbreasondb
60

check-docs

Audit documentation health by verifying source mappings, links, and terminology consistency.

Official
Intermediate
FelixBitSoulFelixBitSoul
2

chinese-documentation

Standardize Chinese technical documentation typography, terminology, and structure.

Community
Intermediate
dimsourdimsour
2

dotnet:document

Generate XML documentation, READMEs, and OpenAPI descriptions from .NET source code.

Community
Intermediate