Charter команды документации¶

Миссия¶

Поддерживать документацию продукта (Exchange-платформа: админ-панель + ~40 микросервисов) в актуальном, сверенном с кодом состоянии: бизнес-сценарии, сквозная картина, диаграммы, тест-кейсы/unit-тесты.

Состав и зоны (субагенты `.claude/agents/`)¶

doc-cto — оркестрация, приёмка, тест-кейсы/unit-тесты, передача. Точка входа.
doc-sa — сценарии по сервисам, сверка с кодом.
doc-ba — сквозные сценарии, user stories, глоссарий.
doc-architect — диаграммы (Mermaid), карты потоков данных.

4 направления работы¶

Бизнес-сценарии актуальны (весь проект + по сервисам) — docs/scenarios/, docs/services/.
Сквозная документация по сценариям — единый путь пользователя через сервисы.
Тест-кейсы и unit-тесты для проверки соблюдения сценариев — docs/testing/ (кейсы) + репозитории сервисов (unit, ветка+MR).
Диаграммы по сценариям — docs/diagrams/ (Mermaid).

Источники истины (приоритет)¶

Код сервисов — CREL/*, services/*.
admin_panel/docs/ — актуальная платформенная документация (services/, analysis/, ARCHITECTURE.md, services_data.md, CLAUDE.md).
docs/wiki/ — выгрузка с wiki.gsmsoft.eu (исходные сценарии; сверять с кодом, может отставать).

Процесс (цикл актуализации)¶

Триггер: изменение функционала сервиса / запрос / плановая сверка.
doc-cto ставит задачу → doc-sa/doc-ba (текст), doc-architect (диаграмма).
doc-cto готовит/обновляет тест-кейс + требует unit-тест в сервисе.
Приёмка doc-cto: сверка с кодом, отсутствие выдумок/секретов, обновлён индекс, проставлена дата.

Definition of Done¶

Сценарий: участники, триггер, пред/постусловия, шаги (happy+alt), сервисы/эндпоинты/события, ссылки на код (путь:строка), дата сверки.
Диаграмма: Mermaid, реальные узлы/рёбра, ссылка на сценарий+код.
Тест-кейс: привязан к сценарию и сервису, синтетические данные, статус; для финопераций — тест целостности.
Обновлены индексы (scenarios/, testing/).

Границы (обязательны, финтех)¶

Русский, *.md. Без внешних CDN (CSP/офлайн MkDocs).
PII/код/секреты не слать в LLM (Anthropic DPA не подписан). В доках/тестах — только синтетические данные, без DSN/токенов.
service_connect = источник gRPC-адресов; деньги = decimal/NUMERIC; мультипроектная изоляция (project_id).
Не выдумывать поведение — подтверждать кодом.

Структура репозитория¶

docs/
  index.md              # обзор продукта
  services/             # по сервисам
  scenarios/            # сценарии (сквозные + по сервисам)
  schemes/              # схемы
  integrations/         # внешние партнёры
  diagrams/             # диаграммы (Mermaid)
  testing/              # тест-кейсы
  team/                 # этот раздел (charter/handoff)
  wiki/                 # выгрузка исходной Wiki (материал)
  _archive/             # старый контент (TAL/staking) — не поддерживается
.claude/agents/         # субагенты doc-sa/doc-ba/doc-architect/doc-cto
mkdocs.yml              # сборка сайта (MkDocs Material)