Audits markdown files and GitHub Pull Requests for style guide compliance and technical readability.
The Documentation Reviewer skill automates the process of checking technical documentation against established style guides. It identifies common writing pitfalls such as corporate jargon, poor structural clarity, and inconsistent formatting while providing actionable suggestions for improvement. Whether working locally on markdown files or reviewing GitHub Pull Requests with inline comments, this skill ensures that documentation remains clear, concise, and helpful for the end reader.
主な機能
010 GitHub stars
02Comprehensive checks for tone, voice, structure, and formatting
03Automated style guide compliance checking for markdown files
04Sequential issue numbering for easy referencing and tracking
05Dual-mode support for local file reviews and GitHub Pull Request integration
06Validation of code examples and command execution sequences
ユースケース
01Performing automated reviews of technical documentation in GitHub Pull Requests
02Auditing existing documentation for readability and accessibility issues
03Ensuring internal project READMEs and guides follow a consistent writing style
