Comprehensive documentation management: review, create, update, and maintain high-quality documentation with Diataxis framework support
Identify and report obsolete or outdated documentation
Generate new documentation from codebase analysis
Analyze documentation against the Diataxis framework (classify, review, gap analysis)
Review documentation for quality, accuracy, and completeness
Interactive setup for documentation review configuration
Reviews documentation quality, accuracy, and completeness. Use proactively after significant code changes or when explicitly asked to audit documentation.
Writes, updates, and restructures documentation including API docs, READMEs, and technical guides from codebase analysis.
Patterns and templates for creating comprehensive API documentation using OpenAPI/Swagger, AsyncAPI, and manual documentation approaches. Use this skill whenever the user wants to document REST endpoints, generate or improve an OpenAPI spec, create Swagger docs, document WebSocket/event-driven APIs with AsyncAPI, review API documentation completeness, add request/response examples, document authentication schemes, set up API documentation portals (Swagger UI, ReDoc, Stoplight), or convert between API doc formats. Also applies when discussing endpoint parameters, response codes, schema definitions, pagination patterns, error response formats, or code-first vs design-first API documentation. If the user mentions "API docs", "OpenAPI", "Swagger", "AsyncAPI", "endpoint documentation", "API reference", or "API spec", this skill likely applies.
Generate, update, review, and maintain changelogs using Keep a Changelog format, semantic-release, and conventional commits. Use this skill whenever the user wants to add a changelog entry, prepare release notes, document version changes, generate a changelog from git history, configure semantic-release, understand conventional commit mappings, review changelog format, create migration guides for breaking changes, or troubleshoot semantic-release issues. Also applies when discussing version bumps, release automation, CHANGELOG.md formatting, or any task involving documenting what changed between software versions. If the user mentions "changelog", "release notes", "version history", "what changed", "semantic-release", or "conventional commits", this skill likely applies. Also covers "what's new", "upgrade guide", and "release history" queries.
Classify, create, review, and maintain documentation using the Diátaxis framework — the four-quadrant system (tutorials, how-to guides, reference, explanation) that separates documentation by user need. Use this skill whenever the user wants to classify documentation into quadrants, perform a documentation gap analysis, check for mode mixing, create documentation following a specific quadrant template, organize docs by type, review documentation for Diátaxis alignment, add diataxis_type frontmatter, split mixed-mode documents, or structure new docs as tutorials vs how-to guides vs reference vs explanation. Also applies when discussing documentation taxonomy, learning-oriented vs task-oriented content, quadrant coverage matrices, cross-reference audits between doc types, or when the user is unsure whether something should be a tutorial or a how-to guide. If the user mentions "Diataxis", "documentation types", "tutorials vs guides", "quadrants", "mode purity", "gap analysis", "documentation classification", "documentation structure", or "documentation organization", this skill likely applies.
Standards and patterns for creating, reviewing, and improving technical documentation — covering markdown formatting, heading hierarchy, code blocks, links, writing style, accessibility, and language-native doc toolchains (rustdoc, godoc, Sphinx, TypeDoc, Javadoc, DocC, ExDoc). Use this skill whenever the user wants to review documentation quality, audit markdown formatting, fix document structure, improve technical writing, check doc comment coverage, enforce doc standards, write better docs, or asks about documentation best practices. Also triggers for language-specific doc toolchain questions (rustdoc, godoc, pydoc, JSDoc/TSDoc, Javadoc/KDoc, DocC, ExDoc) and site generator integration (MkDocs, Sphinx, Docusaurus, Astro Starlight). If the user mentions "docs", "documentation", "README", "writing style", "doc comments", "markdown", or "technical writing" in a quality or standards context, this skill likely applies.
Uses power tools
Uses Bash, Write, or Edit tools
Own this plugin?
Verify ownership to unlock analytics, metadata editing, and a verified badge. GitHub access is read-only (username + org membership).
Sign in to claimOwn this plugin?
Verify ownership to unlock analytics, metadata editing, and a verified badge. GitHub access is read-only (username + org membership).
Sign in to claimBased on adoption, maintenance, documentation, and repository signals. Not a security audit or endorsement.
Comprehensive documentation management for Claude Code: review, create, update, and maintain high-quality documentation.
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 → /doc-diataxis
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
claude plugin install zircote/documentation-review
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.
| 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 |
/doc-diataxis [action] [path] | Analyze docs against Diátaxis framework (classify, review, gaps, audit) |
| Agent | Description |
|---|---|
doc-reviewer | Comprehensive documentation audit with proactive triggering |
doc-writer | Content generation and documentation updates |
Create .claude/documentation-review.local.md in your project root to customize behavior.
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
---
npx claudepluginhub zircote-plugins/documentation-reviewSignal Intelligence - Comprehensive market research toolkit with report generation, GitHub issue creation, and trend-based analysis using three-valued logic
Multi-agent orchestration for Claude Code. Coordinate teams of agents with shared tasks, messaging, and 7 proven patterns including RLM for large-file analysis beyond context limits.
Software Development Lifecycle standards and requirements for project quality, security, and compliance
Complete lifecycle management for Architectural Decision Records (ADRs): create, update, supersede, search, audit compliance, and export
Verify and enforce use of latest stable library and package versions using live documentation lookups. Prevents outdated version recommendations, security vulnerabilities from stale dependencies, and deprecated API usage across 13+ package ecosystems.
Documentation review, cleanup, generation, voice extraction, and human-quality writing enforcement with AI slop detection and SICO-based voice profiling
Documentation quality, generation, and improvement using Diataxis principles. Pairs with beagle-core for full workflow.
Optimize CLAUDE.md and docs/ ecosystem following Boris Cherny's best practices
Use this agent when you need to analyze a service or codebase component and create comprehensive documentation in CLAUDE.md files. This agent should be invoked after implementing new services, major refactoring, or when documentation needs updating to reflect the current codebase structure. Examples: <example>Context: The user has just implemented a new authentication service and wants to document it properly. user: 'I just finished implementing the auth service, can you document how it works?' assistant: 'I'll use the codebase-documenter agent to analyze the authentication service and create detailed documentation in CLAUDE.md' <commentary>Since the user has completed a service implementation and needs documentation, use the Task tool to launch the codebase-documenter agent to create comprehensive CLAUDE.md documentation.</commentary></example> <example>Context: The user wants to ensure a newly added API module is properly documented for the team. user: 'We need documentation for the new payment processing API I just added' assistant: 'Let me use the codebase-documenter agent to analyze the payment processing API and create proper documentation' <commentary>The user needs documentation for a new API module, so use the codebase-documenter agent to create CLAUDE.md files with setup instructions and architectural notes.</commentary></example>
Lightweight documentation memory for AI coding agents: scaffold a docs tree, validate it, and auto-load recent context each session.
Create comprehensive documentation for code, APIs, and projects.