Архитектура есть только в коде
Чтобы понять, какой сервис куда ходит, нужно читать репозитории. Схемы либо нет, либо она нарисована год назад и уже не про эту систему.
Архитектура ПО
Разложите систему по слоям — клиенты, бэкенд, данные — и соедините сервисы связями с бегущим потоком. Новый разработчик понимает устройство проекта за пять минут, а не за неделю чтения кода.
14 дней полного доступа · без привязки карты
Знакомо?
Три ситуации, в которых схема на доске экономит часы объяснений.
Чтобы понять, какой сервис куда ходит, нужно читать репозитории. Схемы либо нет, либо она нарисована год назад и уже не про эту систему.
Десять прямоугольников и двадцать линий: кто инициирует запрос и что происходит следом — приходится объяснять голосом на каждом ревью.
Добавили сервис — нужно раздвигать половину блоков вручную. Поэтому никто и не добавляет.
Решение
У каждого сервиса — иконка, название, технология в описании и статус. База, очередь, шлюз и хранилище различаются с первого взгляда.
«Клиенты», «Бэкенд», «Данные» — цветные рамки, внутри которых лежат сервисы. Перетащили группу — всё содержимое переехало вместе с ней.
Анимация потока показывает, откуда и куда идёт вызов. Подпишите протокол прямо на связи: HTTPS, gRPC, очередь событий.
Вопросы к конкретному сервису — комментарием у его карточки. Решение остаётся в истории рядом со схемой, а не в треде, который никто не найдёт.
Пошагово
Кому пригодится
Архитекторам, тимлидам, бэкенд- и DevOps-инженерам, техническим писателям и тем, кто вводит новых людей в проект.
Шаблоны
Шаблон открывается в один щелчок: блоки разложены, связи проведены — остаётся заменить тексты.
Клиенты, сервисы и хранилища: покажите, как устроена система
Кто передаёт данные, какие процессы их обрабатывают и где они хранятся
Вопросы и ответы
Жёсткой нотации NodePanel не навязывает, но блоков достаточно, чтобы нарисовать контекст, контейнеры и компоненты: карточки, фигуры, группы и подписи на связях. Для потоков данных есть отдельный шаблон «Диаграмма потоков данных».
Выберите сервис — его связи и соседи подсветятся. В режиме фокуса всё остальное приглушается. Фильтр по типам скрывает, например, стикеры с заметками, а мини-карта помогает перемещаться по холсту.
Да: пригласите их с ролью «только просмотр» или включите публичную ссылку на доску. Посмотреть схему они смогут, а изменить — нет.
Другие сценарии
Создайте доску из шаблона, замените тексты на свои и покажите её команде.
Создать первую доску14 дней полного доступа · без привязки карты · ничего не нужно устанавливать