review-doc

Official

Comprehensive doc quality reviews.

Authorhashicorp
Version1.0.0
Installs0

System Documentation

What problem does it solve?

This skill automates a comprehensive quality review of documentation against established standards (REVIEW_PHASES.md and AGENTS.md), helping teams identify gaps, improve consistency, and accelerate publishing.

Core Features & Use Cases

  • 7-phase evaluation: Validate documents across all seven phases, from user success to final validation.
  • Executive reporting: Generate structured findings and prioritization to inform edits and publishing decisions.
  • Customization: Run specific phases or apply fixes with a --fix mode to implement recommended changes.
  • Use Case: A docs team reviews a new API guide to ensure accuracy, consistency, and SEO readiness before release.

Quick Start

Use the /review-doc command on one or more Markdown files (e.g., /review-doc docs/api-guide.md) to generate a quality review report. Add --fix to apply automatic corrections.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: review-doc
Download link: https://github.com/hashicorp/web-unified-docs/archive/main.zip#review-doc

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 223,000+ vetted skills library on demand.