Разработка документации для систем автоматизации производственных и бизнеc-процессов
Журавлев ДенисСистемы автоматизации бизнес-процессов — это программные и программно-аппаратные решения, которые автоматизируют рутинные задачи, улучшают координацию между сотрудниками и отделами, а также контролируют выполнение задач.
Например, BPA-система (Business Process Automation — BPA) может помочь предприятию в обработке заказов, в создании отчетов, в управлении персоналом. Она также помогает контролировать процессы, повышает прозрачность операций и решает множество других задач.
Однако в виду сложности структуры самого предприятия, обучить сотрудников работе в системе BPA очень непросто, но жизненно необходимо.
Рассмотрим подробнее, какую выгоду приносит создание и поддержание актуальной пользовательской документации для таких программ.
Быстрая адаптация
Подробная справочная база, снабженная видео роликами, графиками, таблицами и изображениями, поможет разобраться в системе значительно быстрее без необходимости обращаться в техподдержку.
Когда у пользователя есть доступ к подробным инструкциям и руководствам, он может самостоятельно освоить основные функции системы без подготовительных курсов или обращения за помощью к коллегам. Это особенно важно в условиях высокой текучести кадров и быстрого роста компании, когда новые сотрудники должны включаться в работу максимально быстро.
Повышение удовлетворенности пользователей
Система автоматизации процессов без наглядных инструкций станет не подспорьем, а вызовом. Сотрудники будут вынуждены тратить время на изучение работы софта вместо выполнения своих задач. О росте эффективности их работы в таком случае говорить не приходится.
Стандартизация действий
Документация устанавливает единые стандарты выполнения задач внутри организации. Все сотрудники будут следовать одним и тем же процедурам, что приведет к согласованности действий и улучшению результатов. Это имеет большое значение в крупных компаниях с разветвленной структурой, где у разных подразделений могут быть свои подходы к выполнению одних и тех же операций.
Масштабирование бизнеса
При расширении бизнеса или внедрении новых функций в систему, актуальная документация позволит новым сотрудникам и партнерам быстро адаптироваться к изменениям. Это ускоряет интеграцию новых подразделений и снижает риски, связанные с недостатком знаний о системе.
Накопление знаний
Документация служит надежным хранилищем знаний о системе управления предприятием — важный аспект для поддержания устойчивости и эффективности. Сохранение данных о внутренних процессах компании полезно для анализа трендов, выявления паттернов и принятия обоснованных решений. Кроме того, многие отрасли и юрисдикции требуют сохранения данных в течение определенного периода времени для аудита и соответствия нормативным требованиям.
Непрерывность рабочих процессов
При обновлении системы или смене персонала документация сохраняет преемственность. К примеру, в случае чрезвычайных ситуаций или смены ключевых сотрудников справочная база предоставит необходимый массив знаний для продолжения работы.
Быстрая навигация
В хорошо структурированном документе даже неопытный сотрудник сможет быстро найти нужную информацию. Продуманная логичная структура справочника играет ключевую роль в обучении.
Может показаться, что качественная пользовательская документация не является критически важным фактором успеха проекта автоматизации: разработчик позаботился об интуитивно понятном интерфейсе, а большинство сотрудников имеют высокий уровень технической грамотности и работают в с различным софтом уже несколько лет. Многие предприятия обходятся небольшим справочным документом, написанным в обычном текстовом редакторе, надеясь, что такой справочной базы для быстрого овладения BPA-системой достаточно.
Однако это далеко не так.
Сложности при написании пользовательской документации для систем автоматизации производственных и бизнеc-процессов
Охватить весь функционал BPA-системы и подробно его описать — задача масштабная и трудоемкая, но сложность представляет не только внушительный список функций программы. Рассмотрим моменты, на которые стоит обратить внимание автору справки.
Множество взаимосвязанных компонентов
Сложность описания работы компонентов заключается не столько в их количестве, сколько в том, как наглядно объяснить их взаимосвязанность. Читатель должен увидеть цельную картину системы управления компанией и понять, как отдельный винтик механизма помогает достигать общую цель. Нужно донести до читателя суть: составные детали BPA-системы — это а не разрозненные части, зависимые друг от друга компоненты.
Без использования схем, медиа файлов распутать клубок и передать принципы взаимодействия элементов не получится. Автор и сам должен уметь образно мыслить и очень хорошо понимать внутреннее устройство таких систем.
Сложная терминология
Если опытный сотрудник хорошо ориентируется в терминологии, то новичок быстро запутается в непривычных названиях и формулировках. Технический писатель должен найти баланс, при котором текст понятен не только эксперту, но и неопытному сотруднику. При этом инструкция должна быть написана так, чтобы это не выглядело постоянным разжевыванием очевидных вещей, и была написана по принципу "от простого к сложному".
Регулярные обновления
Постоянное обновление — особенность любого софта. Это налагает дополнительные обязанности на автора пользовательской справки, которому приходится отслеживать изменения и поддерживать актуальность материала. Так же, как и разработчику, ему нужно владеть системами версионирования текстов. К счастью, специализированные программы для написания пользовательских справок для BPM-систем (Business Process Management — управление бизнес-процессами) имеют встроенные инструменты для этого, что значительно облегчает работу. Обычные текстовые редакторы, такие как Word, для этих целей не годятся.
Рекомендации при создании пользовательской документации для систем автоматизации производственных и бизнеc-процессов
Актуальность
Документация должна регулярно обновляться, чтобы отражать изменения в системе. Это очевидно, но многие авторы не уделяют этому должного внимания. О том, что будет, если не заниматься поддержкой и актуализацией данных, мы писали в этой статье "Применение теории разбитых окон в написании документации".
Доступность
Документация должна быть доступна для всех пользователей. Писать текст, который одинаково понятен сотрудникам разных подразделений сложно, но на помощь приходят упомянутые выше средства визуализации: видео ролики, таблицы, схемы. Здесь мы снова возвращаемся к тому, что для создания таких наглядных инструкций следует пользоваться специализированным ПО для написания справочников пользователя.
Ясность и простота
Информацию нужно излагать понятным и доступным языком, без излишней технической терминологии. Эти рекомендации относятся к любым текстам, но в контексте работы организации они напрямую влияют на показатели, имеющие численное выражение.
Структурированность
Документация должна быть хорошо структурирована, логична и иметь удобную систему навигации. Для создания наиболее удобного расположения разделов, пунктов меню можно воспользоваться А/Б тестированием.
Иллюстрации
Использование схем, диаграмм и других визуальных элементов облегчает понимание сложных процессов. Имеет смысл оформить медиа материалы в едином стиле, чтобы не превратить документ в цветастую мешанину. Привычный текстовый редактор Word (и подобные ему программы) предлагает крайне ограниченный набор инструментов для кастомизации.
Примеры пользовательской документации для систем автоматизации производственных и бизнеc-процессов
Учитесь на чужих примерах. Много интересного при создании пользовательских инструкций для систем автоматизации бизнес-процессов можно заимствовать у известных компаний. Рассмотрим некоторые из них.
Cflow
В пользовательской документации облачного сервиса Cflow все стандартно, интерес для нашей темы представляет лишь глоссарий, который выведен в отдельный раздел. На его странице в алфавитном порядке расположены термины с кратким описанием.
Если вы еще не знакомы с облачными сервисами (SaaS) и чем они отличаются от десктопных приложений, почитайте об этом в нашей статье.
Bizagi
В пользовательской документации сервиса Bizagi пошаговые инструкции сопровождаются соответствующим изображением, которое упрощает усвоение информации. Кроме того, каждый шаг имеет ссылку на соответствующий раздел справочной базы.
Также на странице имеется кнопка “In this article“ для удобства навигации по странице:
Разработчики объясняют сложные вещи большим количеством изображений:
IBM Cloud Paks
У сервиса IBM Cloud Paks есть возможность работы с командной строкой, и документация очень хорошо это демонстрирует: одним нажатием кнопки можно копировать кусок кода без необходимости печатать его вручную. В правом верхнем углу есть кнопка переключения на темную тему для снижения нагрузки на глаза. Слева есть опция "Show full table of content" и переключение между документациями для разных версий программы.
Process Maker
Для кого-то оформление документации Process Maker может показаться избыточным: здесь и рейтинг статьи, и навигационное меню справа, и шрифты разной толщины, разных семейств, разного размера, и горизонтальные разделители контента:
Возможно, к такому оформлению пришли в результате работы с отзывами, и оно имеет смысл. Насколько полезен тот или иной дизайн для пользователей можно выяснить с помощью А/Б тестирования.
Comind Ware
Справочная база Low-code-платформы Comind Ware встречает пользователя небольшим меню, из которого можно отправиться в соответствующий раздел. Разбиение документации на такие модули значительно упрощает ориентирование в справке.
Camunda
Разработчики Camunda сделали акцент на удобстве навигации и добавили соответствующие шорткаты прямо на страницу документации:
В конце страницы добавлена ссылка Edit this page, ведущая на Github, чтобы пользователи могли поучаствовать в создании документации:
Nintex Automation Cloud
Nintex Automation Cloud используют много аннотированных скриншотов интерфейса:
Kisflow
Платформа Kisflow добавила в свою документацию короткие видео:
Dr.Explain — инструмент, ускоряющий создание пользовательской документации для BPA-систем
Мы уже упоминали о том, что профессиональную пользовательскую справочную базу для BPA-систем нужно писать в специальном ПО. Одним из них является программное обеспечение Dr.Explain, которое ускоряет создание любых справочных руководств. С его помощью вы можете работать над проектами любой сложности и экспортировать их в самые популярные форматы. Приведем некоторые возможности программы.
Готовые шаблоны документаций с заранее организованной структурой>
После установки Dr.Explain вы можете выбрать один из четырех типов проектов и начать добавлять контент в заранее подготовленные разделы.
Стандартные шаблоны текстовых блоков
Набор стандартных шаблонов текстовых блоков расширяет возможности визуального оформления, стилизации разных типов контента:
Простой экспорт документации в HTML, PDF, Word, CHM
Написав справочное руководство один раз, вы экспортируете его в любой из распространенных форматов. При экспорте можно настроить вывод определенных частей контента. Допустим, вам нужно получить документ, содержащий объяснение работы с командной строкой для одной группы пользователей, и версию документа без объяснения работы командной строки для другой категории пользователей. Указав в настройках экспорта параметры, вы получите разные версии одного проекта.
Работа распределенной группы авторов
Возможность удаленной работы над одним проектом сразу нескольких авторов становится все более востребованной. В Dr.Explain это реализовано при помощи сервиса TiWri.
Удобная навигация в справочной документации любого масштаба
Неудобная навигация — это распространенная проблема пользовательских справок, особенно если они написаны в Word и тому подобных текстовых редакторах. Они не предназначены для сложных проектов, поэтому пользователи в них теряются, и процесс обучения затягивается. В специализированных инструментах для написания справочной документации наподобие Dr.Explain ориентироваться легко.
Например, Dr.Explain создает индексы ключевых слов. Фраза или слово прикрепляются к определенным страницам файла помощи. Индексированный список поможет быстро находить нужную информацию.
Dr.Explain — это программа, созданная российскими разработчиками, поэтому прекращение поддержки вследствие изменения внешней политической обстановки ей не грозит.
Заключение
Системы BPA решают множество задач и ускоряют работу, но только при условии, что пользователям не приходится на каждый чих обращаться в техподдержку. Если автоматизация упрощает и повышает эффективность бизнес-процессов, то пользовательская документация для BPA-систем обеспечивает такое же упрощение и повышение эффективности работы сотрудников с этой системой. Это две взаимосвязанные вещи, которые обязательно должны дополнять друг друга.
Как говорится, хороший инструмент пол дела делает. В случае с созданием справки для BPA и систем управления бизнес-процессами это действительно так, потому что установив специализированную программу для справочной базы, такую как Dr.Explain, вы получаете готовую структуру будущего проекта. Пример функций, которыми может обладать софт для создания качественной справки, мы описали выше. Едва ли такими возможностями может похвастаться обычный текстовый редактор, а чем меньше инструментов для объяснения сложных и запутанных концепций, тем труднее донести информацию до читателя.
Подводя итог, можно сказать, что организовать проект, содержащий исчерпывающую информацию о работе сложной и многоуровневой конструкции, какой является BPA-система, не просто, но если знать, какой инструмент использовать, можно сильно упростить задачу.