review-docs

Audit documentation drift and gaps caused by code changes via git diff against origin/main.

4|1|Updated Jan 11, 2026
One-click install
npx skills add https://github.com/doodledood/codex-workflow --skill review-docs-doodledood
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: review-docs
Source: https://github.com/doodledood/codex-workflow/tree/main/skills/review-docs
Command: npx skills add https://github.com/doodledood/codex-workflow --skill review-docs-doodledood

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Audit documentation to ensure accuracy and alignment with code changes, identifying drift, outdated examples, and missing docs.

Core Features & Use Cases

  • Diff-driven documentation audits tied to code changes
  • Comprehensive location scavenger across AGENTS.md, README.md, docs/, SPEC.md, CHANGELOG.md, and CONTRIBUTING.md
  • Actionable reports with gaps, inconsistencies, and suggested updates

Quick Start

Run a diff-based documentation audit against origin/main to generate a findings report.

Frequently Asked Questions about review-docs

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

FAQPage Schema
How do I check for documentation drift after code changes?

To check for documentation drift, run a diff-driven audit against origin/main to identify outdated examples and missing docs. This produces a concise report listing impacted files, inconsistencies, and recommended updates.

What files are scanned during a documentation audit?

A documentation audit scavenge targets AGENTS.md, README.md, docs/, SPEC.md, CHANGELOG.md, and CONTRIBUTING.md. It scans these locations to find missing or inconsistent documentation introduced by code changes.

Can I audit specific files and directories instead of using a diff?

Yes, you can audit documentation using explicit files and directories instead of a diff. This allows you to manually scope the review to specific project areas to find missing or inconsistent docs.

What is the best way to keep docs in sync with code updates?

The best way to keep docs in sync with code is running diff-driven audits tied to code changes. This identifies documentation drift and produces actionable reports with recommended updates for impacted files.

What does a documentation drift report include?

A documentation drift report includes impacted files, missing or inconsistent docs, and recommended updates. It provides a concise, high-density summary of gaps found during the scope audit.