Архитектура: обзор

Раздел описывает архитектуру всей платформы, ключевые технические решения, взаимосвязи модулей и правила ведения архитектурной документации. Здесь находится всё, что касается устройства системы: от ADR до схем взаимодействия сервисов.

Когда нужно обновлять документацию

Обновление обязательно, если меняется:

• архитектурный подход
• структура модулей
• принципы взаимодействия
• выбор технологии
• схема деплоя
• стратегия кэширования / логирования
• структура репозитория

Всё это фиксируется через ADR.

Рекомендации по ведению документации

• пишем кратко, без воды
• архитектурная документация должна помогать быстро понять систему
• каждое важное архитектурное решение — через ADR
• схемы обновляем при изменениях в коде
• документация должна быть полезнее, чем чтение репозитория