claude-bot
dbd8df6eb2
Create docs/operations/FAQ_STOP.md — a user-facing "вопрос → ответ" FAQ for Plane board users explaining the STOP status: what it does, how to cancel a task, step-by-step consequences (agent stops → jobs cancelled → working branch and worktree removed → task → cancelled → Telegram+Plane; docs artifacts preserved, main/prod untouched), deferred cancellation in the critical merge/deploy window, explicit "STOP does NOT revert merged/deployed code" (revert is a separate task), restart only via "To Analyse" from scratch, no-op causes, where to observe the result, and STOP/Approved/Confirm Deploy disambig. docs-only: src/**, STAGE_TRANSITIONS, QG_CHECKS, check_*, machine-verdict keys and the DB schema are byte-for-byte untouched. STOP behaviour source of truth remains ORCH-090 (adr-0026); the FAQ documents and links to it (link-first: machine details markers/lease/tombstone given by reference, not duplicated). Add two-way cross-links: docs/overview/business.md (Сценарий 6) and docs/overview/tech-pipeline.md (Отмена: STOP → cancelled) → FAQ; FAQ → overview + ADR ORCH-090. Structure guarded by deterministic anti-drift test tests/test_faq_stop_doc.py (offline, no network/LLM/subprocess; mirrors tests/test_lite_setup_doc.py): existence + 8 section anchors + fact bricks + cross-links + claim-level negative scan (sentence-level, not bare substrings, so it never false-fails on correctly negating phrases — TR-3, with a non-evergreen self-check). Full pytest tests/ green (2227 passed). Refs: ORCH-108 Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Витрина системы — 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 |
Маршруты чтения
Я заказчик
- business.md — проблема, решение, ценность.
- business.md → Сценарии использования — как это выглядит в работе.
- presentation.md — слайдовая версия рассказа (собирается в PowerPoint).
- Развернуть у себя: LITE_SETUP (своя инфраструктура) или BUNDLED_SETUP (весь стек одним комплектом).
Я менеджер проекта
- business.md — что платформа делает и где в процессе человек.
- tech-pipeline.md — конвейер, статусная модель Plane, человеческие гейты (одобрение постановки, подтверждение прод-деплоя).
- tech-observability.md — как следить за ходом: живая Telegram-карточка, статусы, стоимость.
Я разработчик
- Тех-блоки 1→7: архитектура → конвейер → агенты → модель объектов → интеграции → качество/безопасность → наблюдаемость.
- Инженерный справочник архитектуры и internals — детали реализации.
- Стандарты (структура доков конвейера), HANDOFF_PROTOCOL (машинный контракт стадий), TRACEABILITY (маркеры решений).
- Реестр сквозных ADR — история архитектурных решений.
- 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.