Даже самая инновационная платформа для автоматизации бизнес-процессов (BPA) может утратить свою полезность, если сопроводительные материалы оказываются хаотичными, поверхностными или сложными для восприятия. Логичная организация контента, интерактивные примеры и подробные визуальные материалы способны превратить любой продукт в незаменимого помощника. В то же время запутанная навигация, перегруженные описания и проблемы с поиском ответов — это не просто мелкие недочёты, а серьёзные риски для репутации решения.
В фокусе этой статьи — справочная система BPA-платформы ProcessMaker, которая привлекла наше внимание богатой функциональностью. Как мы уже отмечали ранее, создание руководств для подобных систем сопряжено с рядом вызовов: от согласования терминологии до поддержки актуальности. Давайте посмотрим, как с этим справились специалисты сервиса ProcessMaker, и какие интересные находки можно у них заимствовать для использования в собственном проекте.
Актуальная на момент написания обзора версия справочной базы ProcessMaker находится здесь.
В обзоре мы использовали чек-лист из пяти критериев:
- Структура.
- Навигация.
- Содержание.
- Оформление.
- Обратная связь и обновления.
Возможно, некоторые решения авторов продиктованы результатами тестов, поэтому оценки и замечания стоит рассматривать как общие рекомендации при разработке справочных систем.
Структура пользовательской документации
Логичность структуры пользовательской документации — основа её эффективности. Она определяет, насколько легко пользователи ориентируются в контенте, находят ответы и понимают взаимосвязь между различными темами.
Руководство пользователя ProcessMaker разделено на разделы, среди которых Participant, Designer, Administrator соответствуют ролям, принятым в сервисе. Таким образом, пользователь видит информацию, актуальную его уровню доступа. Этот подход повышает удобство чтения и облегчает усвоение инструкций.
Связанные темы сгруппированы в подразделы (например, "Administrator → User Settings → User Signals Settings, User Property Settings"), при этом нет излишней вложенности, которая затрудняла бы работу с системой. Рекомендуется использовать не более 3-5 уровней.
Навигация пользовательской документации
Даже самые подробные инструкции не способствуют пониманию и усвоению материала, если в них легко заблудиться, а ответ на вопрос невозможно найти. В данном случае структура логична, а навигация предлагает пользователю все необходимое для ориентирования в контенте.
Поиск
- Поисковая строка с предикативным вводом, подсветкой запроса и настройками выдает релевантные результаты.
- В результатах отображаются заголовки разделов и контекстные фрагменты текста.
При появлении формы поиска, поле ввода находится в фокусе, поэтому пользователю не приходится его активировать — можно сразу же набирать текст запроса. Однако функциональность формы может показаться избыточной, и неподготовленному пользователю придется потратить время на ее изучение:
Для ускорения поиска предусмотрены шорткаты:
Хлебные крошки
Хлебные крошки визуализируют контекст, что особенно важно для сложных продуктов с многоуровневой документацией. В результате пользователь видит весь путь к текущей странице, понимает в любой момент времени чтения, в какой части базы знаний он находится. Все элементы крошек Process Maker, кроме текущей страницы, являются ссылками:
Меню
Главные разделы и разделы второго уровня в левом древовидном меню выделены жирным (например, "Release notes", "Participant", "Designer", "Administrator", "Hints"). Раздел, в котором находится пользователь, помечается маркером и цветом. Меню справа содержит список затронутых в текущем разделе тем, позволяет быстро переместиться к ним и начать изучение.
Внутренние ссылки
Внутренняя перелинковка помогает получить цельное представление о связанных темах и быстро перемещаться между ними:
Стоит отметить наличие кнопки "Наверх", которая встречается в справочных системах нечасто:
В конце статьи размещены ссылки на предыдущий и на следующий раздел с соответствующими заголовками, а также ссылка на похожие материалы:
Содержание пользовательской документации
Контент базы знаний должен быть полным, наглядным, актуальным, точным. Поддерживать каждый из этих параметров сложно, поэтому в ходе разработки полезно посмотреть, как с этим справляются похожие или конкурирующие платформы.
Полнота информации
Документация Process Maker покрывает ключевые функции продукта: есть разделы по установке, проектированию процессов, интеграциям, API, администрированию. Каждый раздел предваряется приблизительным временем на его прочтение. В некоторых разделах имеются цветные обозначения: в каком из трех планов имеется описываемая функциональность, чтобы пользователь не тратил время на прочтение неактуальной для него информации:
Для примеров выделен целый раздел "Examples", который для удобства чтения разбит на соответствующие подразделы.
В разделе "Hints" собраны подсказки, которые поделены на три категории в зависимости от уровня подготовки пользователя:
Наглядность
В справочной системе очень много скриншотов. Приводятся примеры и сценарии для объяснения работы инструментов платформы, используется видео:
Присутствуют примеры кода, но чувствуется недостаток видео инструкций, учитывая сложность системы, их могло быть больше.
Разные типы текстовых блоков выделены соответствующим цветом:
Активно используются текстовые блоки с возможностью свернуть контент, оставив на странице только нужное:
Актуальность и точность информации оценить не так просто, однако при беглом взгляде создается впечатление, что авторы охватили все возможности сервиса, а обновление, датированное весной 2025 года, свидетельствует об актуальности.
Оформление пользовательской документации
Доступный язык, ясные и лаконичные объяснения — это пол дела. Немало времени нужно уделить оформлению. При этом есть опасность переусердствовать, и тогда визуальный шум превратит структурированную справочную систему в набор неуместных дизайнерских решений.
Изображения
Авторы разбавили статичные картинки анимациями с возможностью остановки воспроизведения:
Некоторым изображениям добавлена интерактивность:
Изображения кликабельны, их можно рассмотреть подробно в полном размере. Присутствуют всплывающие подсказки:
Левое и правое меню можно скрыть, предоставив больше места контенту:
Текст
- Шрифты достаточно крупные, контрастные.
- Нет "стен текста" — используются списки, таблицы, текстовые блоки.
Четкий контраст: цвет фона — "#FFF", цвет текста — "#18181B".
Справочная система адаптирована для использования на мобильных устройствах.
Есть возможность распечатать документ, обеспечив оффлайн-доступ:
Специальные обозначения
Специальные маркеры со всплывающими подсказками в меню указывают на статус раздела:
Обратная связь и обновления пользовательской документации
Справочная система не будет эффективной, если в ней нет возможности связаться с авторами и указать на неточности или недостаток информации. В данном случае разработчики добавили форму для отправки отзывов:
А также реализовали возможность оценки полезности разделов:
В истории версий пользователь может найти нужные сведения с подробными описаниями, текст отформатирован, понятен не только техническим специалистам:
Итог
Справочная система ProcessMaker производит очень хорошее впечатление:
- четкая структура;
- связанность контента;
- наглядные объяснения с элементами интерактивности;
- продуманная навигация;
- оффлайн доступ;
- обратная связь.
К замечаниям можно отнести отсутствие перевода на другие языки и глоссария. Возможно, темная тема оформления была бы не лишней.
Хорошая документация — это баланс между детализацией и простотой, которые превращают ее в конкурентное преимущество. Она не просто объясняет — она убеждает в высоком качестве программного обеспечения и демонстрирует простоту его освоения. Понятные шаги, актуальные примеры и логичная структура свидетельствуют о продуманности продукта до мелочей.
Dr.Explain — инструмент, который помогает создавать такие справочные системы. Он фокусируется на удобстве пользователя и помогает реализовать лучшие практики в создании справочных систем для авторов с любым опытом и уровнем подготовки.