What problem does it solve?
This Skill automatically identifies discrepancies between C3 architecture documentation and the actual codebase, ensuring that documentation remains accurate and reflects the current implementation. It helps eliminate architectural drift and maintains documentation as a reliable source of truth.
Core Features & Use Cases
- Multiple Audit Modes: Supports Full, ADR-specific, ADR-Plan Coherence, Container-specific, and Quick audits.
- Documentation State Loading: Gathers a complete inventory of all C3 documents and their contents.
- Codebase Exploration: Uses advanced exploration to discover the actual codebase structure, technologies, and components.
- Drift Comparison: Systematically compares documented vs. actual state, categorizing findings by severity (inventory, technology, structure, protocol drift).
- ADR Implementation Verification: Checks if accepted ADRs have been correctly reflected in both documentation and code, and can transition ADR status to
implemented.
- Use Case: After a major refactoring, an architect runs a full audit using
c3-audit to pinpoint any documentation that no longer matches the code, generating a detailed report of necessary updates and ensuring the system remains well-documented.
Quick Start
Use the c3-audit skill to perform a full audit of the project's documentation.