← Все новости

Виджет для Confluence: диаграммы и спецификации из «Помощника SA» прямо на страницах

Схемы и спецификации обычно живут в одном месте, а документация по системе — в Confluence. Теперь их не нужно копировать скриншотами: вышел виджет для Confluence — макрос «Помощник системного аналитика» для Confluence Data Center и Server.

Как это выглядит

В макрос вставляется ссылка «Поделиться» на документ или на конкретную версию. На странице появляется:

  • заголовок — название документа со ссылкой на источник, номер версии, автор и дата изменения;
  • картинка — миниатюра нужной ширины (её задают в параметрах макроса), щелчок открывает картинку в полном размере;
  • аккордеон «Исходный код» — текст документа с подсветкой и номерами строк.

Картинка есть у диаграмм PlantUML, BPMN и DBML. Для OpenAPI, AsyncAPI, XSD, WSDL, JSON Schema, YAML, JSON, Markdown и AsciiDoc виджет показывает ссылку и исходный код.

Версия не уедет

При вставке ссылки на документ макрос закрепляет его текущую версию: документ продолжают править, а страница Confluence показывает то, что согласовали. Чтобы обновить виджет до свежей версии, достаточно очистить поле «Версия документа» в параметрах макроса и сохранить его. Ссылка на конкретную версию всегда показывает именно её.

Как подключить

Плагин устанавливает администратор Confluence: скачать файл, загрузить его в «Управление приложениями» и разрешить в настройках адрес https://helper-sa.ru. Подробная инструкция — в репозитории виджета. Ссылку «Поделиться» создают в редакторе документа или в истории версий — по ней документ открывается только на чтение.