docs(agents): добавлена конфигурация инженерных навыков
This commit is contained in:
1 parent
2e961fd0c7
commit
34a3cb309c
4 files changed
+138
No files matched your search
@@ -0,0 +1,45 @@
|
||||
# Документация предметной области
|
||||
|
||||
Правила работы инженерных навыков с документацией предметной области при
|
||||
изучении кодовой базы.
|
||||
|
||||
## Что прочитать перед изучением кодовой базы
|
||||
|
||||
- **`CONTEXT.md`** в корне репозитория
|
||||
- **`CONTEXT-MAP.md`** в корне репозитория, если он существует: файл указывает
|
||||
на отдельные `CONTEXT.md` для разных контекстов
|
||||
- **`docs/adr/`**: ADR, относящиеся к области предстоящих изменений
|
||||
|
||||
Если какого-либо файла или каталога нет, продолжай работу без предупреждения.
|
||||
Не отмечай его отсутствие и не предлагай создать его заранее. Навык
|
||||
`/domain-modeling` создаёт такие документы по мере необходимости, когда
|
||||
появляются новые термины или архитектурные решения.
|
||||
|
||||
## Структура файлов
|
||||
|
||||
Этот репозиторий использует схему `single-context`:
|
||||
|
||||
```text
|
||||
/
|
||||
├── CONTEXT.md
|
||||
├── docs/adr/
|
||||
│ ├── 0001-example-decision.md
|
||||
│ └── 0002-another-decision.md
|
||||
└── src/
|
||||
```
|
||||
|
||||
## Используй термины из глоссария
|
||||
|
||||
Когда в результате работы появляется понятие предметной области — например, в
|
||||
названии задачи, предложении по рефакторингу, гипотезе или названии теста, —
|
||||
используй термин из `CONTEXT.md`. Не заменяй его синонимами, которые глоссарий
|
||||
явно исключает.
|
||||
|
||||
Если нужного понятия в глоссарии нет, проверь, действительно ли оно относится
|
||||
к проекту. Если относится, зафиксируй пробел для последующей проработки через
|
||||
`/domain-modeling`.
|
||||
|
||||
## Отмечай противоречия с ADR
|
||||
|
||||
Если предлагаемое изменение противоречит существующему ADR, явно укажи на
|
||||
конфликт, а не отменяй ранее принятое решение молча.
|
||||
Reference in new issue
Block a user