Skills Guide

Documentation Audit

VerifiedSafe

Audits all project documentation by cross-referencing it against the actual codebase. Checks environment variables, file paths, Docker configs, and feature descriptions, then identifies gaps and applies fixes.

Download and use
Sby Skills Guide Bot
DocumentationIntermediate
6/2/2026
Claude Code
#documentation-audit#code-cross-reference#accuracy-check#gap-analysis

Recommended for

Claude CodeAuto documentation

Automated summary

Audits project documentation for accuracy and completeness by cross-referencing against the actual codebase.

Strengths

  • Catches stale documentation
  • Identifies missing documentation
  • Ensures environment variables match schema
  • Verifies file paths exist

Limitations

  • Requires documentation to exist in a recognized format
  • May miss implicit documentation outside files
  • Cannot verify logical correctness of descriptions
When to use it

When you need to ensure project documentation is up-to-date and consistent with the codebase before a release or handoff.

When not to use it

When documentation is intentionally minimal or your project is in early development without stable code.

Security analysis

Safe
Quality score90/100

The skill only reads documentation and code to audit and fix documentation using the Edit tool. It does not execute external commands, exfiltrate data, or perform destructive actions. The operations are confined to improving documentation accuracy.

No concerns found

How this analysis is made

Examples

Full documentation audit
Run a documentation audit on this project: check README.md, CLAUDE.md, .env.example, and all SKILL.md files against the codebase. Report stale items, missing items, and apply fixes.
Check environment variable docs
Verify that all environment variables mentioned in the documentation match the keys in scripts/config_schema.py's ENV_MAP. Fix any discrepancies.
Find undocumented features
Scan the codebase for features that are not covered in any documentation file and list them as missing items.

Documentation Audit

Audit all project documentation for accuracy and completeness, cross-referencing against the actual codebase.

Usage

/documentation

Instructions

Step 1: Inventory

List all documentation files in the project:

  • README.md
  • CLAUDE.md
  • .env.example
  • All SKILL.md files under .claude/skills/
  • Significant inline documentation (Python docstrings, shell script comments)

Use Glob and Read tools to locate and read each file.

Step 2: Cross-Reference Code

For each documentation file, verify the following against the actual codebase:

  • Environment variables — All environment variable names mentioned must match keys in scripts/config_schema.py's ENV_MAP and ALIASES. Use Grep and Read to check.
  • File paths and directories — All file paths, directory references, and command examples must actually exist and work. Use Glob to verify paths.
  • Build arguments and Docker config — All build arguments, Docker image names, and port numbers must match Dockerfile and docker-compose.yml. Use Read to compare.
  • Feature descriptions — Feature descriptions must match actual code behavior. Read the relevant source code to verify.

Step 3: Identify Gaps

Check for:

  • Features present in code but missing from documentation.
  • Deprecated or removed features still mentioned in documentation.
  • Inconsistencies between different documentation files (e.g., README.md says one thing, .env.example says another).

Step 4: Report and Fix

Produce a summary of findings organized as:

  • Accurate items — Documentation that correctly reflects the codebase.
  • Stale items — Documentation that references removed or changed features.
  • Missing items — Features or configuration present in code but not documented.

Apply fixes directly to the documentation files using the Edit tool. For each fix, explain what was changed and why.

From the file to a first result

The download contains exactly the content displayed on this page. This copy may differ from the latest version in the source repository.

View the source and supporting files

This download contains SKILL.md only. Any scripts, references, templates and dependencies are not included. Get the required files from the source, preserving their directory structure, before continuing.

1. Download the file

Download SKILL.md

From the root of a test project, save the file as .skill-downloads/documentation-audit-mm78noeb/SKILL.md, or use the command below. This folder is for inspecting the skill before installation.

Command for macOS/Linux or WSL: requires a POSIX shell and curl. On Windows without WSL, use the download button and create the folder manually.

mkdir -p '.skill-downloads/documentation-audit-mm78noeb' && curl --fail --show-error --location 'https://skills-guides.com/api/skills/documentation-audit-mm78noeb/download' --output '.skill-downloads/documentation-audit-mm78noeb/SKILL.md.part' && mv '.skill-downloads/documentation-audit-mm78noeb/SKILL.md.part' '.skill-downloads/documentation-audit-mm78noeb/SKILL.md'

2. Check prerequisites

Read SKILL.md before using it. If it references scripts or external services, inspect them and prepare the required access in your test environment.

No recognized prerequisites section in this file. This does not mean it is self-contained: libraries, tools and access requirements may be mentioned elsewhere in the content or source repository.

The platforms on this page are catalog indications. The paths below follow tool documentation; they do not prove this skill has been run in those tools. No minimum tool version is confirmed for this listing.

3. Load the skill

This file does not provide a usable name/description header for this native procedure. It remains available to download and inspect; use the manual method below.

Manual method or another tool: attach SKILL.md to a conversation, or open it in an agent that can read files. Include any required supporting resources. No universal folder is recognized by every tool.

4. Try a first task

Use a short, synthetic input: an API endpoint, a small document or an interface brief. In a new conversation, attach the file or give the agent its path, then adapt this request:

Read .skill-downloads/documentation-audit-mm78noeb/SKILL.md and apply its instructions to this example: [describe a test input]. Identify any missing files, dependencies or access. Produce the result requested by the skill without inventing data or running unreviewed scripts.

Expected result: output matching the skill instructions, or a precise list of missing prerequisites. A read confirmation alone does not validate a first use. If an external resource is unavailable, that path remains untested.

Related skills

Supabase Docs Authoring

Documentation

Write, edit, and review Supabase documentation content including guides, tutorials, reference docs, and partials. Follow style guides and MDX/TOML validation rules.

Claude CodeintermediateSafe 108,544
Skills Guide Bot

Create Architecture Decision Record

Documentation

Create a new Architecture Decision Record with sequential numbering, register it in the AgentDB graph, and link related ADRs.

Claude CodeintermediateSafe 69,659
Skills Guide Bot

Plan update with deep research

Documentation

Updates a plan document by launching parallel subagents to analyze a topic across all compiler passes, then consolidates findings into the plan doc.

Claude CodeadvancedSafe 248,015
Skills Guide Bot