Documentation Review Plugin

Comprehensive documentation management for Claude Code: review, create, update, and maintain high-quality documentation.

View infographic generation prompt

Create a visual infographic summarizing the Documentation Review plugin for Claude Code.

Layout: Clean, modern infographic style (1200x800px)
Background: Light cream/off-white with subtle texture

Sections:
1. HEADER: "Documentation Review" - Claude Code Plugin for Documentation Excellence
2. CORE CAPABILITIES (4 quadrants): Review, Create, Update, Cleanup
3. SUPPORTED FORMATS: Markdown, MkDocs, Sphinx, Docusaurus, OpenAPI, AsyncAPI
4. KEY COMMANDS: /doc-review → /doc-create → /doc-update → /changelog
5. FOOTER: AI-Powered • MIT License • v0.1.0

Color palette: Warm amber (#F59E0B), deep teal (#0D9488), coral (#F97316), cream (#FFFBEB)
Style: Professional, clean lines, rounded corners, subtle shadows

Features

• Documentation Review - Analyze existing docs for accuracy, completeness, and quality
• Documentation Creation - Generate new docs from codebase analysis (README, API docs, templates)
• Documentation Updates - Keep docs current with codebase changes
• Documentation Cleanup - Identify obsolete or outdated content
• Changelog Management - Maintain CHANGELOG.md with Keep a Changelog format
• Quality Validation - Automatic checks on markdown file edits
• Multi-format Support - Markdown with awareness of MkDocs, Sphinx, Docusaurus
• API Documentation - OpenAPI/Swagger and AsyncAPI integration

Installation

From GitHub

claude plugin install zircote/documentation-review

Manual Installation

Clone and add to Claude Code:

git clone https://github.com/zircote/documentation-review.git
claude --plugin-dir /path/to/documentation-review

Or copy to your project's .claude-plugin/ directory.

Commands

Command	Description
/doc-review [path]	Review documentation for issues (file, directory, or project-wide)
/doc-create [type]	Generate new documentation (readme, api, template)
/doc-update [path]	Update outdated documentation with current information
/doc-cleanup	Identify and report obsolete documentation
/doc-setup	Interactive setup for project configuration
/changelog [action]	Manage CHANGELOG.md (add, review, generate, preview)

Agents

Agent	Description
doc-reviewer	Comprehensive documentation audit with proactive triggering
doc-writer	Content generation and documentation updates

Skills

• documentation-standards - Markdown best practices, structure guidelines, writing quality
• api-documentation - OpenAPI/Swagger/AsyncAPI patterns and endpoint documentation
• changelog - Keep a Changelog format, semantic-release, conventional commits mapping

Configuration

Create .claude/documentation-review.local.md in your project root to customize behavior.

Quick Setup

Run /doc-setup for interactive configuration, or manually create the file:

---
# Documentation paths to scan (default: auto-detect)
doc_paths:
  - docs/
  - README.md
  - "*.md"

# Files/patterns to ignore
ignore:
  - "**/node_modules/**"
  - "**/vendor/**"
  - "**/.git/**"
  - "**/dist/**"
  - "**/build/**"
  - "CHANGELOG.md"

# Documentation standards
standards:
  require_description: true
  max_heading_depth: 4
  require_code_examples: false
  check_links: true
  check_spelling: false

# API documentation settings
api_docs:
  openapi_path: null           # Auto-detect
  asyncapi_path: null          # Auto-detect
  generate_from_code: false

# Static site generator integration
site_generator:
  type: auto                   # auto, mkdocs, sphinx, docusaurus
  config_path: null            # Auto-detect

# Output preferences
output:
  verbosity: normal            # minimal, normal, detailed
  format: markdown             # markdown, json
---

# Project Documentation Notes

Add project-specific documentation context here...

File Structure

documentation-review/
├── .claude-plugin/
│   └── plugin.json
├── agents/
│   ├── doc-reviewer.md
│   └── doc-writer.md
├── commands/
│   ├── changelog.md
│   ├── doc-cleanup.md
│   ├── doc-create.md
│   ├── doc-review.md
│   ├── doc-setup.md
│   └── doc-update.md
├── skills/
│   ├── api-documentation/
│   │   ├── SKILL.md
│   │   ├── examples/
│   │   └── references/
│   ├── changelog/
│   │   ├── SKILL.md
│   │   ├── examples/
│   │   └── references/
│   └── documentation-standards/
│       ├── SKILL.md
│       ├── examples/
│       └── references/
├── templates/
│   └── documentation-review.local.md.example
├── CHANGELOG.md
├── LICENSE
└── README.md

Usage Examples

Review all project documentation

/doc-review

Review specific file

/doc-review docs/api-reference.md

Generate README from codebase

/doc-create readme

Generate API documentation

/doc-create api

Find outdated documentation

/doc-cleanup

Add changelog entry

/changelog add "Added new feature X"

Contributing

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Submit a pull request

License

MIT