Analyzes documentation changes in pull requests for technical accuracy, clarity, and structural integrity.
This skill automates the rigorous process of reviewing documentation within GitHub pull requests, ensuring technical content is both accurate and easy to understand for your target audience. By evaluating changes across four key dimensions—clarity, technical correctness, organization, and grammar—it provides a structured report with actionable feedback categorized by severity. It is an essential tool for maintainers and developers who want to maintain high-quality project documentation and prevent technical inaccuracies or broken code examples from reaching production.
Key Features
01Tiered severity reporting with Critical, Warning, and Suggestion levels
02Automated PR diff retrieval using GitHub CLI integration
03Automatic PR verdict generation based on defined quality criteria
04Four-point evaluation criteria: Clarity, Accuracy, Structure, and Grammar
05Support for multiple formats including Markdown, reStructuredText, AsciiDoc, and docstrings
060 GitHub stars
Use Cases
01Ensuring consistent writing style and grammar across large-scale contributor-driven projects
02Reviewing technical documentation for accuracy before merging new features into a repository
03Verifying that CLI commands and code snippets in docs are technically correct and up-to-date
