audit-docs

Detect documentation drift between project docs and repository code.

4|1|Updated Dec 7, 2025
One-click install
npx skills add https://github.com/cacack/my-family --skill audit-docs-cacack
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: audit-docs
Source: https://github.com/cacack/my-family/tree/main/.claude/skills/audit-docs
Command: npx skills add https://github.com/cacack/my-family --skill audit-docs-cacack

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Project documentation often diverges from the actual repository state, causing onboarding friction, incorrect developer assumptions, and broken build or deployment expectations. This Skill performs a focused, read-only comparison between documentation and code to surface missing files, stale technology lists, inconsistent convention references, and broken internal links.

Core Features & Use Cases

  • Architecture Tree Comparison: Extracts the internal/ directory tree described in CLAUDE.md and compares it to the actual internal/* and internal/repository/* directory listings to find missing or undocumented directories.
  • Package & Technology Verification: Compares technologies listed in CLAUDE.md and CONVENTIONS.md against go.mod and web/package.json to detect undocumented or stale dependencies.
  • Entity Matrix & Generated Code Checks: Cross-references docs/INTEGRATION-MATRIX.md with event types in internal/repository/eventstore.go and read model structs in internal/repository/readmodel.go, and verifies presence of internal/api/openapi.yaml, internal/api/generated.go, and web/src/lib/api/types.generated.ts.
  • Link Integrity and Convention Consistency: Validates relative markdown links within the audited docs and checks that commit/convention references point to docs/CONVENTIONS.md as canonical.
  • Use Case Example: A technical writer or maintainer runs the audit before a release to ensure docs, API artifacts, and dependency lists are accurate.

Quick Start

Perform a read-only audit that compares CLAUDE.md, docs/CONVENTIONS.md, docs/INTEGRATION-MATRIX.md, go.mod, web/package.json, internal/ and internal/repository/ directory contents, and generated API artifacts, then produce the structured Doc-Drift 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 detect documentation drift between my markdown files and codebase?▼

To detect documentation drift, you can run a read-only audit that compares project markdown files like CLAUDE.md and docs/CONVENTIONS.md against the actual repository codebase to surface missing files, stale dependencies, and inconsistent references.

How do I check if my technical documentation matches the actual project dependencies?▼

You can check if technical documentation matches project dependencies by parsing go.mod and web/package.json, then cross-referencing the listed technologies against the dependencies documented in CLAUDE.md and CONVENTIONS.md to find stale or undocumented packages.

Why does my integration matrix have event types missing from the codebase?▼

Your integration matrix may list event types missing from the codebase due to documentation drift, which happens when internal/repository/eventstore.go and readmodel.go structs are updated without syncing changes back to docs/INTEGRATION-MATRIX.md.

How do I validate relative markdown links and convention references in my docs?▼

To validate relative markdown links, you can perform a read-only audit that checks link integrity within the audited docs and verifies that commit and convention references correctly point to docs/CONVENTIONS.md as the canonical source.

Can I audit generated API artifacts and directory trees without modifying the repository?▼

Yes, you can audit generated API artifacts like internal/api/openapi.yaml and directory trees without modifying the repository, because the documentation drift detection requires read-only access to list directories, open files, and parse dependency files.

What is the best way to find undocumented directories in my internal codebase?▼

The best way to find undocumented directories in your internal codebase is to extract the internal/ directory tree described in CLAUDE.md and compare it against the actual internal/* and internal/repository/* directory listings to identify missing entries.