Files
shtil/docs/README.md
T
TMSH 800d000ac5 Docs/1.2 private notes (#5)
<!-- Название PR: «[ID] Что сделано», по-русски. Например: [2.11] Изоляция организаций -->

**Задача:** #<!-- ID задачи в дорожной карте -->
**Пункты:** <!-- 2.11.4, 2.11.6 -->

## Что сделано
-

## Как проверить
1.

## Скриншоты
<!-- Для изменений интерфейса. Иначе удалить раздел. -->

## Чек-лист
- [ ] Коммиты и название PR по-русски, в каждом коммите есть `Refs:`
- [ ] Ветка свежая: `git rebase origin/main`, конфликтов нет
- [ ] Запросы к данным организации — с `tenant_id` и через `WithTenantTx`
- [ ] Права проверяются на сервере (`access.Require` / `ScopesFor`), интерфейс только скрывает
- [ ] Новая функция — за флагом из каталога функций
- [ ] Миграции только новые, смерженные не изменены; контракты (`api/`, `proto/`, `migrations/`) — отдельным PR
- [ ] Тесты добавлены или обновлены; для новой таблицы организации — тест изоляции
- [ ] Секретов и персональных данных в коде, логах и документах нет
- [ ] Документация обновлена: запись журнала, `docs/status/`, ADR при значимом решении
- [ ] Ссылка на этот PR добавлена в «Ссылки» задачи в дорожной карте

Reviewed-on: #5
Co-authored-by: BrowenSiz <top.timashevsky@gmail.com>
2026-11-09 13:33:30 +00:00

31 lines
2.2 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# Документация «Штиль»
Начните с `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) |