improve-codebase-architecture

tarafından mattpocock

Bir kod tabanında derinleşme fırsatlarını bulur; CONTEXT.md dosyasındaki alan diline ve docs/adr/ içindeki kararlara dayanır. Kullanıcı mimariyi iyileştirmek, yeniden düzenleme fırsatları bulmak, sıkı bağlı modülleri birleştirmek veya kod tabanını daha test edilebilir ve yapay zeka tarafından gezilebilir hale getirmek istediğinde kullanılır.

npx skills add https://github.com/mattpocock/skills --skill improve-codebase-architecture

Improve Codebase Architecture

Surface architectural friction and propose deepening opportunities — refactors that turn shallow modules into deep ones. The aim is testability and AI-navigability.

Glossary

Use these terms exactly in every suggestion. Consistent language is the point — don't drift into "component," "service," "API," or "boundary." Full definitions in LANGUAGE.md.

  • Module — anything with an interface and an implementation (function, class, package, slice).
  • Interface — everything a caller must know to use the module: types, invariants, error modes, ordering, config. Not just the type signature.
  • Implementation — the code inside.
  • Depth — leverage at the interface: a lot of behaviour behind a small interface. Deep = high leverage. Shallow = interface nearly as complex as the implementation.
  • Seam — where an interface lives; a place behaviour can be altered without editing in place. (Use this, not "boundary.")
  • Adapter — a concrete thing satisfying an interface at a seam.
  • Leverage — what callers get from depth.
  • Locality — what maintainers get from depth: change, bugs, knowledge concentrated in one place.

Key principles (see LANGUAGE.md for the full list):

  • Deletion test: imagine deleting the module. If complexity vanishes, it was a pass-through. If complexity reappears across N callers, it was earning its keep.
  • The interface is the test surface.
  • One adapter = hypothetical seam. Two adapters = real seam.

This skill is informed by the project's domain model. The domain language gives names to good seams; ADRs record decisions the skill should not re-litigate.

Process

1. Explore

Read the project's domain glossary and any ADRs in the area you're touching first.

Then use the Agent tool with subagent_type=Explore to walk the codebase. Don't follow rigid heuristics — explore organically and note where you experience friction:

  • Where does understanding one concept require bouncing between many small modules?
  • Where are modules shallow — interface nearly as complex as the implementation?
  • Where have pure functions been extracted just for testability, but the real bugs hide in how they're called (no locality)?
  • Where do tightly-coupled modules leak across their seams?
  • Which parts of the codebase are untested, or hard to test through their current interface?

Apply the deletion test to anything you suspect is shallow: would deleting it concentrate complexity, or just move it? A "yes, concentrates" is the signal you want.

2. Present candidates as an HTML report

Write a self-contained HTML file to the OS temp directory so nothing lands in the repo. Resolve the temp dir from $TMPDIR, falling back to /tmp (or %TEMP% on Windows), and write to <tmpdir>/architecture-review-<timestamp>.html so each run gets a fresh file. Open it for the user — xdg-open <path> on Linux, open <path> on macOS, start <path> on Windows — and tell them the absolute path.

The report uses Tailwind via CDN for layout and styling, and Mermaid via CDN for diagrams where a graph/flow/sequence reliably communicates the structure. Mix Mermaid with hand-crafted CSS/SVG visuals — use Mermaid when relationships are graph-shaped (call graphs, dependencies, sequences), and hand-built divs/SVG when you want something more editorial (mass diagrams, cross-sections, collapse animations). Each candidate gets a before/after visualisation. Be visual.

For each candidate, the same template as before, but rendered as a card:

  • Files — which files/modules are involved
  • Problem — why the current architecture is causing friction
  • Solution — plain English description of what would change
  • Benefits — explained in terms of locality and leverage, and how tests would improve
  • Before / After diagram — side-by-side, custom-drawn, illustrating the shallowness and the deepening
  • Recommendation strength — one of Strong, Worth exploring, Speculative, rendered as a badge

End the report with a Top recommendation section: which candidate you'd tackle first and why.

Use CONTEXT.md vocabulary for the domain, and LANGUAGE.md vocabulary for the architecture. If CONTEXT.md defines "Order," talk about "the Order intake module" — not "the FooBarHandler," and not "the Order service."

