MCPInstall

improve-codebase-architecture

扫描代码库中的深化机会,生成可视化 HTML 报告,然后围绕你选中的候选项继续追问。

Installs
5.9K
Last 24h
+22
Trending rank
#5335
Security
Pass

Install

Works with every agent the skills CLI supports.

npx skills add https://github.com/vinvcn/mattpocock-skills-zh-cn --skill improve-codebase-architecture
  1. 01

    Install

    Run the command in your project. The CLI asks which agents to install for.

  2. 02

    Describe the task

    Ask your agent for something this skill covers. It loads improve-codebase-architecture automatically when relevant.

  3. 03

    Review the result

    The agent follows the SKILL.md steps, scripts and references bundled with the skill.

Security audits

Independent scans of the skill's instructions and bundled files.

Gen Agent Trust Hub PassSAFE ·The skill scans a codebase to suggest architectural improvements and generates a visual HTML report. It reads local files, analyzes commit history with git, and uses well-known CDN-hosted libraries for report visualization.
Socket PassNo alerts
Snyk PassLOW ·Risk: LOW · No issues

SKILL.md

The instructions your agent reads when the skill is triggered.

改进代码库架构

暴露 architectural friction,并提出 deepening opportunities:把 shallow modules 变成 deep modules 的 refactors。目标是 testability 和 AI-navigability。

这个命令由项目的 domain model 提供信息,并建立在共享 design vocabulary 上:

  • 调用 Skill 工具并指定 codebase-design,获取 architecture vocabulary(module、interface、depth、seam、adapter、leverage、locality)及其 principles(deletion test、"the interface is the test surface"、"one adapter = hypothetical seam, two = real")。每条建议都准确使用这些术语,不要漂移到 "component"、"service"、"API" 或 "boundary"。
  • GLOSSARY.md 中的 domain language 会为好的 seams 命名;docs/adr/ 中的 ADRs 记录这个命令不应重新争论的 decisions。

流程

1. 探索

先划定扫描范围:YAGNI。 深化 module 的收益在于让未来修改更容易,因此要更关注最近仍在变化的 codebase 区域。开始探索前先决定去哪里看:

  • 如果用户点名了方向(module、subsystem 或 pain point),就按该方向探索,跳过下面的推断。
  • 否则,向前回看一段足够长的 commit history(git log --oneline),找出反复出现的 files 和 areas,让这些 hot spots 成为首要关注点。如果变更分散、没有明显 hot spot,再扩大范围。

先读取项目 domain glossary(GLOSSARY.md)以及你将触碰区域的 ADRs。

然后 spawn 一个 sub-agent 来遍历 codebase。不要套死板 heuristics;自然探索,并记录你感到 friction 的地方:

  • 理解一个概念是否需要在许多小 modules 之间来回跳?
  • 哪些 modules 是 shallow 的,即 interface 几乎和 implementation 一样复杂?
  • 是否存在为了 testability 抽出的 pure functions,但真正 bugs 藏在它们如何被调用之处(没有 locality)?
  • 哪些 tightly-coupled modules 泄漏到了 seams 之外?
  • Codebase 的哪些部分未测试,或很难通过当前 interface 测试?

对任何你怀疑 shallow 的东西应用 deletion test:删除它会让复杂度集中,还是只把复杂度移动到别处?"yes, concentrates" 才是你要的 signal。

2. 用 HTML 报告呈现候选项

把 self-contained HTML file 写到 OS temp directory,避免任何内容落进 repo。Temp dir 从 $TMPDIR 解析,fallback 到 /tmp(Windows 用 %TEMP%),写到 <tmpdir>/architecture-review-<timestamp>.html,让每次运行都有新文件。为用户打开它:Linux 用 xdg-open <path>,macOS 用 open <path>,Windows 用 start <path>,并告诉用户 absolute path。

Report 使用 Tailwind via CDN 做 layout/styling,用 Mermaid via CDN 做能可靠传达结构的 diagrams。Mermaid 和手写 CSS/SVG visuals 可以混用:关系是 graph-shaped(call graphs、dependencies、sequences)时用 Mermaid;需要 editorial 表达(mass diagrams、cross-sections、collapse animations)时用手写 divs/SVG。每个 candidate 都要有 before/after visualisation。要视觉化。

每个 candidate 渲染一张 card,包含:

  • Files - 涉及哪些 files/modules
  • Problem - 当前 architecture 为什么造成 friction
  • Solution - 会改变什么,用平实的语言描述
  • Benefits - 用 locality 与 leverage 解释收益,以及 tests 如何改善
  • Before / After diagram - side-by-side,自绘,说明 shallowness 与 deepening
  • Recommendation strength - Strong、Worth exploring、Speculative 之一,渲染为 badge

Report 末尾包含首选推荐区:你会先处理哪个 candidate,以及为什么。

用 GLOSSARY.md vocabulary 表达 domain,用 /codebase-design vocabulary 表达 architecture。 如果 GLOSSARY.md 定义了 "Order",就说 "Order intake module",不要说 "FooBarHandler",也不要说 "Order service"。

