Zimin A.N.
07c5ca04c9
Готовит ground для тага v1.1.0 после окончания Approval Workflow v2 soak'а на staging (≥7 дней с 2026-05-08 → target ≥2026-05-15). - docs-internal/releases/v1.1.0.md — полные release notes: Track A (Approval Workflow v2 P0–P4, 8 commits) + Track B (5 CEO v1 gap closures), migrations 0017-0020, API surface additions, decisions D1-D4 rationale, 6 lessons learned, cluster ops checklist, out-of-scope list (deferred к v3 design doc). - docs-internal/releases/v1.1.0-tag-message.txt — готовый текст для `git tag -a v1.1.0 -F docs-internal/releases/v1.1.0-tag-message.txt`. NOT тагаем сейчас — soak ahead. Documentация заранее = меньше work после soak conclusion. Если в soak найдутся issues, release notes проще обновить чем писать с нуля.
Ordinis — internal documentation
Технические детали реализации, архитектура, operator runbooks и project state snapshots. НЕ deployment'ится через Diplodoc — это внутренние артефакты для команды Ordinis (не для consumers).
Consumer-facing документация находится в docs/ и build'ится через
Diplodoc → static HTML.
Что внутри
docs-internal/
├── ops/ # Operator runbook (on-call, incidents, recovery)
│ ├── README.md
│ ├── slo.md
│ ├── outbox-dlq.md
│ ├── db-migrations.md
│ ├── vault-unseal.md
│ └── kafka-restart.md
├── status/ # Project state snapshots (по дням сессий)
│ └── *-state.md
└── tech/ # Архитектурные deep-dives, legacy документы
└── api-integration.md # legacy (мигрирован в docs/integration/api/)
Когда что использовать
| Situation | Read |
|---|---|
| Я — consumer интегрирующий свой backend | docs/integration/api/ (Diplodoc) |
| Я — on-call инженер с alert | ops/README.md |
| Я — Ordinis dev планирующий feature | status/ latest snapshot + design docs в ~/.gstack/projects/claude/ |
| Я — новый разработчик в команде | Сначала consumer docs, потом ops/, потом status/ для context |
Архитектурные artifacts (вне репозитория)
Design docs / план-плансы хранятся в ~/.gstack/projects/claude/:
zimin-main-design-production-prep-20260507-123032.md— prod stand-up planzimin-main-design-approval-workflow-v2-20260507-121632.md— approval flow v2 (DEFERRED)zimin-main-design-dict-relationships-v2-20260507-230237.md— lineage + cascade rulescheckpoints/*.md— session state checkpoints для context-restore
Rationale разделения
Diplodoc документация — public contract для интеграторов:
- Может быть опубликована на public Pages
- Не должна leak'ать internal architecture (security)
- Должна быть стабильной (consumer'ы строят на ней свои интеграции)
docs-internal/ — operational state:
- Runbooks меняются часто (incidents, lessons learned)
- Status snapshots — historical record для команды
- Tech deep-dives — для разработчиков, не consumers
Это разделение делает Diplodoc более фокусированным и менее шумным для consumers.