About brooks-audit
A Brooks-Lint skill for auditing codebase architecture and reporting decay risks. It can also switch to an onboarding mode that explains a codebase rather than diagnosing it.
Key features
- 01Building a Mermaid module dependency graph
- 02Scanning architecture decay risks
- 03Assessing testability seams
- 04Checking Conway's Law alignment
- 05Generating onboarding explanations
Use cases
- 01Reviewing a codebase's architectural health
- 02Finding module dependency and decay issues
- 03Preparing a codebase tour for new developers
Install
Copy the command and run it in a terminal.
npx skills add https:/ / github.com/ hyhmrright/ brooks-lint --skill brooks-auditAfter installing, type/brooks-auditin Claude Code to confirm it loaded.
Bundled filesarchitecture-guide.mdonboarding-guide.md
Details
From the project READMEBrooks-Lint — Architecture Audit
Setup
Read in order:
../_shared/common.md— Iron Law, Project Config, Report Template, Health Score../_shared/source-coverage.md— book coverage, exceptions, tradeoffs../_shared/decay-risks.md— symptom definitions and source attributionsarchitecture-guide.md(this directory) — the audit framework
Process
Onboarding mode: If the user asks for an onboarding report, codebase tour, or
"explain this codebase to a new developer", read onboarding-guide.md from this
directory and follow it instead of architecture-guide.md. This mode explains rather
than diagnoses — no Health Score, no Iron Law findings.
Scope: if the user did not specify files or a directory, apply Auto Scope Detection
(../_shared/common.md) first.
- Gather codebase context and draw the module dependency graph as Mermaid (Steps 0–1 of the guide)
- Scan for each decay risk in the order specified (Steps 2–4 of the guide)
- Assign node colors in the Mermaid diagram based on findings (red/yellow/green) — after Step 4
- Run the Testability Seam Assessment (Step 5 of the guide)
- Run the Conway's Law check (Step 6 of the guide)
- Output using the Report Template from common.md — Mermaid graph FIRST, then Findings
Mode line in report: Architecture Audit