check-docs

Cross-reference documentation against source files to flag inconsistencies.

1|Updated Feb 28, 2026

Search Tags:#documentation #mermaid #adr #code-review #code-consistency #docs-audit

Ready to run

npx skills add https://github.com/im9/inboil --skill check-docs-im9

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: check-docs
Source: https://github.com/im9/inboil/tree/main/.claude/skills/check-docs
Command: npx skills add https://github.com/im9/inboil --skill check-docs-im9

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Check docs/ai/ spec files, ADRs, and site docs for inconsistencies with the actual codebase, enabling teams to catch drift without making changes.

Core Features & Use Cases

Scan and verify documentation across the repo (README.md, CLAUDE.md, BACKLOG.md, architecture.md, and data model / MESSAGE_FLOW docs) against code implementations.
Flag mismatches in parameter definitions, Mermaid diagrams, ADR statuses, and component references to keep docs aligned with code.
Use Case: a maintainer runs this audit to surface drift between docs and code, then reports findings without modifying any files.

Quick Start

Run the audit across docs and report any drift without changing any files

Frequently Asked Questions about check-docs

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

FAQPage Schema

How do I audit documentation for inconsistencies with my codebase?▼

To audit docs for code-consistency, cross-reference your documentation directories against key source files like types.ts and engine.ts. This flags mismatches in parameter definitions, component references, and ADR statuses without modifying any files.

How do I check if Mermaid diagrams and ADRs are aligned with the actual code?▼

Checking Mermaid diagram and ADR alignment involves cross-referencing documentation against actual code implementations like state.svelte.ts and worklet-processor.ts. The audit reports drift in ADR statuses and diagram logic without making changes.

What is documentation drift and how do I detect it without modifying files?▼

Documentation drift occurs when docs and code fall out of sync. You detect it by scanning architecture and data model docs against source files to surface mismatches, reporting findings like outdated parameter definitions without modifying any repository files.

Can I verify site docs and app help references against types.ts and paramDefs.ts?▼

Yes, you can verify site docs and app help references against types.ts and paramDefs.ts. The audit cross-references these specific source files to flag mismatches in component references and parameter definitions without altering your codebase.

Does the documentation audit automatically fix mismatches it finds?▼

No, the documentation audit does not automatically fix mismatches. It strictly flags inconsistencies and drift between your docs and codebase, enabling maintainers to review findings and manually update files without unintended modifications.

What's the best way to catch drift between internal AI docs and source files?▼

The best way to catch drift is running a cross-reference audit between internal AI docs under docs/ai/ and key source files like dsp/types.ts. This surfaces inconsistencies in parameter definitions and component references for maintainer review.