mcpField
B
brooks-audit

brooks-audit

github.com/hyhmrright开发1.6k317 次安装2 天前更新
代码仓库

关于 brooks-audit

用于审计代码库架构并报告衰退风险的 Brooks-Lint 技能。也可切换到入门模式,侧重讲解代码库而非诊断问题。

主要功能

  1. 01绘制 Mermaid 模块依赖图
  2. 02扫描架构衰退风险
  3. 03评估可测试性接缝
  4. 04检查 Conway's Law 对齐情况
  5. 05生成代码库入门讲解

适用场景

  1. 01审查代码库的架构健康状况
  2. 02查找模块依赖和衰退问题
  3. 03为新开发者准备代码库导览

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/hyhmrright/brooks-lint --skill brooks-audit

安装后在 Claude Code 中输入/brooks-audit确认已加载。

附带文件architecture-guide.mdonboarding-guide.md

详细介绍

Brooks-Lint — 架构审计

设置

按顺序阅读:

  1. ../_shared/common.md — 铁律、项目配置、报告模板、健康评分
  2. ../_shared/source-coverage.md — 书籍覆盖范围、例外情况、权衡
  3. ../_shared/decay-risks.md — 症状定义和来源归属
  4. architecture-guide.md(当前目录)— 审计框架

流程

引导模式: 如果用户要求引导报告、代码库导览,或“向新开发者解释此代码库”,请阅读当前目录中的 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

评论

支持 Markdown