Documentation Reviewer
Reviews documentation for compliance with style guides, clarity, and standardized formatting.
The Documentation Reviewer skill automates the editorial process for technical documentation, ensuring consistency with the Metabase writing style guide. It analyzes markdown files for tone, voice, structural clarity, and formatting accuracy, such as correct UI element styling and link descriptions. Whether working locally or within a GitHub Pull Request, it provides sequentially numbered, actionable feedback to help writers maintain high-quality, professional, and accessible documentation without manual oversight.
Características Principales
01Detailed feedback on tone, voice, and structural clarity
0281 GitHub stars
03Automated style guide compliance checks for technical writing
04Validation of formatting standards for UI elements and code snippets
05Sequentially numbered issue tracking for efficient developer reference
06Support for both GitHub PR reviews and local markdown analysis
Casos de Uso
01Standardizing technical terminology and UI formatting across large documentation sites
02Audit local markdown files for readability and style consistency before publishing
03Automating editorial reviews for documentation pull requests on GitHub