Files
orchestrator/docs/overview
claude-bot 58e5dfe55d
All checks were successful
CI / test (push) Successful in 1m15s
CI / test (pull_request) Successful in 1m12s
docs(serial-gate): sync system showcase + clean stray tags (ORCH-124)
Addresses reviewer REQUEST_CHANGES (run 768) on ORCH-124 — docs-only,
no src/tests touched, fix scope unchanged.

P1: update docs/overview/ showcase for the new serial-gate "pause without
blocking" axis (changed task-routing functionality, ORCH-011/ORCH-079):
- tech-pipeline.md: FIFO exception "pause without blocking" next to freeze
- tech-data-model.md: durable signal tasks.paused_at on the Task row
- tech-observability.md: paused/reason in serial_gate GET /queue block +
  operator endpoints POST /serial-gate/pause|resume

P2: strip leaked tool-call trailing tags (</content>/</invoke>) from 4
golden-source docs of this PR (06-adr/ADR-001, adr-0051,
08-data-requirements.md, 10-tech-risks.md).

CHANGELOG "Доки" bullet extended accordingly. Full suite green (2178 passed);
test_system_docs.py green (machine-checked showcase facts intact).

Refs: ORCH-124
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-16 21:50:45 +03:00
..

Витрина системы — Orchestrator

Что это за система. Orchestrator — автономная фабрика разработки: конвейер из шести ИИ-агентов (аналитик → архитектор → разработчик → ревьюер → тестировщик → деплойер), который проводит задачу от бизнес-постановки до выкладки на прод. Человек ставит задачу и принимает результат; всё между — автономно, под защитой машинных гейтов качества. Платформа ведёт несколько проектов из одного инстанса, дорабатывает сама себя (self-hosting) и тиражируется на новые хосты.

Зачем эта витрина. Это единая точка входа в документацию системы: связное описание на двух уровнях — бизнес (для нетехнического читателя) и технический (7 блоков), с маршрутами чтения для трёх аудиторий и слайдо-готовой основой для презентации. Витрина — обзор; за деталями она ведёт ссылками в инженерные golden sources, не подменяя их.


Состав витрины

Файл О чём
business.md Бизнес-уровень: проблема, решение, что умеет, ценность, сценарии
tech-architecture.md Блок 1: компоненты и связи, схема потока
tech-pipeline.md Блок 2: конвейер, стадии, гейты, откаты, человеческие гейты
tech-agents.md Блок 3: 6 ролей агентов, артефакты, модель/эффорт
tech-data-model.md Блок 4: каноническая модель объектов, словарь терминов
tech-integrations.md Блок 5: Plane, Gitea, LLM, Telegram
tech-quality-security.md Блок 6: гейты качества, безопасность, секреты
tech-observability.md Блок 7: наблюдаемость, аналитика, журнал уроков
presentation.md Слайдо-источник презентации + сборка .pptx

Маршруты чтения

Я заказчик

  1. business.md — проблема, решение, ценность.
  2. business.md → Сценарии использования — как это выглядит в работе.
  3. presentation.md — слайдовая версия рассказа (собирается в PowerPoint).
  4. Развернуть у себя: LITE_SETUP (своя инфраструктура) или BUNDLED_SETUP (весь стек одним комплектом).

Я менеджер проекта

  1. business.md — что платформа делает и где в процессе человек.
  2. tech-pipeline.md — конвейер, статусная модель Plane, человеческие гейты (одобрение постановки, подтверждение прод-деплоя).
  3. tech-observability.md — как следить за ходом: живая Telegram-карточка, статусы, стоимость.

Я разработчик

  1. Тех-блоки 1→7: архитектураконвейерагентымодель объектовинтеграциикачество/безопасностьнаблюдаемость.
  2. Инженерный справочник архитектуры и internals — детали реализации.
  3. Стандарты (структура доков конвейера), HANDOFF_PROTOCOL (машинный контракт стадий), TRACEABILITY (маркеры решений).
  4. Реестр сквозных ADR — история архитектурных решений.
  5. CLAUDE.md — паспорт проекта и правила для агентов.

Норматив сопровождения

Изменил функциональность платформы → обнови витрину docs/overview/ в том же PR.

Какой файл правится при каком классе изменений:

Класс изменения Файл витрины
Новый компонент / демон / поток данных tech-architecture.md
Стадии, гейты, под-гейты, маршруты задач tech-pipeline.md
Роли агентов, промпты, модель/эффорт tech-agents.md
Таблицы БД, объекты, термины tech-data-model.md
Plane / Gitea / LLM / Telegram tech-integrations.md
Гейты качества, секреты, self-hosting-страховки tech-quality-security.md
Эндпоинты наблюдаемости, метрики, уроки tech-observability.md
Новая способность уровня продукта business.md + при необходимости presentation.md

Каркас и машинно-проверяемые факты витрины (перечень стадий, имена гейтов, полнота агентов, валидность ссылок) защищены структурными тестами tests/test_system_docs.py — дрейф рвёт CI. Прозу проверяет reviewer: необновлённая витрина при изменении описанной в ней функциональности — finding ≥ P1 (расширение оси обзорных доков).


Витрина — обзорный слой документации. Текущее состояние и реестр доработок — CLAUDE.md; концепция развития — Product Vision.