doc-review

Audit Markdown documentation for correctness, completeness, and freshness.

18|4|Updated Jan 29, 2026
One-click install
npx skills add https://github.com/chrisallenlane/claude-swe-workflows --skill doc-review-chrisallenlane
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-review
Source: https://github.com/chrisallenlane/claude-swe-workflows/tree/main/skills/doc-review
Command: npx skills add https://github.com/chrisallenlane/claude-swe-workflows --skill doc-review-chrisallenlane

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Ensures project documentation is correct, complete, and up-to-date by auditing all docs and applying autonomously-approved fixes.

Core Features & Use Cases

  • Comprehensive documentation audit for correctness, completeness, and freshness
  • Autonomous fixes within authority, with a report of changes and required approvals
  • Integrates with release and refactor workflows to reduce drift
  • Use Case: run before releases to ensure docs reflect the current codebase

Quick Start

Run /doc-review to spawn a doc-maintainer agent that audits and fixes all project documentation.

Frequently Asked Questions about doc-review

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

FAQPage Schema
How do I audit markdown documentation for broken links and outdated references?

To audit markdown documentation, you can run a command to spawn a doc-maintainer agent that scans all project Markdown files for drift, broken links, and outdated references. It checks correctness and freshness, then autonomously applies fixes within its authority.

What is documentation drift and when do I need to run a doc audit?

Documentation drift occurs when project docs fall out of sync with the codebase during refactors or feature launches. You need to run a doc audit before releases to ensure all markdown files reflect current code, verifying completeness, freshness, and link validity.

Can I autonomously fix project documentation issues during a release cycle?

Yes, you can autonomously fix project documentation issues during a release cycle. The doc-maintainer agent applies approved fixes directly to your markdown files, reducing drift and providing a report of changes and required approvals.

Does the doc audit work with existing markdown documentation without extra dependencies?

Yes, the doc audit works with existing markdown documentation without extra dependencies. It requires no external components and directly loads all project markdown docs to scan for correctness, completeness, and consistency across refactors.

What is the best way to maintain documentation freshness across major feature launches?

The best way to maintain documentation freshness is to run an autonomous doc audit before major feature launches. This ensures all markdown references stay aligned with the codebase by scanning for drift and applying fixes within authority.

Why does my project documentation have broken links after a codebase refactor?

Project documentation often gets broken links after a codebase refactor due to documentation drift. Running a comprehensive markdown audit detects these outdated references and autonomously fixes them to ensure docs stay aligned with code.