Tracium

Главная человеческая точка входа в документацию проекта. Эта страница нужна, чтобы за несколько минут понять, что уже есть в репозитории, что пока описано только как target design и куда идти дальше.

Важно: в репозитории смешаны два типа знаний:

• Текущее состояние репозитория и локального контура: что уже есть в коде, deploy и tooling.
• Целевая продуктовая и архитектурная модель: какую систему проект должен получить по мере развития.

Если не держать это различие в голове, возникает ложное ощущение, что все сервисы и модули уже реализованы. Сейчас это не так: часть документов описывает target design, часть — текущее состояние.

С чего начать

• Что строим: 00-overview/vision.md → 00-overview/high-level-concept.md → 10-business/domain-model.md.
• Что реально можно запускать сейчас: 40-operations/deployment.md → 50-processes/contributing.md → 50-processes/testing-strategy.md.
• Как устроена целевая архитектура: 20-architecture/principles.md → 20-architecture/high-level-architecture.md → 20-architecture/module-layout.md.
• Границы сервисов и контракты: 30-services/index.md, затем README нужного сервиса.
• Что пока не определено: 00-overview/roadmap.md и 00-overview/open-questions.md.

Как устроена документация

Раздел	На какие вопросы отвечает	Что это за знание
00-overview/vision.md	Зачем проект существует и куда идёт	Обзор + статус проекта
10-business/domain-model.md	Какие сущности, правила и термины есть в домене	Целевая бизнес-модель
20-architecture/high-level-architecture.md	Как должна быть устроена система и почему	Целевая архитектура + ADR
30-services/index.md	За что отвечает каждый сервис, каков его статус и где искать контракты	Карта целевых сервисных границ
40-operations/deployment.md	Как поднять локальный контур и как его эксплуатировать	Текущее окружение и эксплуатация
50-processes/documentation-standard.md	Как поддерживать корпус в консистентном состоянии	Правила работы с проектом

Что уже есть в репозитории

Сейчас репозиторий находится на ранней стадии и содержит в первую очередь каркас проекта:

• backend/ — минимальный Go backend с api-server и простым HTTP handler.
• docs/docs/ — каноническая документация, из которой собирается сайт.
• deploy/ — локальный ingress и окружение для запуска.
• deploy/docker/resources/docs-quartz/, CHANGELOG.md, VERSION, CI-конфиги — каркас docs-as-code и release-процесса.

Иными словами: код сейчас покрывает базовый scaffold, а документация уже описывает систему следующего масштаба.

Как не ошибиться при чтении сервисных README

Каждый сервисный README должен отвечать на три вопроса прямо в начале:

1. Это описание текущей реализации или целевой сервисной границы?
2. Есть ли уже выделенный код сервиса в репозитории?
3. Какие схемы, ADR или соседние сервисы читать после него?

Если в README этого нет, ориентируйтесь на 50-processes/documentation-standard.md и считайте такой документ кандидатом на доработку.

Быстрые маршруты по типовым вопросам

Вопрос	Куда идти
Что за продукт и какую проблему он решает	00-overview/vision.md
Какие сущности ключевые в домене	10-business/domain-model.md
Как читать документы без путаницы между target и current	50-processes/documentation-standard.md
Как устроена целевая архитектура	20-architecture/high-level-architecture.md
Какие сервисы вообще предполагаются	30-services/index.md
Что реально можно запустить локально сейчас	40-operations/deployment.md
Как поддерживать документацию в порядке	50-processes/documentation-standard.md