ddadmin
aecbf392d9
- Зачем:
- развести документацию по времени жизни: транзиентные спеки отдельно от
долговечных решений (ADR) и доменного словаря (CONTEXT.md), вместо одного
громоздкого spec-документа.
- Что:
- добавлен блок Agent skills в AGENTS.md (issue tracker / triage / domain docs).
- созданы docs/agents/{issue-tracker,triage-labels,domain}.md: локальный
markdown-трекер в .scratch/, дефолтные triage-метки, single-context раскладка.
- зафиксировано решение как docs/adr/0001-spec-adr-issue-layout.md.
- Проверка:
- git show --stat HEAD; прочитать AGENTS.md и docs/adr/0001-spec-adr-issue-layout.md.
44 lines
2.1 KiB
Markdown
44 lines
2.1 KiB
Markdown
# Domain docs
|
|
|
|
Как инженерные скиллы должны читать доменную документацию этого репозитория при
|
|
исследовании кода.
|
|
|
|
## Перед исследованием кода прочитать
|
|
|
|
- `CONTEXT.md` в корне — глоссарий проекта (доменный язык).
|
|
- `docs/adr/` — ADR, затрагивающие область, в которой собираешься работать.
|
|
|
|
Если файла нет — **молча продолжай**. Не сигналить об отсутствии и не предлагать
|
|
создать заранее. Продюсер (`grill-with-docs`) создаёт их лениво, когда термин или
|
|
решение реально кристаллизуются.
|
|
|
|
## Раскладка
|
|
|
|
Single-context (один контекст на репозиторий):
|
|
|
|
```
|
|
/
|
|
├── CONTEXT.md
|
|
├── docs/adr/
|
|
│ ├── 0001-<slug>.md
|
|
│ └── 0002-<slug>.md
|
|
└── ...
|
|
```
|
|
|
|
## Использовать лексику глоссария
|
|
|
|
Когда вывод называет доменное понятие (заголовок спеки, гипотеза, имя теста,
|
|
рефактор-предложение) — использовать термин так, как он определён в `CONTEXT.md`.
|
|
Не уходить в синонимы, которые глоссарий помечает `_Avoid_`.
|
|
|
|
Если нужного понятия в глоссарии ещё нет — это сигнал: либо изобретаешь язык,
|
|
которого в проекте нет (пересмотреть), либо реальный пробел (отметить для
|
|
`grill-with-docs`).
|
|
|
|
## Флагать конфликты с ADR
|
|
|
|
Если вывод противоречит существующему ADR — явно об этом сказать, а не молча
|
|
переопределять:
|
|
|
|
> _Противоречит ADR-0003 (<тема>) — но стоит переоткрыть, потому что…_
|