Can I use this for writing new documentation?

No, this skill is specifically optimized for reviewing existing drafts. For initial creation, use specialized writing skills like writing-functional-docs.

How are issues prioritized in the review output?

Issues are categorized as Critical (factually incorrect), High (major style violations), Medium (inconsistencies), or Low (minor polish issues).

Why does the skill require loading other standards first?

To provide an accurate review, the skill must reference specific standards for voice and structure, ensuring the feedback is objective rather than subjective.

Does it check code examples within the documentation?

Yes, it verifies that code examples are technically accurate, syntactically correct, and that their output matches the provided description.

Documentation Quality Reviewer

Name: Documentation Quality Reviewer
Author: luanrodrigues

byluanrodrigues

•

Content Management

Reviews technical documentation for voice, structure, and accuracy to ensure professional quality and user clarity.

The Documentation Review skill provides a systematic framework for auditing technical content across five critical dimensions: voice and tone, organizational structure, completeness, clarity, and technical accuracy. It enforces rigorous standards to ensure documentation is user-centric, active in voice, and technically sound. By providing detailed feedback categorized by severity and specific line references, it streamlines the editorial process and prevents low-quality or inaccurate information from reaching end-users.

Key Features

01Technical accuracy verification for API paths, code examples, and behavior

022 GitHub stars

03Strict enforcement of style guide compliance and mandatory review dependencies

04Multi-dimensional audit covering voice, tone, structure, and clarity

05Priority-based issue categorization with specific line references

06Standardized review verdicts (PASS, NEEDS_REVISION, MAJOR_ISSUES)

Use Cases

01Auditing existing documentation repositories for consistency with voice and tone guidelines

02Performing a final quality check before publishing new API documentation or feature guides

03Reviewing pull requests for documentation changes to ensure they meet technical and structural standards

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add luanrodrigues/ia-frmwrk documentation-review

For use in Claude.ai and ChatGPT

Key Features

01Technical accuracy verification for API paths, code examples, and behavior

022 GitHub stars

03Strict enforcement of style guide compliance and mandatory review dependencies

04Multi-dimensional audit covering voice, tone, structure, and clarity

05Priority-based issue categorization with specific line references

06Standardized review verdicts (PASS, NEEDS_REVISION, MAJOR_ISSUES)

Use Cases

01Auditing existing documentation repositories for consistency with voice and tone guidelines

02Performing a final quality check before publishing new API documentation or feature guides

03Reviewing pull requests for documentation changes to ensure they meet technical and structural standards

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add luanrodrigues/ia-frmwrk documentation-review

For use in Claude.ai and ChatGPT