Документация — это веб-страница с внутренними ссылками, на которой отображается вся техническая информация о процессе: карта процесса, матрица ответственности и зоны ответственности, метрики и показатели, контекстные переменные, события и задачи, переходы и сценарии. О том, как просматривать документацию по процессам, читайте в статье «Документирование процессов».
На рисунке представлен фрагмент документации.
Документацию следует отличать от регламента процесса. Подробнее об этом читайте в статье «Регламент процесса».
Формирование документации
Документацию можно сформировать для всех процессов из списка раздела Процессы, включая неопубликованные процессы и черновики текущих версий.
Пользователи смогут просматривать документацию в разделе Процессы — Документирование только по процессам, для которых включена опция Видимость в списке процессов. Подробнее о ней читайте в статье «Настройки процесса».
Чтобы запустить генерацию, на странице раздела Процессы справа от кнопки + Процесс нажмите Документация.
Выбор процессов
На этой вкладке выберите процессы, для которых хотите получить документацию.
Вы можете создать документацию для одного или нескольких процессов, а также для подпроцессов вместе с основными процессами.
— чтобы выбрать процесс, установите флажок. Чтобы выбрать все процессы в папке, установите этот флажок слева от её названия. Процессы и их подпроцессы связаны и выбираются вместе.
— при формировании документации создастся соответствующая папка. Если в папке выбран хотя бы один процесс или подпроцесс, родительская папка отмечается автоматически этим флажком.
Если флажок не установлен, документация процесса не сформируется.
Чтобы перейти к следующей вкладке с настройками, нажмите Далее.
Настройки экспорта
На этой вкладке выберите информацию, которую необходимо отразить в документации. Если на предыдущем шаге вы указали несколько процессов или подпроцессы, то проделайте это для каждого из них.
Чтобы документация сгенерировалась, нажмите Сформировать.
После того как документация сформируется, вы получите оповещение об этом. Папка с ней автоматически скачается и станет доступна из браузера. В папке с расширением .zip отобразятся следующие данные:
- файл index.html со ссылками на документацию по выбранным процессам;
- для каждого процесса папка с названием бизнес-процесса, которая содержит файл index.html с документацией и папку с сопутствующими файлами.
Содержание документации
Веб-страница содержит наименование процесса, дату формирования документации, содержание со ссылками на разделы и подразделы.
Если при настройке экспорта вы выбрали все элементы, то в документации отобразится следующая информация о процессе:
- графическая модель процесса;
- метрики и показатели;
- матрица ответственности;
- контекст;
- зоны ответственности и их параметры;
- события;
- оповещения;
- задачи;
- операции;
- шлюзы;
- переходы;
- сценарии.
Если в бизнес-процессе используется маршрут документа или операция с документом, появится раздел Документооборот.
Нашли опечатку? Выделите текст, нажмите ctrl + enter и оповестите нас