Проектирование глубоких модулей

Задаёт общий словарь для глубоких модулей — интерфейс, шов, адаптер, глубина — с тестом на удаление, видами зависимостей и проектированием в нескольких вариантах через субагентов. Для случаев, когда нужно придумать интерфейс модуля или место шва.

РазработкаПак: Скиллы Мэтта Покока114 строкcodebase-design
Автор
Источник
mattpocock/skills/skills/engineering/codebase-design @ abeeaf9
Лицензия
MIT · Copyright (c) 2026 Matt Pocock

Об этом скилле

Что делает

Скилл задаёт словарь и короткий набор правил для «глубоких» модулей: много поведения за маленьким интерфейсом, на чистом шве (seam), с тестами через этот интерфейс. Он закрепляет термины — module, interface, depth, seam, adapter, leverage, locality — и не даёт агенту подменять их словами «компонент», «сервис», «API» или «граница». Интерфейс — это всё, что нужно знать вызывающему коду: типы, а ещё инварианты, порядок вызовов, режимы ошибок и производительность. Правила: глубина — свойство интерфейса; тест на удаление (удалите модуль — сложность исчезнет или расползётся по вызывающим?); интерфейс и есть поверхность для тестов; один адаптер — шов гипотетический, два — настоящий.

DEEPENING.md делит зависимости на четыре вида — внутри процесса, с локальной заменой вроде PGLite, свой удалённый сервис за портом, сторонний сервис за моком — и для каждого говорит, как тестировать; когда у нового интерфейса есть тесты, старые юнит-тесты мелких модулей удаляются. По DESIGN-IT-TWICE.md три и более субагента проектируют принципиально разные интерфейсы: минимальный, гибкий, удобный для самого частого вызова, на портах и адаптерах. Агент сравнивает их по глубине, локальности и месту шва и советует один или гибрид. agents/openai.yaml — название и описание для Codex.

Когда включать и когда не надо

Когда нужно придумать интерфейс модуля, решить, где пройдёт шов, сделать код тестируемым и понятнее для агента. Другие скиллы подгружают его ради терминов.

Кодовую базу он не сканирует и что рефакторить не выбирает — это работа improve-codebase-architecture. Про REST-эндпоинты и пагинацию в нём ничего нет.

Как поставить и вызвать

Команда установки ниже кладёт всю папку. Агент сам подхватывает скилл по описанию, когда речь заходит об устройстве интерфейса. Вызвать вручную:

  • Claude Code: /codebase-design или попросить скилл по имени.
  • Codex: $codebase-design.
  • Cursor: наберите / в чате Agent и выберите codebase-design.

Пример: /codebase-design Логика биллинга размазана по шести мелким файлам. Предложи три интерфейса единого модуля биллинга и выбери лучший.

Этот скилл вызывают improve-codebase-architecture и tdd, а субагенты design-it-twice получают словарь из GLOSSARY.md, который ведёт domain-modeling. Ставьте их вместе.

Чем отличается от похожих

Проектирование API и интерфейсов — о публичных контрактах: закон Хайрама, единая семантика ошибок, проверка входных данных на границе, приёмы для REST и TypeScript. Этот скилл — о глубине модулей внутри кода и о том, где к ним цепляются тесты. Безопасный рефакторинг из нашего каталога проводит перестройку мелкими шагами под характеризационными тестами; codebase-design решает, к какой форме идти, а не как дойти до неё без поломок. Скилл Паттерны композиции в React — про интерфейсы компонентов и только в React: готовые правила вроде составных компонентов и явных вариантов вместо булевых пропсов.

Установка

Выполните одну команду — она сохранит SKILL.md и файлы, которые он использует, в папку скиллов агента. Claude Code и Codex подхватывают новый скилл без перезапуска; если скилл не появился, перезапустите агента.

Скилл написан на английском — агент поймёт его и ответит вам по-русски.

