docs(overview): ORCH-011 — витрина системы docs/overview/ (бизнес+тех, 3 аудитории, презентация) #125

Merged
admin merged 7 commits from feature/ORCH-011- into main 2026-06-11 09:42:54 +03:00
Owner

ORCH-011 — Полная документация системы мультиагентов

Реализация по docs/work-items/ORCH-011/06-adr/ADR-001-system-overview-canon.md (сквозной — adr-0039). Тип изменения — docs+tests+dev-скрипт (паттерн ORCH-102/103): рантайм байт-в-байт.

Что сделано

  • docs/overview/ — 10 файлов (D1–D3, D8): индекс README.md (маршруты «Я заказчик / Я менеджер / Я разработчик», норматив «изменил функциональность → обнови витрину в том же PR», карта «класс изменения → файл»), business.md (проблема/решение/что умеет/ценность/6 сценариев; без жаргона, цифры с атрибуцией на Product Vision), 7 тех-блоков tech-*.md (link-first; схема потока в блоке 1; стадии/гейты/под-гейты в порядке security → merge → coverage → image-freshness с маркером «врезки, не стадии»; паспорта 6 ролей + таблица модель/эффорт из config), presentation.md (16 слайдов в машинно-парсимой структуре + процедура сборки «команда + Проверка:»).
  • scripts/build_presentation.py (D4/D5): python-pptx генератор .pptx в тёмном дизайне; чистый stdlib-парсер parse_slides + ленивый import pptx; дефолтный выход build/orchestrator-overview.pptx; build/ в .gitignoreбинарь не коммитится. E2E верифицирован в одноразовом venv: 16 слайдов собраны в валидный pptx.
  • tests/test_system_docs.py (D6): 29 структурных тестов без сети/LLM/subprocess — derive-сверки с кодом (STAGE_TRANSITIONS, QG_CHECKS, glob промптов, class-default'ы config), валидность ссылок + обязательные golden sources, полнотекстовый FORBIDDEN-скан (импорт из test_no_host_hardcodes.py) + секрет-эвристика с негативным самочеком, слайды каноническим парсером, pptxrequirements*/Dockerfile, указатели. Новый QG не регистрируется (ТЗ §6).
  • Reviewer-ось (D7): ось обзорных доков ORCH-079 в reviewer.md точечно расширена на витрину (finding ≥ P1); канон 52d байт-в-байт (текст только внутри существующих секций, verdict-ключ не тронут); анти-регресс ассерт в test_agent_prompts_canon.py; зеркальные правки правил №2/№6 CLAUDE.md.
  • Указатели (D8): README.md, CLAUDE.md («Структура»), docs/PRODUCT_VISION.md (врезка-ссылка; vision не переписывается), CHANGELOG.md.

Инварианты

  • src/**, docker-compose.yml, Dockerfile, requirements*, схема БД — ноль изменений (NFR-1; машинный гард TC-09/TC-11).
  • STAGE_TRANSITIONS / QG_CHECKS / check_* / machine-verdict ключи — не тронуты.
  • Правка reviewer.md сверена с ADR ORCH-079/ORCH-092 (маркеры в правиле №6 CLAUDE.md): расширение трактовки той же оси, инварианты сохранены.

Проверки

  • pytest tests/ -q1873 passed (полный регресс, включая 29 новых + расширенный canon-тест).
  • ruff checkмои файлы чистые (test_system_docs.py, build_presentation.py, test_agent_prompts_canon.py: All checks passed); baseline-нарушения свежего ruff в остальном репо существуют и без этого диффа (CI ruff не гоняет; вне объёма ORCH-011).

Прозрачность объёма

Дифф +1528 строк — на границе ориентира ~1500: ~70% — markdown-проза витрины, прямо предписанная ТЗ/ADR (10 файлов, R-3: объём одного прогона принят архитектором; молчаливого сокращения нет — доставлено всё). Декомпозиция не требуется.

Refs: ORCH-011

🤖 Generated with Claude Code

## ORCH-011 — Полная документация системы мультиагентов Реализация по `docs/work-items/ORCH-011/06-adr/ADR-001-system-overview-canon.md` (сквозной — `adr-0039`). Тип изменения — **docs+tests+dev-скрипт** (паттерн ORCH-102/103): рантайм байт-в-байт. ### Что сделано - **`docs/overview/` — 10 файлов (D1–D3, D8):** индекс `README.md` (маршруты «Я заказчик / Я менеджер / Я разработчик», норматив «изменил функциональность → обнови витрину в том же PR», карта «класс изменения → файл»), `business.md` (проблема/решение/что умеет/ценность/6 сценариев; без жаргона, цифры с атрибуцией на Product Vision), 7 тех-блоков `tech-*.md` (link-first; схема потока в блоке 1; стадии/гейты/под-гейты в порядке security → merge → coverage → image-freshness с маркером «врезки, не стадии»; паспорта 6 ролей + таблица модель/эффорт из config), `presentation.md` (16 слайдов в машинно-парсимой структуре + процедура сборки «команда + Проверка:»). - **`scripts/build_presentation.py` (D4/D5):** python-pptx генератор `.pptx` в тёмном дизайне; чистый stdlib-парсер `parse_slides` + ленивый `import pptx`; дефолтный выход `build/orchestrator-overview.pptx`; `build/` в `.gitignore` — **бинарь не коммитится**. E2E верифицирован в одноразовом venv: 16 слайдов собраны в валидный pptx. - **`tests/test_system_docs.py` (D6):** 29 структурных тестов без сети/LLM/subprocess — derive-сверки с кодом (`STAGE_TRANSITIONS`, `QG_CHECKS`, glob промптов, class-default'ы config), валидность ссылок + обязательные golden sources, полнотекстовый FORBIDDEN-скан (импорт из `test_no_host_hardcodes.py`) + секрет-эвристика с негативным самочеком, слайды каноническим парсером, `pptx` ∉ `requirements*`/`Dockerfile`, указатели. Новый QG **не** регистрируется (ТЗ §6). - **Reviewer-ось (D7):** ось обзорных доков ORCH-079 в `reviewer.md` точечно расширена на витрину (finding ≥ P1); канон 52d байт-в-байт (текст только внутри существующих секций, verdict-ключ не тронут); анти-регресс ассерт в `test_agent_prompts_canon.py`; зеркальные правки правил №2/№6 `CLAUDE.md`. - **Указатели (D8):** `README.md`, `CLAUDE.md` («Структура»), `docs/PRODUCT_VISION.md` (врезка-ссылка; vision не переписывается), `CHANGELOG.md`. ### Инварианты - `src/**`, `docker-compose.yml`, `Dockerfile`, `requirements*`, схема БД — **ноль изменений** (NFR-1; машинный гард TC-09/TC-11). - `STAGE_TRANSITIONS` / `QG_CHECKS` / `check_*` / machine-verdict ключи — не тронуты. - Правка `reviewer.md` сверена с ADR ORCH-079/ORCH-092 (маркеры в правиле №6 CLAUDE.md): расширение трактовки той же оси, инварианты сохранены. ### Проверки - `pytest tests/ -q` — **1873 passed** (полный регресс, включая 29 новых + расширенный canon-тест). - `ruff check` — **мои файлы чистые** (`test_system_docs.py`, `build_presentation.py`, `test_agent_prompts_canon.py`: All checks passed); baseline-нарушения свежего ruff в остальном репо существуют и без этого диффа (CI ruff не гоняет; вне объёма ORCH-011). ### Прозрачность объёма Дифф +1528 строк — на границе ориентира ~1500: ~70% — markdown-проза витрины, прямо предписанная ТЗ/ADR (10 файлов, R-3: объём одного прогона принят архитектором; молчаливого сокращения нет — доставлено всё). Декомпозиция не требуется. Refs: ORCH-011 🤖 Generated with [Claude Code](https://claude.com/claude-code)
admin added 6 commits 2026-06-11 09:36:42 +03:00
Единая точка входа в документацию платформы (ADR-001 D1–D9):
- docs/overview/ — 10 файлов: индекс (маршруты «Я заказчик / Я менеджер /
  Я разработчик» + норматив «изменил функциональность → обнови витрину в том же
  PR»), business.md (без жаргона, 6 сценариев), 7 тех-блоков (link-first),
  presentation.md (16 слайдов + процедура сборки «команда + Проверка:»).
- scripts/build_presentation.py — генератор .pptx в тёмном дизайне (python-pptx;
  чистый stdlib-парсер parse_slides + ленивый import pptx; бинарь не коммитится,
  build/ в .gitignore; зависимость НЕ в прод-образе — машинный гард TC-09).
- tests/test_system_docs.py — структурный анти-дрейф: derive-сверки стадий/
  гейтов/агентов импортом STAGE_TRANSITIONS/QG_CHECKS/glob промптов/config,
  валидность ссылок, FORBIDDEN-скан + секрет-эвристика, слайды каноническим
  парсером, NFR-2, указатели.
- reviewer.md — ось обзорных доков ORCH-079 расширена на витрину (D7; канон 52d
  байт-в-байт, только текст внутри секций) + анти-регресс ассерт в
  test_agent_prompts_canon.py.
- Указатели: README.md, CLAUDE.md (правила №2/№6, «Структура»),
  PRODUCT_VISION.md (врезка-ссылка), CHANGELOG.md.

Рантайм байт-в-байт: src/**, docker-compose.yml, Dockerfile, requirements* —
ноль изменений (docs+tests+dev-скрипт, паттерн ORCH-102/103). pytest: 1873 passed.

Refs: ORCH-011

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
tester(ET): auto-commit from tester run_id=636
All checks were successful
CI / test (push) Successful in 1m3s
CI / test (pull_request) Successful in 1m1s
7191b8dca2
admin force-pushed feature/ORCH-011- from 557f90492c to 7191b8dca2 2026-06-11 09:36:42 +03:00 Compare
admin merged commit 4d5e4613e5 into main 2026-06-11 09:42:54 +03:00
Sign in to join this conversation.
No Reviewers
No Label
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: admin/orchestrator#125