Devprom ALM: Руководство пользователя

При подготовке проектной документации, например, бизнес- или системных требований, хорошо использовать различные выразительные инструменты - UML-модели, BPMN-диаграммы, макеты графического интерфейса, деревья решений (ментальный карты, mind maps) и т.п.

В редактор встроена поддержка UML-моделей, реализуемая при помощи PlantUML. Это несложный язык, позволяющий в текстовой форме описывать UML-модели различных видов. Исходный код (текст) модели хранится непосредственно в разделе документа, таким образом, каждый участник процесса может внести изменения в актуальную версию диаграммы.

Например, при вставке следующего кода диаграммы:

class Car [[https://devprom.ru]]
class Driver
Driver -- Car

Приложение сформирует следующую диаграмму:

Обратите внимание, что для класса Car указана ссылка, она кликабельна и позволяет перейти к описанию соответствующего класса, требованиям к нему или к компоненту, где определены дополнительные атрибуты и связи.

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

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

При нажатии на панели инструментов кнопки "Диаграмма", откроется популярный редактор draw.io, в котором вы можете создавать диаграммы совершенно различных нотаций. Это отличная альтернатива Visio и подобных настольных инструментов. Исходный код (текст) диаграммы хранится непосредственно внутри требования, так что работает версионирование, сравнение версий и другие механизмы управления требованиями и изменениями, используемыми для текста.

При необходимости вы можете создавать диаграммы при помощи настольной версии draw.io и затем импортировать их в документ.

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

Если вы используете другие инструменты для подготовки диаграмм, то результат работы можете вставить в виде изображения или встроенного HTML. При этом если исходная модель или диаграмма обновятся, то они обновятся и в тексте требования. Достигается это при помощи вставки модели как встроенного HTML (Embedded HTML). Практически все инструменты позволяют вставлять модели как встроенный HTML.

На панели инструментов выберите кнопку "Вставить HTML" и вставьте в поле для ввода текст, который сообщил вам инструмент моделирования.

Вот перечень нескольких популярных инструментов для моделирования:

• https://cawemo.com/ для построения BPMN-диаграмм
• https://www.gliffy.com для рисования диаграмм
• https://moqups.com для рисования графического интерфейса

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

Для создания деревьев решений (ментальных карт) используйте диаграммы. Добавьте новую диаграмму и в разделе "Расширенные" выберите готовую фигуру "Mind maps".

Вы можете создавать ветви, топики и идеи при помощи стрелок на диаграмме:

Для создания макетов графического интерфейса вставьте диаграмму и выберите фигуры (Mockup...), в которых можно найти все основные элементы управления для макетирования пользовательского графического интерфейса. Если такой категории фигур нет, то нажмите кнопку "Больше фигур" и подключите необходимые категории.