ADR conflicts: if a candidate contradicts an existing ADR, only surface it when the friction is real enough to warrant revisiting the ADR. Mark it clearly in the card (e.g. a warning callout: "contradicts ADR-0007 — but worth reopening because…"). Don't list every theoretical refactor an ADR forbids.

See HTML-REPORT.md for the full HTML scaffold, diagram patterns, and styling guidance.

Do NOT propose interfaces yet. After the file is written, ask the user: "Which of these would you like to explore?"

3. Grilling loop

Once the user picks a candidate, drop into a grilling conversation. Walk the design tree with them — constraints, dependencies, the shape of the deepened module, what sits behind the seam, what tests survive.

Side effects happen inline as decisions crystallize:

  • Naming a deepened module after a concept not in CONTEXT.md? Add the term to CONTEXT.md — same discipline as /grill-with-docs (see CONTEXT-FORMAT.md). Create the file lazily if it doesn't exist.
  • Sharpening a fuzzy term during the conversation? Update CONTEXT.md right there.
  • User rejects the candidate with a load-bearing reason? Offer an ADR, framed as: "Want me to record this as an ADR so future architecture reviews don't re-suggest it?" Only offer when the reason would actually be needed by a future explorer to avoid re-suggesting the same thing — skip ephemeral reasons ("not worth it right now") and self-evident ones. See ADR-FORMAT.md.
  • Want to explore alternative interfaces for the deepened module? See INTERFACE-DESIGN.md.

mattpocock tarafından daha fazla skill

grill-me
mattpocock
Kullanıcıyı bir plan veya tasarım hakkında ortak bir anlayışa varılana kadar amansızca sorgulayın, karar ağacının her dalını çözümleyin. Kullanıcı bir planı strese test etmek, tasarımı hakkında sorgulanmak istediğinde veya "grill me" dediğinde kullanın.
researchcommunicationproject-management
grill-with-docs
mattpocock
Mevcut alan modeline karşı planınızı sorgulayan, terminolojiyi netleştiren ve kararlar netleştikçe belgeleri (CONTEXT.md, ADR'ler) anında güncelleyen bir ızgara oturumu. Kullanıcı, projesinin dili ve belgelenmiş kararlarına karşı bir planı teste tabi tutmak istediğinde kullanın.
developmentdocumentresearch
teach
mattpocock
Kullanıcıya bu çalışma alanı içinde yeni bir beceri veya konsept öğret.
communicationproductivity
tdd
mattpocock
Kırmızı-yeşil-yeniden düzenleme döngüsüyle test odaklı geliştirme. Kullanıcı TDD kullanarak özellik geliştirmek veya hata düzeltmek istediğinde, "kırmızı-yeşil-yeniden düzenleme"den bahsettiğinde, entegrasyon testleri istediğinde veya test-ilk geliştirme talep ettiğinde kullanılır.
developmenttesting
to-prd
mattpocock
Mevcut konuşma bağlamını bir PRD'ye dönüştürün ve proje sorun takipçisine yayınlayın. Kullanıcının mevcut bağlamdan bir PRD oluşturmak istediğinde kullanın.
developmentdocumentproject-management
handoff
mattpocock
Mevcut konuşmayı, başka bir agent'ın devralması için bir handoff belgesine sıkıştır.
communicationproject-managementdocument
diagnose
mattpocock
Zor hatalar ve performans gerilemeleri için disiplinli teşhis döngüsü. Tekrarla → küçült → hipotez kur → enstrüman ekle → düzelt → regresyon testi yap. Kullanıcı "bunu teşhis et" / "bunu hata ayıkla" dediğinde, bir hata bildirdiğinde, bir şeyin bozuk/throw atan/başarısız olduğunu söylediğinde veya bir performans gerilemesi tanımladığında kullan.
developmenttestingcode-review
to-issues
mattpocock
Bir planı, spesifikasyonu veya PRD'yi, iz sürücü mermi dikey dilimler kullanarak proje sorun takipçisinde bağımsız olarak alınabilir sorunlara bölün. Kullanıcı bir planı sorunlara dönüştürmek, uygulama biletleri oluşturmak veya işi sorunlara ayırmak istediğinde kullanın.
developmentproject-management