крупное обновление документации
This commit is contained in:
@@ -12,10 +12,13 @@
|
||||
|
||||
1. Прочитать [`targets/README.md`](targets/README.md).
|
||||
2. Прочитать файл текущей цели, указанный там как `Current target`.
|
||||
3. Прочитать [`docs/README.md`](docs/README.md) и связанные с задачей нормативные документы.
|
||||
4. Для renderer-задач прочитать [`RENDER.md`](RENDER.md).
|
||||
5. Проверить рабочее дерево и не перезаписывать чужие изменения.
|
||||
6. Перед созданием сложной подсистемы или добавлением dependency проверить [`docs/TOOLING_CATALOG.md`](docs/TOOLING_CATALOG.md), зарегистрировать найденные готовые решения и провести bounded evaluation вместо немедленного вендоринга.
|
||||
3. Прочитать [`targets/DEVELOPMENT_ROADMAP.md`](targets/DEVELOPMENT_ROADMAP.md) и соответствующий subsystem plan из `targets/roadmap/`.
|
||||
4. Прочитать [`docs/README.md`](docs/README.md) и связанные с задачей нормативные документы.
|
||||
5. Прочитать обязательный [`docs/DOCUMENTATION_STANDARD.md`](docs/DOCUMENTATION_STANDARD.md) и определить, какие API docs, module spec и diagrams затрагивает задача.
|
||||
6. Для renderer-задач прочитать [`RENDER.md`](RENDER.md).
|
||||
7. Проверить рабочее дерево и не перезаписывать чужие изменения.
|
||||
8. Перед созданием сложной подсистемы или добавлением dependency проверить [`docs/TOOLING_CATALOG.md`](docs/TOOLING_CATALOG.md), зарегистрировать найденные готовые решения и провести bounded evaluation вместо немедленного вендоринга.
|
||||
9. При командной работе прочитать [`docs/TEAM_WORKFLOW.md`](docs/TEAM_WORKFLOW.md), проверить активные claims/draft PRs и объявить стабильный Agent ID до изменений.
|
||||
|
||||
Если задача пользователя противоречит target-порядку, прямое указание пользователя имеет приоритет, но агент обязан сохранить архитектурные границы и отметить влияние на roadmap.
|
||||
|
||||
@@ -30,10 +33,16 @@
|
||||
- Любой новый формат, публичный контракт или несовместимое решение требует обновления документации и при необходимости ADR.
|
||||
- Исправление дефекта должно получать regression test, когда это технически возможно.
|
||||
- Не писать крупную подсистему с нуля до поиска готовых libraries, reference implementations, fixtures и tooling; результат исследования фиксируется в `docs/TOOLING_CATALOG.md`.
|
||||
- Не начинать claimed work package другого агента и не редактировать его exclusive paths без явного handoff.
|
||||
- Не работать двум агентам в одном worktree. Каждый агент использует собственную ветку и clone/worktree.
|
||||
- Статус milestone, Evidence и `OPENWC_TARGET_DONE` изменяет только назначенный интегратор.
|
||||
- Каждый новый/существенно изменённый модуль обязан иметь актуальную specification в `docs/modules/`, inline documentation публичного API и data-flow diagram по `docs/DOCUMENTATION_STANDARD.md`.
|
||||
- Stateful/async/cross-layer работа обязана документировать state/sequence diagram, ownership, threading, failure и recovery paths.
|
||||
- Документация обновляется в том же work package, что код. Handoff без обязательной документации имеет статус только `PARTIAL`.
|
||||
|
||||
## Метки состояния
|
||||
|
||||
В каждом `targets/*.md` присутствует ровно одна метка:
|
||||
В каждом исполняемом target-файле `targets/[0-9][0-9]-*.md` присутствует ровно одна метка. Справочные документы `targets/DEVELOPMENT_ROADMAP.md` и `targets/roadmap/*.md` меток состояния не имеют:
|
||||
|
||||
- `<!-- OPENWC_TARGET:OPEN -->` — цель ещё не начата.
|
||||
- `<!-- OPENWC_TARGET:ACTIVE -->` — единственная текущая цель.
|
||||
@@ -53,6 +62,7 @@
|
||||
3. В Evidence записаны команды, результаты и изменённые файлы.
|
||||
4. Не осталось обязательных незакрытых пунктов или скрытых заглушек.
|
||||
5. Обновлены `targets/README.md` и матрица функций, если применимо.
|
||||
6. Публичный API, module spec, input/output tables и обязательные diagrams соответствуют фактической реализации.
|
||||
|
||||
Агент НЕ ДОЛЖЕН ставить `DONE` только потому, что код компилируется. Если пользователь явно принял частичный результат, статус остаётся `ACTIVE`, а принятое ограничение записывается в Evidence.
|
||||
|
||||
@@ -64,4 +74,5 @@
|
||||
- что изменено;
|
||||
- какие проверки выполнены;
|
||||
- fidelity evidence для поведения 3.3.5a;
|
||||
- оставшиеся риски или следующий незакрытый checklist item.
|
||||
- оставшиеся риски или следующий незакрытый checklist item;
|
||||
- какие API/module docs и diagrams созданы или обновлены.
|
||||
|
||||
Reference in New Issue
Block a user