C4
👁 619↗ 10
Сейчас очень много рабочих процессов у меня связано с документированием проекта. В прошлом посте я рассказал про ADR, что позволяет иметь историю принятых архитектурных решений в проекте.
Сейчас хочу поделиться еще одним инструментом для оформления диаграмм. Но не просто диаграммы, а диаграммы которые хранятся как код.
Этим сервисом поделился со мной коллега на проекте и мы его будет внедрять.
https://likec4.dev - в чем суть?
Представьте конструктор LEGO для диаграмм: пишешь пару строк в файле, сохраняешь и схема сама перерисовывается. Это и есть LikeC4.
Все это нужно, чтобы иметь всегда свежие изображения, диаграмма хранится рядом с кодом и апдейтится при каждом пуше.
А любое изменение может проходить через код-ревью, как обычный файл.
Это также помогает сделать быстрый онбординг, ведь новичку достаточно кинуть ссылку и он сразу увидит контекст, сервисы, модули, компоненты и коммуникацию между ними.
Сама аббревиатура C4 расшифровывается как:
Context - Где наша система живет и кто к ней стучится
Container - Из каких исполняемых кусков она состоит
Component - Как устроен каждый контейнер внутри
Code - Классы, схемы БД и так далее
Каждый символ это своего рода уровень абстракции или слой или как принято говорить "Zoom".
Вот для примера как выглядит диаграма: https://playground.likec4.dev/w/bigbank/support/
Можно кликнуть на каждый компонент и провалиться внутрь (так сказать: Увеличить zoom) и посмотреть из чего состоит система.
Telegram | Youtube | Twitter
12