PlantUML для всех от мала до велика

В своей работе мы привыкли использовать различные графические средства. Одни предпочитают draw.io, другие — Enterprise Architect, а некоторые — даже Visio. Я не буду останавливаться на их или проводить сравнение, а хотел бы сосредоточиться конкретно на PlantUML.

Этот инструмент позволяет создавать диаграммы без необходимости манипулировать графическими элементами в режиме визуального редактора. Определение элементов, связей между ними и оформление в целом выполняется с помощью текстовых инструкций, такого своеобразного кода. Это то, что называется Diagram as Code (DaC).

Во многих случаях разработка диаграмм кодом оказывается эффективной, а освоение азов происходит достаточно быстро. Хотя и здесь, конечно, есть свой порог вхождения. И чтобы снизить этот порог и минимизировать недопонимание, я подготовил список материалов, с которыми точно стоит познакомиться поближе.

Для тех, кто начинает использовать PlantUML или только задумывается об этом, предлагаю посмотреть запись представленного доклада. Из него вы узнаете о том, почему этот инструмент стоит применять, какие боли снимает и как начать его использовать уже сегодня.

Помимо этого вы получите заряд мотивации для изучения.

Это тот ресурс, с которого стоит начать изучение PlantUML. Но это не всё. Надо иметь в виду, что по мере освоения этого инструмента у вас будут появляться вопросы вида: «А как сделать так, чтобы...». И в таких случая тоже стоит возвращаться к данному ресурсу, используя его как справочник.

Кроме того, функциональные возможности PlantUML постоянно развиваются, и узнать о новшествах можно будет именно из официальной документации.

Если вы уже имеете некоторый опыт разработки диаграмм в PlantUML, то советую прочитать данную статью. В ней я привожу большое число полезных советов, разъясняю особенности работы движка «под капотом» и рассказываю о далеко не самых очевидных возможностях PlantUML. Вполне возможно, что проблемы, с которыми вы сталкивались на практике, решаются с помощью приведённых в статье рекомендаций.

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

Данная статья поднимает вопросы ведения документации рядом с кодом: зачем это может быть нужно, какие могут быть сложности, чем это лучше или хуже размещения артефактов в Confluence.

Если для документирования вы используете PlantUML и рассматриваете возможность размещения документации в кодовой базе, то рекомендую ознакомиться с данной статьёй и следующими за ней комментариями.

Ещё больше полезных материалов доступно в моём телеграм-канале. Обязательно подписывайтесь, буду рад всех видеть.