Documentation Style Reviewer
Reviews markdown documentation for style guide compliance and readability across local and PR workflows.
The Documentation Review Skill streamlines the editing process by automatically checking markdown files against the Metabase writing style guide. It functions in two distinct modes: a GitHub PR mode that generates cohesive, multi-comment pending reviews, and a local mode for immediate terminal feedback. By identifying issues with tone, formatting, clarity, and link structures, the skill provides sequentially numbered feedback that ensures technical documentation remains professional, consistent, and user-centric without the overhead of manual proofreading.
Características Principales
01Local terminal review mode for rapid documentation iteration
02Automated GitHub Pull Request review workflow with parallel comment support
03Intelligent scanning for common pitfalls like vague headings and non-descriptive links
04Strict sequential numbering of feedback for efficient issue tracking
05Style guide enforcement for tone, voice, and formatting consistency
0681 GitHub stars
Casos de Uso
01Automating style audits during the GitHub Pull Request review process
02Standardizing technical documentation across multiple contributors and repositories
03Pre-flighting local documentation changes to ensure style guide compliance before committing