Skip to content

Latest commit

 

History

History
77 lines (61 loc) · 6.07 KB

File metadata and controls

77 lines (61 loc) · 6.07 KB

Code Memory Service — repo guide

Что это за репозиторий

Code Memory Service — MCP-сервис, который хранит знания о коде (ADR-заметки, привязанные к коду якорями) и даёт LLM-агенту находить их поиском, не перечитывая весь код и документацию. Репозиторий содержит:

  • src/ — исходники сервиса: core-библиотека, MCP-сервер, CLI/TUI.
  • specs/ — спека сервиса: домен, данные, поиск, интерфейсы, тех-дизайн.
  • skills/ — корпус скиллов для Claude Code, поставляемый вместе с сервисом (mem, mem-onboarding, семейство workflow, /storyteller, /mem-explore).
  • docs/ — документация: workflow скиллов, методология консьюмера, setup, гайды для контрибьюторов.

Скиллы из skills/ в этом репозитории не активны — это исходники; работают они, будучи установленными в .claude/skills/ целевого проекта.

Сам сервис к этому репозиторию не подключён: MCP-инструменты (search, get_notes, …) недоступны, поэтому шаги «поиск по памяти» из workflow-скиллов здесь — no-op. Источник истины — specs/, docs/ и файлы плана.

Как здесь работать

  1. Канон: specs/ (сервис), docs/workflow/ и docs/consumer-guide/ (экосистема скиллов и методология).
  2. Задачи разработки ведём через семейство workflow пошагово. Процедура — в skills/work/ (SKILL.md + core.md); поскольку скиллы здесь не активны, читаем и исполняем их по тексту.
  3. Планы лежат в plans/ плоско, <prefix>-NN-<slug>.md, прогресс — чек-боксы (первый этап без [x] — текущий). Файлы плана — личное пространство разработчика, не коммитятся.

Цикл: (/prepare) → /work → реализация этапа → /step-done (фиксация рабочих заметок в индекс) → /git commit → следующий этап. /prepare — разведка контекста этапа (по умолчанию /work делегирует её субагенту).

Работа над скиллами

  • При создании или правке любого скилла обязательно следование docs/contributing/skill-writing.md.
  • По завершению — прогон по чек-листу ревью оттуда и отчёт пользователю. Игнорирование этого подхода ведёт к дефектным скиллам.
  • Свериться с docs/contributing/skill-core-coverage.md — он перечисляет обязательные слайсы core.md для каждого скилла. При создании/правке скилла пройти по его списку и убедиться, что все нужные слайсы заинлайнены. При правке любого core.md — пройти по затронутым скиллам и ресинкнуть слайсы.

Карта документации

Где Что
specs/ Спека сервиса (отправная точка — specs/00-overview.md)
docs/workflow/README.md Жизненный цикл задачи (семейство workflow), обзор экосистемы скиллов
docs/workflow/skills.md Справочник по скиллам: режим, задача, механика
docs/workflow/context-engineering.md Context Drift, Structured CoT, Grounding, Synthesis, Modes, водораздел, /mem-explore
docs/consumer-guide/documentation-system.md 6-слойная спека целевого проекта, RULES.md, Functional Map
docs/consumer-guide/user-stories.md System-Aware User Stories: концепт + формат
docs/consumer-guide/formats.md Шаблоны плана; указатели на канон заметок (specs/04) и историй
docs/contributing/skill-writing.md Стиль-гайд написания скиллов — обязателен при правке skills/
docs/contributing/skill-core-coverage.md Чек-лист обязательных слайсов core.md по каждому скиллу
docs/contributing/manual-testing.md Ручной чек-лист для TUI, Docker-развёртывания, онбординга

Жёсткие инварианты репозитория

  • Скиллы лежат в skills/ корня (не в .claude/skills/).
  • Кросс-ссылки между скиллами — по имени, не по пути («the work skill's core.md»), потому что репо-хранение и runtime-расположение разные.
  • При создании или правке файлов любого скилла обязательно следование docs/contributing/skill-writing.md.
  • Тексты скиллов на английском; общение с пользователем и все артефакты (планы, заметки, правки спек) — на русском.

Что НЕ делать

  • Не дублировать содержимое specs/ и docs/ в этот файл — здесь только указатели.
  • Не запускать сервис/MCP в этом контейнере — для dogfooding-а сервис поднимается в проекте-консьюмере.