brooks-audit
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChineseBrooks-Lint — Architecture Audit
Brooks-Lint — 架构审计
Setup
设置
- Read for the Iron Law, Project Config, Report Template, and Health Score rules
../_shared/common.md - Read for book-level coverage, exceptions, and tradeoffs
../_shared/source-coverage.md - Read for symptom definitions and source attributions
../_shared/decay-risks.md - Read in this directory for the audit framework
architecture-guide.md
- 阅读,了解铁律、项目配置、报告模板和健康评分规则
../_shared/common.md - 阅读,了解书籍层面的覆盖范围、例外情况和权衡因素
../_shared/source-coverage.md - 阅读,了解症状定义和来源说明
../_shared/decay-risks.md - 阅读当前目录下的,掌握审计框架
architecture-guide.md
Process
流程
Onboarding mode: If the user asks for an onboarding report, codebase tour, or
"explain this codebase to a new developer", read from this
directory and follow it instead of . This mode explains rather
than diagnoses — no Health Score, no Iron Law findings.
onboarding-guide.mdarchitecture-guide.mdIf the user has not specified files or a directory to audit: apply Auto Scope
Detection from to determine the audit scope before proceeding.
../_shared/common.md- 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入职模式: 如果用户要求提供入职报告、代码库浏览或“向新开发者讲解这个代码库”,请阅读当前目录下的并遵循其流程,而非。此模式侧重于讲解而非诊断——不包含健康评分,也不涉及铁律相关发现。
onboarding-guide.mdarchitecture-guide.md如果用户未指定要审计的文件或目录: 在开始之前,先使用中的自动范围检测功能确定审计范围。
../_shared/common.md- 收集代码库上下文,并以Mermaid格式绘制模块依赖关系图(指南的步骤0–1)
- 按照指定顺序扫描每个衰退风险(指南的步骤2–4)
- 根据检测结果为Mermaid图中的节点分配颜色(红/黄/绿)——完成步骤4后进行
- 执行可测试性接缝评估(指南的步骤5)
- 执行康威定律检查(指南的步骤6)
- 使用common.md中的报告模板输出结果——先输出Mermaid图,再输出检测结果
报告中的模式行:
Architecture Audit