Can I use this skill to write documentation from scratch?

This skill is optimized for reviewing existing drafts. For initial drafting, it is recommended to use the writing-functional-docs or writing-api-docs skills.

Does it support API documentation specifically?

Yes, it includes specialized checklists for API docs, covering HTTP methods, parameters, field descriptions, and JSON example validity.

Why does it flag passive voice?

Active voice is a best practice in technical writing because it is more direct, easier to understand, and simplifies translation for global audiences.

What documentation dimensions does this skill evaluate?

It evaluates five key dimensions: Voice and Tone, Structure, Completeness, Clarity, and Technical Accuracy.

What kind of output does the review provide?

The skill provides a Review Summary with a verdict (PASS, NEEDS_REVISION, or MAJOR_ISSUES), a prioritized list of issues, and specific recommendations.

Technical Documentation Review

Name: Technical Documentation Review
Author: LerianStudio

byLerianStudio

•

Aprendizaje y Documentación

Audits and improves technical documentation by enforcing standards for voice, structure, completeness, and technical accuracy.

Acerca de

The documentation-review skill provides a systematic framework for evaluating and refining technical content before publication. It enforces high-quality standards by checking for active voice, proper hierarchical structure, and technical correctness in API references and how-to guides. By identifying issues like passive voice, excessive sentence length, and missing examples, it ensures that your documentation remains clear, scannable, and developer-friendly, ultimately reducing user friction and improving the developer experience.

Características Principales

17 GitHub stars
Voice and tone auditing for active voice and present tense consistency
Technical accuracy validation for code snippets and API paths
Structural analysis of heading hierarchy and section organization
Completeness verification for conceptual guides and API references
Readability checks targeting sentence length and jargon reduction

Casos de Uso

Reviewing AI-generated drafts for technical accuracy and structural clarity
Auditing existing documentation folders to ensure compliance with style guides
Performing a final quality gate check before publishing new feature documentation

Acerca de

Características Principales

17 GitHub stars
Voice and tone auditing for active voice and present tense consistency
Technical accuracy validation for code snippets and API paths
Structural analysis of heading hierarchy and section organization
Completeness verification for conceptual guides and API references
Readability checks targeting sentence length and jargon reduction

Casos de Uso

Reviewing AI-generated drafts for technical accuracy and structural clarity
Auditing existing documentation folders to ensure compliance with style guides
Performing a final quality gate check before publishing new feature documentation