Documentation Style Reviewer

•
89
•

Automates documentation audits to ensure compliance with the Metabase writing style guide across markdown files and pull requests.

The Documentation Review skill serves as an automated editor for technical writers and developers, ensuring all documentation maintains a consistent voice and professional structure. By leveraging the Metabase writing style guide, it audits markdown files for tone, clarity, and formatting—such as preferring bold text over backticks for UI elements and removing condescending qualifiers. It intelligently switches between a local mode for file-based editing and a PR mode for GitHub integrations, providing sequentially numbered, actionable feedback that helps teams maintain high-quality documentation with minimal manual overhead.

주요 기능

01Automated Metabase style guide compliance auditing
0289 GitHub stars
03Dual-mode support for local markdown files and GitHub Pull Requests
04Comprehensive checks for tone, voice, structure, and formatting
05Sequential issue numbering for easy referencing and tracking
06Parallel GitHub comment posting for cohesive PR reviews

사용 사례

01Auditing existing markdown files for technical writing best practices
02Refining technical tutorials to ensure they are accessible and person-centric
03Reviewing documentation pull requests for stylistic consistency