Documentation Style Reviewer
Reviews documentation changes for compliance with style guides and readability standards across markdown files and pull requests.
The Documentation Style Reviewer skill automates the auditing of markdown files and pull requests to ensure they adhere to professional writing standards, specifically optimized for the Metabase style guide. It analyzes tone, structure, formatting, and link quality to eliminate 'corporate-speak' and improve clarity. By detecting whether it's operating in a local environment or a GitHub PR, it provides structured, sequentially numbered feedback that helps maintain a consistent voice and high-quality documentation without manual overhead.
Características Principales
01Automated style guide compliance checking for tone and voice
02Validation of UI element formatting, link descriptions, and code examples
03Parallel comment posting for efficient GitHub pull request workflows
04Sequential issue numbering for easy reference and tracking
05108 GitHub stars
06Dual-mode detection for local terminal output or GitHub PR reviews
Casos de Uso
01Enforcing standardized UI element bolding and link descriptive text across a project
02Auditing local markdown files for readability and corporate jargon before committing
03Reviewing documentation PRs to ensure consistent terminology and formatting