codebase-design

A skill in mattpocock/skills · 321,860 stars on GitHub

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.

Security grade of this SKILL.md: SAFE · how we grade

How to install codebase-design

npx skills add mattpocock/skills --skill codebase-design -a claude-code

The skills CLI copies this one skill into Claude Code (use -a for another agent). Or read its SKILL.md on GitHub.

What the SKILL.md says

Design deep modules: a lot of behaviour behind a small interface, placed at a clean seam, testable through that interface. Use this language and these principles wherever code is being designed or restructured. The aim is leverage for callers, locality for maintainers, and testability for everyone. Use these terms exactly: don't substitute "component," "service," "API," or "boundary." Consistent language is the whole point. Module: anything with an interface and an implementation. Deliberately scale-agnostic: a function, class, package, or tier-spanning slice. _Avoid_: unit, component, service. Interface: everything a caller must know to use the module correctly: the type signature, but also invariants, ordering constraints, error modes, required configuration, and performance characteristics. _Avoid_: API, signature (too narrow, they refer only to the type-level surface).

Other skills in mattpocock/skills

  • ask-matt Ask which skill or flow fits your situation. A router over the skills in this repo.
  • code-review Review the changes since a fixed point (commit, branch, tag, or merge-base) along two axes: Standards (does the code follow this repo's doc…
  • diagnosing-bugs Diagnosis loop for hard bugs and performance regressions. Use when the user says "diagnose"/"debug this", or reports something broken/throw…
  • domain-modeling Build and sharpen a project's domain model. Use when discussing codebase terminology, writing or editing a GLOSSARY.md, or recording or edi…
  • git-guardrails-claude-code Set up Claude Code hooks to block dangerous git commands (push, reset --hard, clean, branch -D, etc.) before they execute. Use when user wa…
  • grill-me A relentless interview to sharpen a plan or design.
  • grill-with-docs A relentless interview to sharpen a plan or design, which also creates docs (ADR's and glossary) as we go.
  • grilling Grill the user relentlessly about a plan, decision, or idea. Use when the user wants to stress-test their thinking, or uses any 'grill' tri…
  • handoff Compact the current conversation into a handoff document for another agent to pick up.
  • implement Implement a piece of work based on a spec or set of tickets.
  • implement-spec Implement the result of /to-spec and /to-tickets in code.
  • improve-codebase-architecture Scan a codebase for deepening opportunities, present them as a visual HTML report, then grill through whichever one you pick.
  • migrate-to-shoehorn Migrate test files from `as` type assertions to @total-typescript/shoehorn. Use when user mentions shoehorn, wants to replace `as` in tests…
  • prototype Build a throwaway prototype to answer a design question. Use when the user wants to sanity-check whether a state model or logic feels right…
  • research Investigate a question against high-trust primary sources and capture the findings as a Markdown file in the repo. Use when the user wants…
  • retro Conduct a retrospective on a coding session.
  • scaffold-exercises Create exercise directory structures with sections, problems, solutions, and explainers that pass linting. Use when user wants to scaffold…
  • setup-matt-pocock-skills Configure this repo for the engineering skills: set up its issue tracker, triage label vocabulary, and domain doc layout. Run once before f…
  • setup-pre-commit Set up Husky pre-commit hooks with lint-staged (Prettier), type checking, and tests in the current repo. Use when user wants to add pre-com…
  • tdd Test-driven development. Use when the user wants to build features or fix bugs test-first, mentions "red-green-refactor", or wants integrat…