brooks-audit

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Brooks-Lint — Architecture Audit

Brooks-Lint — 架构审计

Setup

设置

  1. Read
    ../_shared/common.md
    for the Iron Law, Project Config, Report Template, and Health Score rules
  2. Read
    ../_shared/source-coverage.md
    for book-level coverage, exceptions, and tradeoffs
  3. Read
    ../_shared/decay-risks.md
    for symptom definitions and source attributions
  4. Read
    architecture-guide.md
    in this directory for the audit framework
  1. 阅读
    ../_shared/common.md
    ,了解铁律、项目配置、报告模板和健康评分规则
  2. 阅读
    ../_shared/source-coverage.md
    ,了解书籍层面的覆盖范围、例外情况和权衡因素
  3. 阅读
    ../_shared/decay-risks.md
    ,了解症状定义和来源说明
  4. 阅读当前目录下的
    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
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.
If the user has not specified files or a directory to audit: apply Auto Scope Detection from
../_shared/common.md
to determine the audit scope before proceeding.
  1. Gather codebase context and draw the module dependency graph as Mermaid (Steps 0–1 of the guide)
  2. Scan for each decay risk in the order specified (Steps 2–4 of the guide)
  3. Assign node colors in the Mermaid diagram based on findings (red/yellow/green) — after Step 4
  4. Run the Testability Seam Assessment (Step 5 of the guide)
  5. Run the Conway's Law check (Step 6 of the guide)
  6. Output using the Report Template from common.md — Mermaid graph FIRST, then Findings
Mode line in report:
Architecture Audit
入职模式: 如果用户要求提供入职报告、代码库浏览或“向新开发者讲解这个代码库”,请阅读当前目录下的
onboarding-guide.md
并遵循其流程,而非
architecture-guide.md
。此模式侧重于讲解而非诊断——不包含健康评分,也不涉及铁律相关发现。
如果用户未指定要审计的文件或目录: 在开始之前,先使用
../_shared/common.md
中的自动范围检测功能确定审计范围。
  1. 收集代码库上下文,并以Mermaid格式绘制模块依赖关系图(指南的步骤0–1)
  2. 按照指定顺序扫描每个衰退风险(指南的步骤2–4)
  3. 根据检测结果为Mermaid图中的节点分配颜色(红/黄/绿)——完成步骤4后进行
  4. 执行可测试性接缝评估(指南的步骤5)
  5. 执行康威定律检查(指南的步骤6)
  6. 使用common.md中的报告模板输出结果——先输出Mermaid图,再输出检测结果
报告中的模式行:
Architecture Audit