skills.rest
ahrav
ahravCOMMUNITY
Explore all skills by this author →
GitHub

doc-code-audit

Audit documentation and diagrams against codebase types, signatures, and invariants.

1|Updated Feb 12, 2026
Search Tags:#documentation#drift detection#technical writing#verification#code audit#consistency check
One-click install
npx skills add https://github.com/ahrav/Gossip-rs --skill doc-code-audit
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: doc-code-audit
Source: https://github.com/ahrav/Gossip-rs/tree/main/.claude/skills/doc-code-audit
Command: npx skills add https://github.com/ahrav/Gossip-rs --skill doc-code-audit

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill ensures that your project's documentation accurately reflects the current state of the codebase, preventing outdated information from causing confusion or errors.

Core Features & Use Cases

  • Automated Consistency Checks: Verifies documentation against actual code for types, signatures, invariants, and more.
  • Incremental & Full Audits: Supports checking only recent changes or a comprehensive review of all documentation.
  • Domain Scoping: Allows auditing specific feature areas or modules of the codebase.
  • Use Case: After a significant refactor, run an incremental audit to catch any documentation that has become stale or incorrect due to the code changes.

Quick Start

Run an incremental audit of the documentation against the codebase.

Frequently Asked Questions about doc-code-audit

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

FAQPage Schema
How do I check documentation for consistency against my codebase after a refactor?▼

Run an incremental audit to verify documentation consistency against recent codebase changes. This checks type names, function signatures, invariants, and state machines, catching stale information caused by refactoring without requiring a full manual review.

What is documentation drift detection and when do I need to run it?▼

Documentation drift detection identifies discrepancies between written technical documentation and actual code behavior. You need it when prose claims, type definitions, or function signatures become outdated and no longer match the codebase.

Can I audit documentation for only a specific feature area or module?▼

Yes, domain scoping allows you to audit specific feature areas or modules within the codebase. This targets verification to particular domains rather than scanning the entire project documentation set unnecessarily.

What is the best way to verify technical writing claims against actual code logic?▼

The best way is running an automated code audit that cross-references prose claims, type names, and function signatures against the actual codebase, using parallel specialist agents to synthesize findings into an actionable report.

Does a full documentation audit require scanning the entire codebase every time?▼

No, you can use incremental audit mode to check only recent changes instead of scanning the entire codebase. Full audit mode is available for comprehensive reviews, while incremental mode targets only recent modifications.

Related Skills

Explore More Software Engineering Skills→
zero-rehqzero-rehq

api-documentation-generator

Generate OpenAPI specs from TypeScript Express, Next.js, and Fastify source code.

Community
Intermediate
im9im9
1

sync-docs

Scan project documentation for inconsistencies with the codebase and output a prioritized task list.

Community
Advanced
TheFJKTheFJK
2

uberdev-cmd-merge

Automates merging of pull requests into integration branches with conflict resolution and local sync.

Community
Advanced
stephanjstephanj
9

code-documenter

Generate docstrings, OpenAPI specs, and developer guides from source code.

Community
Advanced