Files
shtil/docs/README.md
T

30 lines
2.2 KiB
Markdown
Raw Normal View History

# Документация «Штиль»
Начните с `AGENTS.md` (правила проекта), затем `docs/ai/PROTOCOL.md` (как работать с контекстом и документировать).
## Порядок чтения для новой сессии
1. `AGENTS.md`
2. `docs/ai/PROTOCOL.md`
3. `docs/status/shared.md` + `docs/status/<ваша зона>.md`
4. Последние записи `docs/journal/`
5. Дорожная карта: `node tools/roadmap-context/roadmap-context.mjs`
## Карта
| Папка / файл | Зона | Что внутри |
|---|---|---|
| `ai/` | shared | Протокол AI, сверка с дорожной картой, шаблоны |
| `status/` | shared + зоны | Снимок текущего состояния: общее, Frontend, Backend |
| `journal/` | все | История работы: одна запись на ветку/PR |
| `adr/` | shared | Архитектурные решения `NNNN-название.md` |
| `architecture/` | shared | ERD, правила БД, протокол агента, IPC Помощника |
| `ux/` | shared | Информационная архитектура, макеты, сценарии |
| `testing/` | shared | Тестовый стенд, сценарии доступа |
| `research/` | shared | Интервью, исследования рынка |
| `frontend/` | frontend | Внутренние правила Frontend: дизайн-система, компоненты, соглашения |
| `private/` | только владелец | Личные заметки разработчика с AI. В `.gitignore`, в Gitea не попадает |
| `backend/` | backend | Внутренние правила Backend: области сервера, агент, эксплуатация |
| `environment.md` | shared | Версии инструментов и установка окружения (#1.3) |
| `glossary.md` | shared | Словарь терминов (#2.1) |
| `features.md` | shared | Каталог функций и лимитов (#2.3) |
| `contributing.md` | shared | Ветки, коммиты, PR, версии (#1.2.9) |