Comments 19
Насколько это быстрее, чем рисовать в Визио?
У меня есть желание нарисовать uml-диаграммы для системы, в которой более 100 классов, в каждом из которых несколько переменных, и еще десятки связей между ними (ORM). Пока не знаю, с какой стороны подступиться...
Оправдает ли себя plantuml с учётом затрат времени, чтобы разобраться в его кодировке?
Диаграммы классов не пробовала, но sequence точно быстрее. Конкретных цифр не заменяла, но печатать текст быстрее, чем рисовать фигуры и соединять их вручную стрелочками.
Например, у меня был сервис с 4 методами (создание, изменение, удаление и получение записи), это 4 диаграммы. Пришёл менеджер и говорит, мы будем должны подключить в эту интеграцию ещё системы, в visio мне бы пришлось открывать каждую схему, двигать кубики, потому что системы добавлялись в середину процесса, то есть остальные смещались. А в plantuml я добавила текста, скопировала во всё 4 диаграммы и готово.
Также при переименовании какого то участника я автозаменой по всему тексту прошла и поправила.
Чтобы оценить на сколько быстрее, можете взять пример из статьи sequence, отрисовать в визио и попробовать поправить текст, добавив посередине ещё одну систему и в визио и сравните насколько.
Тут экономия будет даже больше в том, чтобы быстро заменить названия, элементы автозаменой, быстрее будет элемент к которому идёт множество связей.
Бывает быстрее в визио накидать и красивее, но бывает проще в PlantUML
Часто настройка цветов диаграммы и расположения элементов это не просто эстетический момент, но и прямое требование к оформлению документации или презентации компании, согласно её дизайн коду.
Не говоря уже о косяках которые проявятся если сильно менять содержимое диаграмм.
Весь выигрыш скорости от ручного редактирования придется потратить на решение проблем визуального представления.
Цвета можно менять с помощью skinparam: https://plantuml.com/ru/skinparam
Расположением тоже можно управлять, но не очень гибко
Человеку с опытом разработки - совсем недолго разобраться. Я быстренько пробежался по диагонали по докам и накидал диаграмму состояний с кучей фич.
Основное преимущество перед Visio, Draw.io и прочими - ты сконцентрирован на самой задаче, а красивая отрисовка - дело софта. Потом пробежался, раскидал тэги и всё уже совсем хорошо.
А в Visio львиная доля уходит на двигание элементов тудя-сюда. Иногда ловишь себя на мысли, что уже полчаса гоняешь элементы по листу, следуя за смутным чувством прекрасного, а ничего в самой схеме не меняется.
Инструментом можно воспользоваться при помощи:
Онлайн редактора с синтаксисом plantuml https://www.planttext.com/ ;
Макроса в Confluence "PlantUML Macro";
Плагина "PlantUML Integration" для Idea, если пишите документацию рядом с кодом (скачать тут)
Еще есть в виде расширения для VS Code.
Пользуюсь. В Яндекс.Вики это почти нативный инструмент. Удобно описывать и править, но на лету не так удобно, как в визуальных средствах.
Даёт возможность искать по документу вики текстом в том числе из диаграмм
Yandex wiki это аналогично конфлюенсе? Может поделитесь опытом использования, как она для документации?
В некотором роде аналогично. В основе там была маркдаун-стайл разметка, но сейчас они в рамках бета внедряют и WYSIWYG подход.
Для документирования вполне годится. Пока что в совокупности не дотягивает до конфлю, но, думаю, быстро нагонят. Спрос поднялся.
Про конкретно plant_uml - вот их дока: https://cloud.yandex.ru/docs/wiki/static-markup/diagram
Для 1-5 пользователей можно создавать бесплатные пространства и пробовать там
Много лет пользуюсь https://www.websequencediagrams.com/, альтернатива планта (когда искал инструмент, плант не встречался).
Для Sequence очень удобно и быстро. Но самый большой плюс - легко править и переслать. Все участники процесса могут вносить изменения без необходимости в специализированном софте или даже сервисе. После пары раз уже легко читать и править даже без визуализации.
Интересный инструмент и в каких то случаях точно быстрее, чем редакторы диаграмм, спасибо!
Но, как поправить 10 диаграмм за раз?)
Plantuml в работе системного аналитика. Пиши uml диаграммы текстом, чтобы сэкономить время