c3-audit_skill

Overview

This skill audits C3 architecture documentation for consistency, drift, and completeness. It verifies that the project has adopted C3 and runs a 10-phase audit to compare docs with code, check classifications, validate references, and surface actionable failures and warnings. The skill stops immediately if the .c3/README.md is missing and directs users to onboarding if needed.

How this skill works

The skill first confirms the presence of .c3/README.md, then loads required reference checks from the built-in references folder. It executes the prescribed 10-phase audit: gathering docs, comparing inventory to code, validating component categories and code references, checking diagrams, ADR lifecycle, ref files, abstraction boundaries, content separation, and context files. Results are returned in a compact table of phase statuses, a summary tally of passes/warnings/fails, and prioritized action items.

When to use it

• Audit C3 docs after merges, releases, or onboarding
• Validate docs when you suspect documentation drift or missing references
• Check architecture consistency before major refactors
• Run the audit after CI failures that may be doc-related
• Verify ADRs, diagrams, and code references are current

Best practices

• Ensure .c3/README.md exists before running the audit; stop and onboard if missing
• Run discovery-based audits after large code changes to compare code reality against docs
• Keep code-reference paths in components synchronized with the codebase
• Treat failures as concrete action items and route doc edits to c3-change
• Route pattern and reference corrections to c3-ref and architecture queries to c3-query

Example use cases

• Run a pre-release audit to ensure no docs are out of sync with code
• Validate a recent migration that may have moved or renamed referenced files
• Confirm ADRs are in expected lifecycle states before public design reviews
• Check diagrams and abstraction boundaries after adding a new service
• Perform a discovery-based health check following a large refactor