documentation-auditor

Audits AI-context documentation against code, tests, and schemas to detect stale or contradictory claims.

3|2|Updated Jul 3, 2026
One-click install
npx skills add https://github.com/escogido/knowledge-cairn --skill documentation-auditor-escogido
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation-auditor
Source: https://github.com/escogido/knowledge-cairn/tree/main/system/.agents/skills/documentation-auditor
Command: npx skills add https://github.com/escogido/knowledge-cairn --skill documentation-auditor-escogido

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Over time, project documentation drifts from the code it describes: rules go stale, resolved issues stay listed as open, and docs contradict each other or the repository. This Skill performs a read-only, out-of-cycle integrity audit that checks AI-context documentation against actual repository evidence and reports discrepancies with severity ratings. ## Core Features & Use Cases - Evidence-Based Verification: Classifies claims as descriptive or normative and resolves them against code, tests, scripts, schemas, and generated artifacts using a defined evidence hierarchy. - Structured Discrepancy Report: Produces a standardized audit report with severity levels (blocker, material, minor), code-backed findings, mechanical fixes, and decisions requiring user input. - Scoped Audit Breadth: Defaults to the narrowest audit that answers the request, expanding into source evidence only where a discrepancy requires verification. - Use Case: After several months of development, ask for a documentation integrity audit to find stale lifecycle rules, broken file references, missing frontmatter, and docs that contradict current code—then apply only the mechanical fixes you authorize. ## Quick Start Audit the AI-context documentation for integrity and report any discrepancies against current repository evidence.

Frequently Asked Questions about documentation-auditor

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

FAQPage Schema
How do I check if my project documentation is out of date?

Invoke the documentation audit to compare docs against repository evidence like code, tests, scripts, and schemas. It reports discrepancies with severity ratings and identifies which side is stale, without modifying any files.

What does a documentation integrity audit check for?

It checks contradictions between doc tiers, stale lifecycle rules, outdated source-of-truth claims, broken file references, missing frontmatter fields, obsolete references to removed files, and docs that contradict code or tests.

Does the documentation auditor modify my files?

No, the audit is strictly read-only. It may propose exact documentation patches in its report, but applying any fix is a separate step that requires explicit user authorization.

How is a documentation audit different from task finalization?

Finalization asks what changed during a completed task and which docs must update because of it. The audit asks whether docs currently contradict each other or repository evidence regardless of any task, and it is never run automatically during finalization.

When should I not run a full documentation audit?

Avoid broad audits when you only need to verify a specific claim or file. The auditor defaults to the narrowest scope that answers the request and never inspects archived task records, so name the specific docs or discrepancies you want checked.