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:
1 parent
699e6bbd57
commit
a1ce4bdb8a
15 files changed
+804
No files matched your search
@@ -0,0 +1,22 @@
|
||||
# ADR-NNNN: Название решения
|
||||
|
||||
- **Статус:** Предложено | Принято | Отклонено | Заменено ADR-NNNN
|
||||
- **Дата:** YYYY-MM-DD
|
||||
- **Задача:** #1.5
|
||||
- **Участники:** Имя, Имя
|
||||
- **Зоны:** shared | frontend | backend
|
||||
|
||||
## Контекст
|
||||
Какая проблема, какие ограничения и факты. 3–6 предложений.
|
||||
|
||||
## Решение
|
||||
Что решили, конкретно и проверяемо.
|
||||
|
||||
## Рассмотренные варианты
|
||||
| Вариант | Плюсы | Минусы |
|
||||
|---|---|---|
|
||||
| | | |
|
||||
|
||||
## Последствия
|
||||
- Что становится проще, что сложнее, что нужно сделать (с ID задач).
|
||||
- Как понять, что решение пора пересмотреть.
|
||||
@@ -0,0 +1,34 @@
|
||||
---
|
||||
date: YYYY-MM-DD
|
||||
zone: frontend | backend | shared
|
||||
task: "2.13"
|
||||
items: ["2.13.1", "2.13.2"]
|
||||
branch: feat/2.13-design-tokens
|
||||
pr: —
|
||||
impact: none | shared
|
||||
status: в работе | на проверке | смержено
|
||||
author: Имя
|
||||
---
|
||||
|
||||
# [2.13] Кратко, что делаем
|
||||
|
||||
## Сделано
|
||||
- Что сделано и где лежит (`путь/к/файлу`). Отмеченный пункт карты — с его ID.
|
||||
|
||||
## Решения
|
||||
- Что решили и почему. Значимое → ADR-NNNN.
|
||||
|
||||
## Для другой стороны
|
||||
<!-- Только при impact: shared. Что изменилось для другой зоны и что ей нужно сделать. Иначе удалить раздел. -->
|
||||
|
||||
## Отклонения от плана
|
||||
<!-- Пункт сделан иначе / не нужен / появился новый. Иначе удалить раздел. -->
|
||||
|
||||
## Проверка
|
||||
- Какие тесты, линтеры, ручные проверки пройдены.
|
||||
|
||||
## Осталось
|
||||
- [ ] Что не доделано в этой ветке.
|
||||
|
||||
## Идеи и бэклог
|
||||
<!-- Найдено вне текущего шага, не делали. Иначе удалить раздел. -->
|
||||
@@ -0,0 +1,22 @@
|
||||
# Название модуля / экрана / компонента
|
||||
|
||||
- **Зона:** frontend | backend | shared
|
||||
- **Где в коде:** `путь/`
|
||||
- **Задачи:** #2.14, #3.2
|
||||
- **Связанные ADR и документы:** ADR-0008, `docs/architecture/...`
|
||||
|
||||
## Назначение
|
||||
Что делает и чего НЕ делает. 2–4 предложения.
|
||||
|
||||
## Как устроено
|
||||
Ключевые части, поток данных, точки расширения. Схема — если помогает.
|
||||
|
||||
## Контракт и зависимости
|
||||
- Эндпоинты / сообщения proto / таблицы / компоненты `packages/ui`, от которых зависит.
|
||||
- Права и функции (`perm.*`, `features.*`), которые проверяются.
|
||||
|
||||
## Правила и подводные камни
|
||||
- То, что нельзя нарушать, и то, на чём легко ошибиться.
|
||||
|
||||
## Как проверить
|
||||
- Тесты, команды, ручной сценарий.
|
||||
Reference in new issue
Block a user