Does this skill require the GitHub CLI?

Yes, it utilizes the 'gh' CLI to retrieve pull request diffs and metadata to perform the analysis.

Does it review the entire document or just the PR changes?

It focuses on the changed lines (the diff) but considers the surrounding context and full file content when necessary to ensure overall document coherence.

Which file formats does this skill support?

The skill supports Markdown (.md, .mdx), reStructuredText (.rst), AsciiDoc (.adoc), plain text, and inline documentation like JSDoc or docstrings within code files.

How are the review findings organized?

Findings are categorized by severity: Critical (must fix), Warning (should fix), and Suggestion (minor improvements), followed by an overall verdict.

Can it detect incorrect code snippets in documentation?

Yes, the Technical Accuracy category specifically checks for incorrect command syntax, API usage, and code examples that would fail to run.

Documentation Review

Name: Documentation Review
Author: kadel

bykadel

0•

学习与文档

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.

主要功能

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

使用场景

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

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add kadel/claude-plugins documentation

For use in Claude.ai and ChatGPT

Download Skill