Разделы документацииАрхитектура сервиса

Практикум

Схема архитектуры сервиса

Покажем, из чего состоит сервис и как его части обмениваются данными: зоны группами, компоненты карточками с иконками, протоколы — подписями на связях.

Обновлено 2 октября 20262 мин чтения

На этой странице

Что получится#

Схема, по которой новый разработчик за пять минут понимает, где что живёт и кто кого вызывает, а на разборе инцидента видно, что задето.

Клиенты
Сервис заказов
Данные
Личный кабинет
React
API заказов
Go
критично
Очередь задач
PostgreSQL
Почтовый сервис
HTTPS
SQL
письма
Синхронные вызовы — «Поток», фоновые — пунктир с «Точками».

Шаги#

  1. Начните с шаблона «Архитектура ПО»

    Три группы — «Клиенты», «Бэкенд», «Данные» — и карточки с иконками. Переименуйте группы под свои зоны: двойной щелчок по названию группы.

  2. Один компонент — одна карточка

    Заголовок — имя компонента, в описании — технология и назначение одной строкой. В панели свойств выберите иконку: сервер, база данных, облако, телефон и другие.

  3. Добавьте метки и ссылку

    В поле «Метки» через запятую: «критично», «легаси», имя команды. В поле «Ссылка» — адрес репозитория или документации: на карточке появится «Открыть».

  4. Соедините и подпишите протоколы

    Связь от вызывающего к вызываемому. Подписи — «HTTPS», «SQL», «gRPC», «очередь». Стрелка показывает направление вызова.

  5. Различайте виды взаимодействия

    Синхронные вызовы — «Анимация» → «Поток», фоновые задачи и события — «Штрих» → «Штрихи» и «Анимация» → «Точки». Толщина 3–4 — для основного трафика.

  6. Отметьте состояние

    Компонент в разработке — статус «В работе», проблемный — «Заблокировано» или красный цвет по договорённости.

Уровни детализации#

Не рисуйте всё на одной доске. Удобно держать несколько досок в одном проекте: «Система целиком» (сервисы и внешние системы), «Сервис заказов изнутри» (модули и очереди), «Поток оплаты» (последовательность вызовов). В описании каждой карточки верхнего уровня можно оставить ссылку на доску с подробностями.

Типичные ошибки#

  • Связи без подписей: непонятно, синхронный это вызов или событие.
  • Все уровни на одной доске — схема превращается в паутину.
  • Карточки разных цветов без договорённости. Цвет зоны уже даёт группа.

Похожим способом строятся диаграммы потоков данных, схемы обмена данными между системами и инфраструктура. См. «Шаблоны».

Не нашли ответ? Напишите нам из приложения: пункт «Помощь» в боковой панели есть на каждом экране после входа. Ответ придёт на почту вашего аккаунта.