docs: AI documentation protocol and roadmap context tool

Протокол работы AI-ассистентов, зоны frontend/backend/shared, статусы, журнал, шаблоны и скрипт сводки дорожной карты.

Refs: 1.2.3

Generated with [Devin](https://devin.ai)

Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
This commit is contained in:
TMSHandDevin committed 2026-11-08 17:14:44 +03:00
1 parent 699e6bbd57
commit a1ce4bdb8a
15 files changed
+804

No files matched your search

@@ -0,0 +1,37 @@
---
date: 2026-11-08
zone: shared
task: "1.2"
items: []
branch: chore/1.2-ai-docs-protocol
pr: —
impact: shared
status: в работе
author: Frontend
---
# [1.2] Система документирования для AI-ассистентов
## Сделано
- Протокол работы AI: `docs/ai/PROTOCOL.md` — источники истины, зоны frontend/backend/shared, чек-листы начала и конца сессии.
- Сверка с дорожной картой: `docs/ai/roadmap.md` и скрипт `tools/roadmap-context/roadmap-context.mjs` (Node 18+, без зависимостей, только чтение).
- Шаблоны: `docs/ai/templates/` — запись журнала, ADR, описание модуля.
- Снимки состояния: `docs/status/shared.md`, `frontend.md`, `backend.md`.
- Индексы зон: `docs/frontend/README.md`, `docs/backend/README.md`; карта документации `docs/README.md`.
- `AGENTS.md`: раздел 9 «Документирование и контекст».
## Решения
- Дорожная карта остаётся единственным трекером; AI её только читает и готовит текст для людей.
- Память проекта для AI — `docs/status` (снимок) + `docs/journal` (история по PR), документация коммитится в той же ветке, что и код.
- Внутренние документы зоны в `docs/frontend` и `docs/backend`; ассистент другой зоны их не читает без необходимости.
## Для другой стороны
- Backend: прочитать `docs/ai/PROTOCOL.md`, добавить личный блок правил с `зона: backend` (раздел 8).
## Проверка
- `node tools/roadmap-context/roadmap-context.mjs` и `... 1.2` против https://locshare.ru/roadmap/ — сводка выводится.
## Осталось
- [ ] Обсудить протокол вдвоём, при необходимости поправить.
- [ ] Перенести в репозиторий Gitea вместе с остальными файлами (#1.2.3).
- [ ] Включить пароль на roadmap-server (#1.1.2): сейчас `/api/progress` читается без авторизации.
+8
View File
@@ -0,0 +1,8 @@
# Журнал работы
Одна запись на ветку/PR. Шаблон — `docs/ai/templates/journal-entry.md`, правила — `docs/ai/PROTOCOL.md`.
- Имя: `YYYY-MM-DD-<зона>-<ID>-<кратко>.md`, дата — день создания ветки.
- `zone` — чья работа; `impact: shared` — запись обязательна к прочтению другой стороной.
- Запись правит только её автор. Смерженную запись не переписывают; исправление — новой записью.
- Ассистент в начале сессии читает последние 5 записей своей зоны и все `impact: shared` новее своей последней записи.