documentation-audit

Audit Markdown documentation against code behavior using multi-pass verification.

Updated Oct 22, 2025
One-click install
npx skills add https://github.com/2389-research/ourocodus --skill documentation-audit
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation-audit
Source: https://github.com/2389-research/ourocodus/tree/main/.claude/skills/documentation-audit
Command: npx skills add https://github.com/2389-research/ourocodus --skill documentation-audit

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Documentation often drifts from the actual codebase, leading to inaccuracies, incompleteness, and developer confusion. Manual audits are tedious and time-consuming. This Skill automates the systematic validation of documentation against code, ensuring your docs are always a reliable source of truth.

Core Features & Use Cases

  • Accuracy Validation: Systematically compares every factual claim in your documentation against the actual code behavior.
  • Completeness Check: Identifies undocumented features, APIs, configuration, and architectural patterns within your codebase.
  • Quality Assurance: Performs basic checks for formatting, broken links, and spelling to maintain high-quality documentation.
  • Use Case: Ensure your API reference, system architecture, or user guides are always in perfect sync with your latest code changes, preventing costly misunderstandings and reducing onboarding time for new team members.

Quick Start

From anywhere in your project, ask Claude: Run a documentation audit Check if our docs are up to date Validate documentation against code

Frequently Asked Questions about documentation-audit

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

FAQPage Schema
How do I validate documentation against code to catch outdated information?

Documentation audit systematically compares factual claims in your Markdown docs against actual code behavior to identify mismatches. Run the audit after code changes, during onboarding, or before release to ensure docs accurately reflect your codebase.

Can I check if my API reference and technical documentation are up to date?

Yes. The audit validates API references, system architecture diagrams, and configuration documentation by cross-referencing them against your code. It identifies undocumented features, missing parameters, and outdated examples in one pass.

What's the best way to find undocumented features and APIs in my codebase?

A documentation audit performs completeness checks across your repository, discovering undocumented features, APIs, configuration options, and architectural patterns. It flags gaps between what exists in code and what's documented in Markdown.

How do I fix documentation that doesn't match my code after a major refactor?

Run a multi-pass audit that indexes code, discovers claims in docs, extracts documentation facts, verifies accuracy against current behavior, and performs in-place repairs. The audit maintains a ledger of corrections for review.

Does documentation audit work with text-based diagrams and navigation structures?

Yes. The audit covers Markdown documentation, text-based diagrams, and repository navigation structures. It validates the accuracy and consistency of these elements alongside your code to ensure complete documentation alignment.