Claude Code — macOS, Linux
curl -fsSL --create-dirs -o ~/.claude/skills/codebase-design/SKILL.md https://anymodel.org/en/skills/matt-pocock/codebase-design/SKILL.md -o ~/.claude/skills/codebase-design/DEEPENING.md https://anymodel.org/en/skills/matt-pocock/codebase-design/DEEPENING.md -o ~/.claude/skills/codebase-design/DESIGN-IT-TWICE.md https://anymodel.org/en/skills/matt-pocock/codebase-design/DESIGN-IT-TWICE.md -o ~/.claude/skills/codebase-design/LICENSE https://anymodel.org/en/skills/matt-pocock/codebase-design/LICENSE -o ~/.claude/skills/codebase-design/agents/openai.yaml https://anymodel.org/en/skills/matt-pocock/codebase-design/agents/openai.yaml
Codex, Cursor — macOS, Linux
curl -fsSL --create-dirs -o ~/.agents/skills/codebase-design/SKILL.md https://anymodel.org/en/skills/matt-pocock/codebase-design/SKILL.md -o ~/.agents/skills/codebase-design/DEEPENING.md https://anymodel.org/en/skills/matt-pocock/codebase-design/DEEPENING.md -o ~/.agents/skills/codebase-design/DESIGN-IT-TWICE.md https://anymodel.org/en/skills/matt-pocock/codebase-design/DESIGN-IT-TWICE.md -o ~/.agents/skills/codebase-design/LICENSE https://anymodel.org/en/skills/matt-pocock/codebase-design/LICENSE -o ~/.agents/skills/codebase-design/agents/openai.yaml https://anymodel.org/en/skills/matt-pocock/codebase-design/agents/openai.yaml
Claude Code — Windows PowerShell
foreach ($f in 'SKILL.md','DEEPENING.md','DESIGN-IT-TWICE.md','LICENSE','agents/openai.yaml') { $p = Join-Path "$HOME\.claude\skills\codebase-design" $f; New-Item -ItemType Directory -Force (Split-Path $p) | Out-Null; Invoke-WebRequest "https://anymodel.org/en/skills/matt-pocock/codebase-design/$f" -UseBasicParsing -OutFile $p }
Codex, Cursor — Windows PowerShell
foreach ($f in 'SKILL.md','DEEPENING.md','DESIGN-IT-TWICE.md','LICENSE','agents/openai.yaml') { $p = Join-Path "$HOME\.agents\skills\codebase-design" $f; New-Item -ItemType Directory -Force (Split-Path $p) | Out-Null; Invoke-WebRequest "https://anymodel.org/en/skills/matt-pocock/codebase-design/$f" -UseBasicParsing -OutFile $p }

Другой агент: сохраните файл в его папку скиллов или дайте ему ссылку на файл: https://anymodel.org/en/skills/matt-pocock/codebase-design/SKILL.md

SKILL.md

Исходник

Codebase Design

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.

Glossary

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).

Implementation: what's inside a module, its body of code. Distinct from Adapter: a thing can be a small adapter with a large implementation (a Postgres repo) or a large adapter with a small implementation (an in-memory fake). Reach for "adapter" when the seam is the topic; "implementation" otherwise.

Depth: leverage at the interface. The amount of behaviour a caller (or test) can exercise per unit of interface they have to learn. A module is deep when a large amount of behaviour sits behind a small interface, shallow when the interface is nearly as complex as the implementation.

Seam (Michael Feathers): a place where you can alter behaviour without editing in that place; the location at which a module's interface lives. Where to put the seam is its own design decision, distinct from what goes behind it. Avoid: boundary (overloaded with DDD's bounded context).

