- AGENTS.md: блок «Agent skills» со ссылками на docs/agents/ - docs/agents/issue-tracker.md: Gitea через tea CLI - docs/agents/triage-labels.md: стандартные пять меток - docs/agents/domain.md: один контекст, CONTEXT.md + docs/adr/ - CLAUDE.md: секция «Читабельность языка» Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2.9 KiB
Доменная документация
Как скиллам читать доменную документацию этого репо перед работой с кодом.
Что читать перед началом
CONTEXT.mdв корне репо, илиCONTEXT-MAP.mdв корне, если он есть: указывает на отдельныйCONTEXT.mdдля каждого контекста. Читайте те, что относятся к теме.docs/adr/: читайте ADR, которые касаются области, с которой собираетесь работать. В мультиконтекстных репо также проверяйтеsrc/<context>/docs/adr/.
Если каких-то из этих файлов нет — работайте молча. Не отмечайте их отсутствие и не предлагайте создать заранее. Скилл /domain-modeling (через /grill-with-docs и /improve-codebase-architecture) создаёт их по мере того, как термины и решения реально фиксируются.
Структура файлов
Один контекст (этот репо и большинство других):
/
├── CONTEXT.md
├── docs/adr/
│ ├── 0001-event-sourced-orders.md
│ └── 0002-postgres-for-write-model.md
└── src/
Несколько контекстов (признак — CONTEXT-MAP.md в корне):
/
├── CONTEXT-MAP.md
├── docs/adr/ ← решения уровня системы
└── src/
├── ordering/
│ ├── CONTEXT.md
│ └── docs/adr/ ← решения этого контекста
└── billing/
├── CONTEXT.md
└── docs/adr/
Используйте словарь глоссария
Когда в выводе называете доменное понятие (в заголовке issue, предложении по рефакторингу, гипотезе, имени теста), берите термин из CONTEXT.md. Не съезжайте на синонимы, которых глоссарий избегает.
Если нужного понятия в глоссарии нет — это сигнал: либо вы придумываете слова, которых проект не использует (пересмотрите), либо в глоссарии пробел (отметьте для /domain-modeling).
Отмечайте конфликты с ADR
Если ваш вывод противоречит существующему ADR, скажите об этом явно, а не переопределяйте молча:
Противоречит ADR-0007 (event-sourced orders), но стоит пересмотреть, потому что…