api-documentador-revisor

What problem does it solve?

This skill verifies that API documentation is complete, coherent, and usable by its intended audience by checking coverage across non-technical and technical layers, consistency between documents, quality of examples, and the presence of navigation/index files.

Core Features & Use Cases

• Completeness checks: Confirms Getting Started, Use Cases, Glossary, Technical Reference, Support, and Changelog layers are present and populated according to type (tecnica / nao-tecnica / ambas).
• Quality analysis: Validates language for the target audience, real-value examples (valid JSON, realistic UUIDs/dates/emails), and actionable error explanations.
• Consistency & partitioning: Cross-checks endpoints, error catalogs, environments, and glossary terms across partitioned documents and verifies index.md coverage.
• Output: Produces a structured Markdown revision report with category-by-category verdicts (APROVADO / AJUSTAR / REESCREVER), problem items, suggestions, and a final recommendation.
• Use case: Run after api-documentador generates docs or to audit existing API documentation before publication.

Quick Start

Run the review on the project's ./doc-apis/{title}/ directory and produce the specified Markdown revision report summarizing completeness, consistency, problems, and a final verdict.