docs: добавлены личные заметки разработчика вне git
Папка docs/private/ в .gitignore: внутренние заметки каждого разработчика с AI, которые не видит напарник. Общий контекст по-прежнему в status, journal и ADR. Refs: 1.2 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
dcee1faf7d
commit
b1d27877c9
4 files changed
+28
-1
No files matched your search
@@ -6,6 +6,9 @@
|
|||||||
*.key
|
*.key
|
||||||
*.p12
|
*.p12
|
||||||
|
|
||||||
|
# Личные заметки разработчика с AI (docs/ai/PROTOCOL.md, раздел 2)
|
||||||
|
docs/private/
|
||||||
|
|
||||||
# Go
|
# Go
|
||||||
/bin/
|
/bin/
|
||||||
*.exe
|
*.exe
|
||||||
|
|||||||
@@ -22,6 +22,7 @@
|
|||||||
| `testing/` | shared | Тестовый стенд, сценарии доступа |
|
| `testing/` | shared | Тестовый стенд, сценарии доступа |
|
||||||
| `research/` | shared | Интервью, исследования рынка |
|
| `research/` | shared | Интервью, исследования рынка |
|
||||||
| `frontend/` | frontend | Внутренние правила Frontend: дизайн-система, компоненты, соглашения |
|
| `frontend/` | frontend | Внутренние правила Frontend: дизайн-система, компоненты, соглашения |
|
||||||
|
| `private/` | только владелец | Личные заметки разработчика с AI. В `.gitignore`, в Gitea не попадает |
|
||||||
| `backend/` | backend | Внутренние правила Backend: области сервера, агент, эксплуатация |
|
| `backend/` | backend | Внутренние правила Backend: области сервера, агент, эксплуатация |
|
||||||
| `environment.md` | shared | Версии инструментов и установка окружения (#1.3) |
|
| `environment.md` | shared | Версии инструментов и установка окружения (#1.3) |
|
||||||
| `glossary.md` | shared | Словарь терминов (#2.1) |
|
| `glossary.md` | shared | Словарь терминов (#2.1) |
|
||||||
|
|||||||
+7
-1
@@ -37,6 +37,11 @@
|
|||||||
- **Читаешь:** `shared` + свою зону. Чужую зону — только если задача её касается (например, Frontend подключает эндпоинт и смотрит `docs/backend/` по нему).
|
- **Читаешь:** `shared` + свою зону. Чужую зону — только если задача её касается (например, Frontend подключает эндпоинт и смотрит `docs/backend/` по нему).
|
||||||
- **Пишешь:** свою зону + `shared`. Документы чужой зоны не редактируешь. Нашёл в них ошибку или нужна правка у другой стороны — запись в «Запросы между зонами» в `docs/status/shared.md`.
|
- **Пишешь:** свою зону + `shared`. Документы чужой зоны не редактируешь. Нашёл в них ошибку или нужна правка у другой стороны — запись в «Запросы между зонами» в `docs/status/shared.md`.
|
||||||
- Чисто внутренние вещи зоны (дизайн-правила, вёрстка, внутренняя организация сервиса) остаются в документах зоны и **не попадают** в `shared`. Ассистент другой стороны их не читает и не тратит на них контекст.
|
- Чисто внутренние вещи зоны (дизайн-правила, вёрстка, внутренняя организация сервиса) остаются в документах зоны и **не попадают** в `shared`. Ассистент другой стороны их не читает и не тратит на них контекст.
|
||||||
|
- **Личные заметки — `docs/private/`.** Папка в `.gitignore`: она есть только на компьютере владельца, в Gitea не попадает, второй разработчик и его AI её не видят. Это внутренний «чат» разработчика с AI: черновые мысли, личные договорённости с ассистентом, заметки по текущей работе, контекст между сессиями. Файлы: `docs/private/notes.md` (основной), при необходимости другие. Правила:
|
||||||
|
- ассистент читает `docs/private/` в начале сессии и дописывает туда то, что нужно помнить только владельцу;
|
||||||
|
- всё, что нужно другой стороне или проекту (решения, изменения поведения, договорённости), идёт в `docs/status`, `docs/journal` или ADR, а не только в `private`;
|
||||||
|
- ассистент не переносит текст из `private` в файлы под git без согласия владельца;
|
||||||
|
- секреты и пароли не хранятся и здесь — только в менеджере паролей. Резервную копию папки владелец делает сам.
|
||||||
- **Как определить зону сессии:** 1) пользователь назвал её («зона: frontend»); 2) она задана в личных правилах разработчика (раздел 8); 3) по путям файлов задачи. Задача затрагивает обе зоны — работай как `shared` и спроси, кто делает вторую часть.
|
- **Как определить зону сессии:** 1) пользователь назвал её («зона: frontend»); 2) она задана в личных правилах разработчика (раздел 8); 3) по путям файлов задачи. Задача затрагивает обе зоны — работай как `shared` и спроси, кто делает вторую часть.
|
||||||
|
|
||||||
### Что обязательно идёт в `shared` (impact: shared)
|
### Что обязательно идёт в `shared` (impact: shared)
|
||||||
@@ -55,7 +60,7 @@
|
|||||||
Выполни по порядку и **не начинай писать код, пока не сделал шаги 1–5**:
|
Выполни по порядку и **не начинай писать код, пока не сделал шаги 1–5**:
|
||||||
|
|
||||||
1. `AGENTS.md` (обычно подгружается сам) и этот файл.
|
1. `AGENTS.md` (обычно подгружается сам) и этот файл.
|
||||||
2. `docs/status/shared.md` и `docs/status/<зона>.md`.
|
2. `docs/status/shared.md`, `docs/status/<зона>.md` и личные заметки `docs/private/` (если папка есть; если нет — создай `docs/private/notes.md` по шаблону `docs/ai/templates/private-notes.md`).
|
||||||
3. Журнал: последние 5 записей своей зоны и все записи `impact: shared` новее твоей последней записи (`docs/journal/`, имена файлов сортируются по дате).
|
3. Журнал: последние 5 записей своей зоны и все записи `impact: shared` новее твоей последней записи (`docs/journal/`, имена файлов сортируются по дате).
|
||||||
4. Дорожная карта: `node tools/roadmap-context/roadmap-context.mjs` (текущий шаг) и `... <ID задачи>` для задачи сессии. Подробности и запасные варианты — `docs/ai/roadmap.md`.
|
4. Дорожная карта: `node tools/roadmap-context/roadmap-context.mjs` (текущий шаг) и `... <ID задачи>` для задачи сессии. Подробности и запасные варианты — `docs/ai/roadmap.md`.
|
||||||
5. Git: текущая ветка, `git status`, `git log --oneline -15 origin/main`. Есть ли смерженные PR другой стороны после последнего обновления статуса.
|
5. Git: текущая ветка, `git status`, `git log --oneline -15 origin/main`. Есть ли смерженные PR другой стороны после последнего обновления статуса.
|
||||||
@@ -88,6 +93,7 @@
|
|||||||
|
|
||||||
Чек-лист:
|
Чек-лист:
|
||||||
- [ ] Запись журнала ветки обновлена: сделано, решения, проверка, что осталось (`docs/ai/templates/journal-entry.md`).
|
- [ ] Запись журнала ветки обновлена: сделано, решения, проверка, что осталось (`docs/ai/templates/journal-entry.md`).
|
||||||
|
- [ ] Личное (черновые мысли, на чём остановились, что обсудить с собой) — в `docs/private/notes.md`.
|
||||||
- [ ] `docs/status/<зона>.md` отражает текущее состояние: заменить устаревшее, а не дописать снизу.
|
- [ ] `docs/status/<зона>.md` отражает текущее состояние: заменить устаревшее, а не дописать снизу.
|
||||||
- [ ] Если есть impact `shared` — обновлён `docs/status/shared.md` (раздел «Готово для другой стороны» или «Запросы между зонами»).
|
- [ ] Если есть impact `shared` — обновлён `docs/status/shared.md` (раздел «Готово для другой стороны» или «Запросы между зонами»).
|
||||||
- [ ] Новый модуль, экран, компонент, паттерн, эндпоинт — описание в документах зоны (`docs/ai/templates/module.md`).
|
- [ ] Новый модуль, экран, компонент, паттерн, эндпоинт — описание в документах зоны (`docs/ai/templates/module.md`).
|
||||||
|
|||||||
@@ -0,0 +1,17 @@
|
|||||||
|
# Личные заметки
|
||||||
|
|
||||||
|
Только на этом компьютере (`docs/private/` в `.gitignore`). В Gitea не попадает, второй разработчик не видит.
|
||||||
|
Всё, что нужно проекту или другой стороне, — в `docs/status`, `docs/journal`, ADR. Секреты здесь не хранить.
|
||||||
|
|
||||||
|
## На чём остановились
|
||||||
|
-
|
||||||
|
|
||||||
|
## Мысли и черновики
|
||||||
|
-
|
||||||
|
|
||||||
|
## Договорённости с AI
|
||||||
|
<!-- Как мне удобнее работать: стиль ответов, что проверять, что не делать без спроса. -->
|
||||||
|
-
|
||||||
|
|
||||||
|
## Обсудить с напарником
|
||||||
|
-
|
||||||
Reference in new issue
Block a user