Порой у аналитика возникает задача описать некоторый контекст, в рамках которого будет производиться доработка или решение. Обычно такие описания содержат ключевые сведения (участники и их роли, системы, процессы, данные и тд).
Предлагаю простой способ описания - диаграмма контекста с4
О том что это и как - https://c4model.com/
(дядька мучался с разными описаниями архитектуры и придумал свою, очень удобно, не является лекарственным препаратом, перед применением проконсультируйтесь с тимлидом)
Вы конечно можете нарисовать все что угодно в draw.io и будете правы, но для тех, кто не хочет работать с выравнием
Значит есть крутой канал на эту конкретную тему - @Analyst_Boost
Речь конечно о плагине - https://plantuml.com/ru/
и у него есть поддержка C4 схемок, крутота
Краткий гайд, как начать пользоваться
1. Если вам не важна корп тайна и вы не подписывали NDA или хотите в личных целях попробовать - https://www.plantuml.com/plantuml/uml/SyfFKj2rKt3CoKnELR1Io4ZDoSa70000 (онлайн)
2. Если хотите чтобы приватно было и секурно, чтобы данные локально лежали, тоооооо
3. Скачайте редактор кода VS Code с оф. сайта под вашу платформу. (https://code.visualstudio.com/)
4. Откройте редактор => расширения => найдите плагин PlantUML (у него более 2 млн скачиваний)
5. Установите плагин
6. Перейдите в страничку описания плагина в магазине, найдите пункт "Requirements for Local render" (это надо чтобы диаграммки рендерились у вас локально, иначе см п.1)
7. Следуйте инструкциям в этом пункте (в общем надо поставить пару пакетов, если что пишите)
8. Перейдите в настройки расширений, найдите пункт render server и выберите "local"
9. Создайте файл some_file.plantuml (также можно .puml)
10. Вставьте ниже приведенный код
11. Нажмите alt+D и вуаля, появится preview
Документация (что можно делать) - https://github.com/plantuml-stdlib/C4-PlantUML
А теперь пример из официальной документации (другие туть - https://github.com/plantuml-stdlib/C4-PlantUML/tree/master/samples)
#system_design@analyst_exe