review-docs

Review Markdown files or PR changes for reader-focused documentation issues.

290|826|Updated Jun 15, 2012
One-click install
npx skills add https://github.com/umbraco/UmbracoDocs --skill review-docs-umbraco
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: review-docs
Source: https://github.com/umbraco/UmbracoDocs/tree/main/.claude/skills/review-docs
Command: npx skills add https://github.com/umbraco/UmbracoDocs --skill review-docs-umbraco

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

Review documentation from the reader's perspective, surfacing unclear sections, fluff, missing context, and maintenance burden to improve usability.

Core Features & Use Cases

  • File mode (default): Review one or more specific files by path, or when a file is open in the IDE.
  • PR mode: Review all Markdown files changed on the current branch compared to main, including automated checks (Vale linting and link checking) before analysis.
  • The skill guides the reviewer through reader-focused criteria (clarity, completeness, maintainability) and references related pages for context.

Quick Start

Provide one or more file paths or 'pr' to run a review in file mode or PR mode.

Frequently Asked Questions about review-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I review Markdown documentation for clarity and completeness?

Review Markdown documentation by analyzing it from a reader's perspective, surfacing unclear sections, fluff, and missing context. This process evaluates reader value, clarity, completeness, maintainability, and factual accuracy to improve overall usability.

How do I review all changed Markdown files in a PR?

Review all changed Markdown files in a PR by running the tool in PR mode. This compares the current branch to main, automatically running Vale linting and link checking before analyzing the documentation for reader-focused quality improvements.

What is the best way to automate documentation quality assurance in a pull request?

Automate documentation quality assurance in a pull request by triggering PR mode to evaluate changed Markdown files. The workflow integrates Vale linting and link checking, enforcing reader value, clarity, completeness, maintainability, and factual accuracy across the modifications.

Can I review a single Markdown file by its path?

Yes, you can review a single Markdown file by providing its path to run the tool in file mode. This allows you to analyze an individual open file or specific document path for reader-focused quality issues and improvement opportunities.

Does documentation linting check for broken links and readability issues?

Yes, documentation linting checks for broken links and readability issues using Vale linting and link checking. These automated checks surface maintenance burdens and unclear sections before analyzing the documentation for reader value, clarity, and factual accuracy.

Why should I review documentation from a reader's perspective instead of just checking formatting?

Reviewing documentation from a reader's perspective goes beyond formatting to surface missing context, fluff, and maintenance burden. It enforces evaluation across reader value, clarity, completeness, maintainability, and factual accuracy, ensuring the documentation genuinely improves usability.