Adapter: a concrete thing that satisfies an interface at a seam. Describes role (what slot it fills), not substance (what's inside).

Leverage: what callers get from depth. More capability per unit of interface they learn. One implementation pays back across N call sites and M tests.

Locality: what maintainers get from depth. Change, bugs, knowledge, and verification concentrate in one place rather than spreading across callers. Fix once, fixed everywhere.

Deep vs shallow

Deep module = small interface + lots of implementation:

┌─────────────────────┐
│   Small Interface   │  ← Few methods, simple params
├─────────────────────┤
│                     │
│  Deep Implementation│  ← Complex logic hidden
│                     │
└─────────────────────┘

Shallow module = large interface + little implementation (avoid):

┌─────────────────────────────────┐
│       Large Interface           │  ← Many methods, complex params
├─────────────────────────────────┤
│  Thin Implementation            │  ← Just passes through
└─────────────────────────────────┘

When designing an interface, ask:

  • Can I reduce the number of methods?
  • Can I simplify the parameters?
  • Can I hide more complexity inside?

Principles

  • Depth is a property of the interface, not the implementation. A deep module can be internally composed of small, mockable, swappable parts; they just aren't part of the interface. A module can have internal seams (private to its implementation, used by its own tests) as well as the external seam at its interface.
  • The 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. Callers and tests cross the same seam. If you want to test past the interface, the module is probably the wrong shape.
  • One adapter means a hypothetical seam. Two adapters means a real one. Don't introduce a seam unless something actually varies across it.

Designing for testability

Good interfaces make testing natural:

  1. Accept dependencies, don't create them.

    // Testable
    function processOrder(order, paymentGateway) {}
    
    // Hard to test
    function processOrder(order) {
      const gateway = new StripeGateway();
    }
    
  2. Return results, don't produce side effects.

    // Testable
    function calculateDiscount(cart): Discount {}
    
    // Hard to test
    function applyDiscount(cart): void {
      cart.total -= discount;
    }
    
  3. Small surface area. Fewer methods = fewer tests needed. Fewer params = simpler test setup.

Relationships

  • A Module has exactly one Interface (the surface it presents to callers and tests).
  • Depth is a property of a Module, measured against its Interface.
  • A Seam is where a Module's Interface lives.
  • An Adapter sits at a Seam and satisfies the Interface.
  • Depth produces Leverage for callers and Locality for maintainers.

Rejected framings

  • Depth as ratio of implementation-lines to interface-lines (Ousterhout): rewards padding the implementation. We use depth-as-leverage instead.
  • "Interface" as the TypeScript interface keyword or a class's public methods: too narrow: interface here includes every fact a caller must know.
  • "Boundary": overloaded with DDD's bounded context. Say seam or interface.

Going deeper

  • Deepening a cluster given its dependencies, see DEEPENING.md: dependency categories, seam discipline, and replace-don't-layer testing.
  • Exploring alternative interfaces, see DESIGN-IT-TWICE.md: spin up parallel sub-agents to design the interface several radically different ways, then compare on depth, locality, and seam placement.

Подключить через AnyModel API

Скилл работает на той модели, которую использует агент. Подключите Claude Code, Codex или Cursor к AnyModel и запускайте его на Claude, GPT, Gemini и других моделях по одному ключу — оплата за токены, без подписки.

Ещё из пака Скиллы Мэтта Покока

Ревью по стандартам и спецификации

Проверяет дифф от коммита, ветки или тега по двум осям в параллельных субагентах: записанные стандарты репозитория с базовым набором запахов кода по Фаулеру и исходная спецификация. Для случаев, когда ветку или PR надо сверить с задачей.

Диагностика сложных багов

Диагностирует сложные баги и просадки скорости: сначала собирает быструю детерминированную команду, воспроизводящую точный симптом, потом ужимает её, ранжирует проверяемые гипотезы и пишет регрессионный тест. Для случаев, когда что-то падает или тормозит.

Модель предметной области

Уточняет язык предметной области по ходу проектирования: оспаривает размытые и противоречивые термины, сразу пишет согласованные в GLOSSARY.md и предлагает короткий ADR лишь для трудно обратимых решений. Для случаев, когда обсуждают термины или пишут ADR.

Реализация спецификации по тикетам

Реализует спецификацию и её тикеты на одной интеграционной ветке: по свежему субагенту-исполнителю на тикет в своём worktree, параллельно по графу блокировок, затем ревью и один проход исправлений. Для случаев, когда тикеты из to-tickets уже готовы.

Улучшение архитектуры кодовой базы

Ищет мелкие модули, которые стоит углубить, начиная с чаще всего меняющегося кода, показывает кандидатов в HTML-отчёте со схемами «до и после» и разбирает выбранный вместе с вами. Для случаев, когда код стало трудно тестировать и понимать.

Прототип на выброс

Пишет прототип на выброс под один вопрос о дизайне: кликабельное HTML-демо модели состояний в одном файле или несколько разных вариантов интерфейса на одном маршруте с переключением через URL. Для случаев, когда нужно проверить логику или облик страницы.

Ретро сессии с агентом

Разбирает прошедшую сессию агента по логам и предлагает, что поменять в окружении: указатели в CLAUDE.md, правила линтера, pre-commit и CI, стандарты для ревью, вызовы инструментов. Для случаев, когда агент долго искал нужное или ошибался.

TDD с интеграционными тестами

Ведёт разработку через тесты на публичных интерфейсах: согласует с пользователем швы для тестов, делает по одному циклу red-green на тест, мокает только границы системы, рефакторинг оставляет ревью. Для случаев, когда фичу или баг делают тестами вперёд.

Спецификация из разговора

Собирает из текущего разговора и кода спецификацию с пользовательскими историями, решениями по реализации и тестам и публикует её в трекер с меткой ready-for-agent, без расспросов. Для случаев, когда фичу уже обсудили и её пора записать.

Разбивка спецификации на тикеты

Режет спецификацию, план или разговор на тикеты-трассирующие пули: вертикальные срезы на одну сессию агента со связями блокировки, и публикует их файлами или задачами в трекере. Для случаев, когда работа не влезает в одну сессию.

Триаж задач и PR

Разбирает входящие задачи и внешние PR в трекере: ставит категорию и состояние, ищет готовый код и прошлые отказы, воспроизводит баги и пишет бриф для агента. Для случаев, когда мейнтейнер разгребает поток задач и PR.

Карта для большой работы

Раскладывает работу, которая не влезает в одну сессию агента, в карту в трекере с дочерними тикетами-решениями и закрывает по тикету за сессию, пока путь к цели не прояснится. Для случаев, когда большая задача упирается в нерешённые вопросы.

Bash-мастер для ручных шагов

Пишет интерактивный bash-скрипт, который ведёт человека по ручным шагам: открывает нужные страницы, принимает ключи и пишет их в .env и секреты GitHub. Для случаев, когда настройка сервисов или миграция требует действий, которые агент сам не сделает.

Защита от опасных git-команд в Claude Code

Ставит в Claude Code хук PreToolUse, который останавливает типовые формы git push, reset --hard, clean -f, branch -D и отката всего дерева, для одного проекта или для всех, и проверяет его. Для случаев, когда нужна страховка от того, что агент сам запушит или сотрёт работу.

Перевод тестов на shoehorn

Заменяет as и as unknown as в тестах на TypeScript на fromPartial и fromAny из @total-typescript/shoehorn, добавляет импорты и запускает проверку типов. Для случаев, когда тесты собирают объекты целиком или обманывают компилятор приведениями.

Настройка pre-commit хуков

Ставит Husky и lint-staged в Node-репозиторий: каждый коммит прогоняет Prettier по staged-файлам, проверку типов и тесты; учитывает менеджер пакетов и делает первый коммит через хук. Для случаев, когда в репозитории нет проверок при коммите.

Допрос плана

Допрашивает пользователя о плане раундами пронумерованных вопросов с рекомендуемым ответом, факты ищет сам через субагентов и не останавливается, пока остаются допущения. Для случаев, когда план надо проверить на прочность до начала работы.

Обучение новой теме

Ведёт курс по теме в текущей папке на много сессий: цель, проверенные источники, короткие HTML-уроки с тестами, шпаргалки и записи о выученном. Для случаев, когда тему нужно освоить всерьёз, а не получить один ответ.

Опросник для решения

Составляет Markdown-опросник для человека, у которого есть нужные знания, спросив только, кому он и какие ответы нужны; важные вопросы идут первыми. Для случаев, когда решение упирается в факты от другого человека.

Тексты для агентов: скиллы и AGENTS.md

Даёт правила для текстов, которые читает агент: описание скилла как указатель, что держать в файле и что выносить, критерии готовности, опорные слова и чистка. Для случаев, когда пишете или правите скилл, AGENTS.md или CLAUDE.md.