5.6 KiB
5.6 KiB
TextMachine — документация
Проект: издательский художественный перевод крупных текстов (книги, ранобэ, вебновеллы; zh/ja/en→ru) мультиагентным пайплайном поверх LLM API. Go-бэкенд + веб-фронт ридер-IDE (Ф3). Цели и мерило — канон в ../CLAUDE.md; онбординг сессий — там же. Стартовый бриф владельца: ../START_PROMT.MD — живой документ, его V-идеи разобраны в реестр требований (ниже).
Состояние проекта НЕ здесь. Очередь, курс, бэклог — CURRENT-STATE в шапке PROGRESS.md; решения — architecture/05-decisions-log.md (при конфликте с любым доком побеждает он). Эта страница — только карта «что где лежит».
Карта
- glossary.md — жаргон и сокращения (D-номер, паки, банк, голден, K/DC/H/L…) одним экраном.
- product-requirements.md — реестр «что продукт обязан уметь»: START_PROMT V0–V5 + находки H6–H18, статусы сверены кодом.
architecture/— синтез и контракты:- 05-decisions-log.md — источник истины по решениям. Читать: карта актуальности (шапка) + живая голова (с хвоста); корпус D1–D38 — справочник по ссылкам/grep, целиком не читать.
- 09-target-architecture.md — целевая 7-слойная архитектура (статус стройки — шапка-таблица; §3 — карта находок H/L) · 10-prompt-architecture.md — промпт-слой · 12-go-style-notes.md — норматив общности §0 · 13-tech-debt-anchors.md — якоря техдолга (справочник к бэклогу, НЕ трекер).
- Исторические, читать через ⚠-баннеры: 01-decisions.md (Р1–Р10) · 02-mvp-plan.md · 03-implementation-notes.md · 04-unhappy-paths.md · 06-memory-risk-registry.md.
experiments/— эмпирика полигона: 00-provider-quirks.md — читать перед любым вызовом провайдера; 08-cost-model-v2.md — денежная модель; 09-pilot-protocol.md — пилот Ф2.5; остальные 01–16 — отчёты закрытых экспериментов (судьба — в баннерах/D-логе).research/— фактура ресёрчей 01–22; у принятых — ревью-шапки, часть тел под ⚠ superseded: читай баннер прежде содержимого. Ключевые для навигации: 15 голос · 16 ридер-IDE · 17 внешняя критика · 18 рычаги качества · 19 нарезка · 20 банк-майнинг · 21 обзор транспорта · 22 доменные харнессы.- PROGRESS.md — журнал: CURRENT-STATE + ЕДИНЫЙ БЭКЛОГ (единственный трекер) + живой хвост хроники. НЕ источник решений.
- Активные хендофф-промты сессий (состав обновляется при каждом лендинге — норма D39.80): ORCHESTRATOR_SESSION_PROMPT.md (роль/нормы; состояния не дублирует) · POLYGON_PACKAGE4_SESSION_PROMPT.md (полигон, отложен). · BACKEND_COLDRUN_DEBUG_SESSION_PROMPT.md (текущий бэкендный: ре-проба flash + отладочный холодный прогон coldrun-b). Фронт-промт — в чужой зоне
frontend/docs/. archive/— история (правила архива): закрытые промты (prompts/) · отчёты с ревью-шапками (reports/— на них ссылаются приёмки) · исполненные арх-доки (architecture/) · слайсы хроникиPROGRESS-*.md. Инструкции оттуда не исполнять.- Диаграммы: ../backend/docs/components.puml · ../backend/docs/pipeline.puml — дом рядом с кодом (D39.80), правятся бэкендом одним коммитом с кодом; вручную НЕ рендерить (владелец смотрит PlantUML-расширением VS Code).
Доступные ключи от моделей
DEEPSEEK_API_KEY, ZAI_API_KEY, KIMI_API_KEY, OPENAI_API_KEY, GEMINI_API_KEY, XAI_API_KEY, MISTRAL_API_KEY