ADR conflicts:如果 candidate 与现有 ADR 冲突,只有在 friction 真实到值得重新打开 ADR 时才提出。Card 中明确标记(例如 warning callout:"contradicts ADR-0007 - but worth reopening because...")。不要列出 ADR 理论上禁止的每个 refactor。

完整 HTML scaffold、diagram patterns 和 styling guidance 见 HTML-REPORT.md。

现在不要提出 interfaces。写完文件后问用户:"Which of these would you like to explore?"

3. Grilling 循环

用户选中 candidate 后,调用 Skill 工具并指定 grilling,与用户走完 decision tree:constraints、dependencies、deepened module 的形状、seam 后面放什么、哪些 tests 能保留。

Side effects 随 decisions 成形而内联发生;调用 Skill 工具并指定 domain-modeling,让 domain model 保持最新:

  • 要用 GLOSSARY.md 中不存在的概念命名 deepened module? 把 term 加入 GLOSSARY.md。若文件不存在,按需创建。
  • 对话中打磨了 fuzzy term? 立即更新 GLOSSARY.md。
  • 用户以 load-bearing reason 拒绝了 candidate? 提议写 ADR,表述为:"Want me to record this as an ADR so future architecture reviews don't re-suggest it?" 只有当未来 explorer 确实需要该 reason 以避免再次提出同样建议时才提议;跳过临时原因("not worth it right now")和显而易见原因。
  • 想探索 deepened module 的 alternative interfaces? 调用 Skill 工具并指定 codebase-design,并使用其中的 design-it-twice parallel sub-agent pattern。

FAQ

What does the improve-codebase-architecture skill do?

扫描代码库中的深化机会,生成可视化 HTML 报告,然后围绕你选中的候选项继续追问。

How do I install improve-codebase-architecture?

Run npx skills add https://github.com/vinvcn/mattpocock-skills-zh-cn --skill improve-codebase-architecture in your project. The skills CLI detects the agents you use and copies the skill into the right folder. For Claude Code you can also place the skill folder at ~/.claude/skills/improve-codebase-architecture/ (personal) or .claude/skills/improve-codebase-architecture/ (project).

Which AI agents can use improve-codebase-architecture?

Any agent that supports the open Agent Skills format (a folder with a SKILL.md file), including Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, Windsurf, Cline, OpenCode and more.

Is improve-codebase-architecture safe to install?

Security partners have reviewed it: Gen Agent Trust Hub passed; Socket passed; Snyk passed. As with any skill, read the SKILL.md and bundled scripts before installing.

Who maintains improve-codebase-architecture?

It is published by vinvcn in vinvcn/mattpocock-skills-zh-cn. It has 5,881 recorded installs.

More from vinvcn/mattpocock-skills-zh-cn

View all →

grill-me

vinvcn/mattpocock-skills-zh-cn

一个用来打磨计划或设计的持续追问式访谈。

6.7K installs

grill-with-docs

vinvcn/mattpocock-skills-zh-cn

一个用来打磨计划或设计的持续追问式访谈,并在过程中创建文档(ADRs 和词汇表)。

Docs & Writing6.3K installs

setup-matt-pocock-skills

vinvcn/mattpocock-skills-zh-cn

为此仓库配置 engineering skills:设置其 issue tracker、triage labels 词汇与 domain docs 布局。在首次使用其他 engineering skills 前运行一次。

Docs & Writing6K installs

tdd

vinvcn/mattpocock-skills-zh-cn

测试驱动开发。适用于用户想用先写测试的方式构建功能或修复缺陷、提到 “red-green-refactor”,或需要集成测试时。

Testing & QA5.9K installs

handoff

vinvcn/mattpocock-skills-zh-cn

把当前对话压缩成交接文档,让另一个代理接手。

prototype

vinvcn/mattpocock-skills-zh-cn

构建一次性原型来回答一个设计问题。适用于用户想验证某个 state model 或 logic 是否感觉对,或探索 UI 应该长什么样时。

Frontend & Design5.8K installs

Popular code quality & workflow skills

View category →

grill-me

mattpocock/skills

A relentless interview to sharpen a plan or design.

Scan a codebase for deepening opportunities, present them as a visual HTML report, then grill through whichever one you pick.

handoff

mattpocock/skills

Compact the current conversation into a handoff document for another agent to pick up.

domain-modeling

mattpocock/skills

Build and sharpen a project's domain model. Use when discussing codebase terminology, writing or editing a GLOSSARY.md, or recording or editing an ADR.

codebase-design

mattpocock/skills

Shared vocabulary for designing deep modules. Use when the user wants to design or improve a module's interface, find deepening opportunities, decide where a seam goes, make code more testable or AI-navigable, or when another skill needs the deep-module vocabulary.

diagnosing-bugs

mattpocock/skills

Diagnosis loop for hard bugs and performance regressions. Use when the user says "diagnose"/"debug this", or reports something broken/throwing/failing/slow.