О документации¶

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

Целевые аудитории верхней панели навигации и описание материалов, которые в них содержатся:

Начинающим пользователям — раздел содержит вспомогательные материалы по базовым функциям Stormbpmn, таким как редактирование диаграмм, создание структуры папок и организация рабочего пространства внутри команды.
Аналитикам — раздел содержит вспомогательные материалы для аналитиков, которые раскрывают специальные возможности Stormbpmn: ИИ-помощник, автоматическая валидация по правилам BPMN, workflow согласования с комментариями к элементам, версионность, шаринг по ссылке и встраивание в Wiki/Confluence.
Архитекторам — раздел содержит вспомогательные материалы для архитекторов, которые раскрывают специальные возможности Stormbpmn: ИИ-помощник для генерации архитектурных моделей, PlantUML с UML/C4/ERD/Gantt-диаграммами и стилями, валидация синтаксиса, визуализация систем/компонентов, трассировка ролей, workflow согласования и экспорт в SVG/PDF/Wiki.
Администраторам — раздел содержит вспомогательные материалы для администраторов, которые раскрывают специальные возможности Stormbpmn: управление пользователями/ролями и правами доступа, настройка оргструктуры и workflow согласования, мониторинг активности/логов, настройка ИИ-помощника и валидации, интеграции с SSO/LDAP/Confluence, резервное копирование/экспорт данных и аналитика использования платформы.
Согласующим — раздел содержит вспомогательные материалы для согласующих, которые раскрывают специальные возможности Stormbpmn: workflow утверждения моделей с комментариями к элементам, история версий и уведомления, просмотр/анализ диаграмм BPMN/PlantUML без редактирования, шаринг по ссылке с правами только на чтение, встраивание в Wiki/Confluence и экспорт в PDF/SVG для финального утверждения.
Всем — раздел содержит вспомогательные материалы по функциям и возможностям Stormbpmn, которые используют все аудитории: согласование диаграмм, работа с внутренним пространством команды, экспорт и импорт диаграмм, использование шаблонов.

В левой панели навигации находятся конкретные сценарии работы с Stormbpmn. Например, статья «Работа с версионированием процессов» описывает сценарий версионирования диаграммы, которым обычно занимаются администраторы:

Или вот другой пример: статья «Согласование процесса» описывает механизм согласования диаграммы и находится сразу в нескольких категориях: Согласующие и Все.

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

Преемственность документации¶

Новая документация поначалу может показаться неудобной и непривычной, потому что она построена по‑другому, не так, как старая документация Stormbpmn. Чтобы пользователям, которые уже давно используют документацию Stormbpmn, было легче сориентироваться в новой документации, мы мигрировали теги из старой документации и встроили их в поиск.

Теперь можно просто ввести нужный тег в поиск и получить список всех статей, соответствующих тегу.

Важные уведомления в начале статей и разделов¶

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

Уведомление об ограничениях тарифного плана предупреждает о том, что описанная в статье функциональность Stormbpmn доступна только для определенного тарифного плана, например, для тарифного плана Team или Business, или для обоих тарифных планов.

Уведомление об ограничениях роли предупреждает о том, что описанная в статье функциональность Stormbpmn доступна только для определенной роли или ролей, например, для роли Администратор.

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