doc-review

Audit markdown documentation against a live codebase for stale claims.

1|Updated Apr 10, 2026
One-click install
npx skills add https://github.com/wnz99/claude-skills --skill doc-review-wnz99
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: doc-review
Source: https://github.com/wnz99/claude-skills/tree/main/skills/doc-review
Command: npx skills add https://github.com/wnz99/claude-skills --skill doc-review-wnz99

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps you audit an existing documentation file against the live codebase so you can remove stale claims, fix inaccuracies, and fill in missing details without rewriting the document from scratch.

Core Features & Use Cases

  • Evidence-backed verification: Checks commands, paths, env vars, scripts, and other claims against source files before any edit is made.
  • Targeted documentation refresh: Suited for runbooks, README files, AGENTS.md, CLAUDE.md, ADRs, setup guides, and similar markdown docs that need to stay current.
  • Practical outcome: Use it when a doc feels out of date and you need a precise report of what is correct, stale, missing, or unverifiable before applying small surgical fixes.

Quick Start

Use the doc-review skill to audit README.md against the current codebase and report any stale, missing, or unverifiable claims before editing.

Frequently Asked Questions about doc-review

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

FAQPage Schema
How do I audit a README against my live codebase to find stale documentation?

To audit a README, the doc-review Skill checks commands, paths, and env vars against source files to identify stale, missing, or unverifiable claims. It requires evidence-backed verification from your codebase before suggesting surgical edits.

Can I check existing runbooks and setup guides for missing or unverifiable claims?

Yes, you can check existing runbooks and setup guides for missing or unverifiable claims. The Skill audits markdown documentation by cross-referencing technical claims against source files to ensure accuracy without rewriting the document from scratch.

What is the best way to update markdown documentation without losing original structure?

The best way to update markdown documentation while preserving structure is applying surgical edits. This Skill verifies claims against source files and applies targeted fixes that maintain the document's original conventions and formatting.

Does documentation review work with ADRs and agent files like CLAUDE.md?

Documentation review works with ADRs, AGENTS.md, and CLAUDE.md files. The Skill targets markdown documentation that must stay aligned with implementation changes, applying evidence-backed verification to these specific configuration and setup files.

Why does my documentation audit require evidence-backed verification from source files?

A documentation audit requires evidence-backed verification from source files to ensure accuracy. The Skill prevents incorrect edits by validating commands, paths, and scripts against the live codebase before modifying any markdown documentation.

When should I not use a targeted documentation refresh for my project?

You should not use a targeted documentation refresh when a doc needs a complete rewrite rather than surgical fixes. This Skill is designed for auditing existing markdown files to remove stale claims and fill in missing details, not generating new documentation.