audit-docs

Audit project documentation against the codebase and report categorized gaps.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/ian97531/goodplan --skill audit-docs-ian97531
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: audit-docs
Source: https://github.com/ian97531/goodplan/tree/main/skills/audit-docs
Command: npx skills add https://github.com/ian97531/goodplan --skill audit-docs-ian97531

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation often drifts from the codebase, leading to stale references, missing public APIs, and inconsistent guidance. This Skill automates auditing project documentation against the actual codebase and produces structured findings, actionable fixes, and side-quest ideas.

Core Features & Use Cases

  • Staleness detection: finds docs referencing removed code, updated APIs, or outdated configuration.
  • Gap detection: surfaces undocumented public APIs, CLI commands, and config options.
  • Consistency checking: identifies cross-document contradictions and code examples that no longer work.
  • Audit workflow: coordinates sub-agents to generate inline findings, proposals, and an audit report.

Quick Start

Trigger the audit-docs skill on your repository to generate an in-depth documentation audit report.

Frequently Asked Questions about audit-docs

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

FAQPage Schema
How do I audit documentation against my codebase for gaps and staleness?

Documentation drift creates stale references and undocumented public APIs when code changes outpace docs. Auditing your codebase surfaces these gaps and inconsistencies automatically, producing structured findings with evidence and actionable fixes.

What is the best way to find undocumented public APIs and CLI commands in my project?

The best way to find undocumented public APIs and CLI commands is to run a documentation gap audit. The skill detects missing exports and surfaces them as structured findings with evidence for your audit report.

How do I detect cross-document contradictions and outdated code examples?

To detect cross-document contradictions and outdated code examples, use a consistency checking audit. The skill identifies conflicting guidance across your documentation ecosystem and flags code examples that no longer work with the current codebase.

Can I use a documentation audit for projects with large doc ecosystems and CLI surfaces?

Yes, documentation auditing is specifically applicable to projects with sizeable doc ecosystems, code exports, and CLI surfaces. It coordinates concurrent reviews using sub-agents to handle the scale of your documentation infrastructure.

What does a documentation audit report include after reviewing the codebase?

A documentation audit report includes categorized findings for staleness, gaps, and inconsistencies. Each finding contains evidence from the codebase review, actionable fixes, and side-quest ideas for further improvements.