Разработка пользовательской документации для ERP-систем: особенности, инструменты, специальные приемы
Журавлев ДенисЧто такое ERP-система?
ERP-система (Enterprise Resource Planning) — это программное обеспечение, предназначенное для объединения всей информации, обеспечивающей эффективное управление компанией. Оно охватывает производство, бухгалтерский учет, склады, транспортировку, кадры, работу с клиентами и другие важные сферы бизнеса.
Автоматизация процессов облегчает работу сотрудникам, а компания в целом получает существенный прирост производительности.
В чем выгоды разработки руководства пользователя для ERP?
Написание подробной и понятной пользовательской документации к ERP-системе — это не только страховка от ошибок. Без внятной справочной документации пользователи будут работать не с ERP-системой, а общаться со службой поддержки. Сложному продукту нужна база знаний, которая не только отвечает на все вопросы по применению, но и наглядно объясняет преимущества ее использования. Когда под рукой есть наглядное пособие с подробными инструкциями и детальными объяснениями сложных схем, отношение сотрудников к ERP-системе начинает меняться. Инструкции рассказывают, как ERP на берет на себя выполнение рутинных задач, на которые они тратили кучу времени, как она контролирует ход выполнения операций. Пользователи начинают осознавать ценность и эффективность разработки, а выгода от ее применения становится очевидной.
Единая справочная инфраструктура для ERP помогает самообучению всего коллектива. Новички быстрее адаптируются к новым бизнес-процессам, а опытные сотрудники углубляют знания. Унифицированную информационную систему легко осваивать, развивать и обновлять.
Выбирая из нескольких решений, предприятие скорее предпочтет ту ERP-систему, у которой есть подробная и понятная пользовательская документация. Однако качественная справка должна быть понятна не только специалистам определенной отрасли, а в первую очередь рядовым пользователям, то есть тем, у кого возникают вопросы относительно функционала каждый день. Разработать документ, ориентированный на широкий круг читателей, задача не из легких.
В чем сложности написания пользовательской документации ERP для систем управления компаниями?
Процесс создания базы знаний для ERP отличается трудоемкостью из-за целого ряда особенностей самой системы управления компаниями.
Многофункциональность
Спектр возможностей современных ERP-систем настолько широк, что охватывает практически все аспекты бизнеса: от закупок до продаж, от производства до финансов. Для создания качественной справочной базы к такой массивной конструкции необходимо обладать хотя бы минимальными знаниями в различных сферах бизнеса: логистике, финансах, производстве и т.д.
Модульность
При описании инструментов затруднения вызывает большое количество модулей, интегрированных в систему. Она как огромный механизм, состоящий из множества элементов, где каждый из них — это отдельная шестеренка. Чтобы описать работу всего механизма, нужно не только знать, как вращается определенная деталь, но и понять, как они взаимодействуют друг с другом. Требуется хотя бы базовый опыт работы с системой, чтобы корректно объяснить работу всей конструкции в целом и каждого модуля в частности.
Список некоторых модулей, составляющих ERP-систему и демонстрирующий сложность систем управления предприятием:
Разнородность аудитории
Аудитория ERP-системы охватывает специалистов с различным опытом и уровнем технической подготовки. От программиста, разбирающегося в тонкостях кода, до менеджера, работающего с конечным результатом. Задача автора справки — уметь объяснять сложные вещи простым и понятным языком, независимо от уровня технической грамотности пользователей.
Обновления
ERP-системы развиваются и дорабатываются годами, и даже десятилетиями, и нужно быть в курсе всех изменений. Для этого технический писатель должен работать в тесной связке с разработчиками и получать актуальную информацию о новых функциях, исправлениях ошибок и других обновлениях. Это позволит избежать неточностей. Писатель и сам должен уметь использовать инструменты версионирования, чтобы обновление руководства пользователя проходило без ошибок.
О том как поддерживать актуальность документации и почему это критически важно, мы рассказали в этом материале.
Что важно учесть при разработке пользовательской документации для систем управления копаниями?
При разработке документации для ERP-систем авторы сталкиваются со специфическими проблемами, которые отличают этот процесс от написания справочной информации для других систем документооборота. Давайте рассмотрим ключевые моменты, которые предстоит учесть при разработке техническому писателю.
Масштаб ERP-системы
ERP состоит из множества функциональных областей и включает сотни или даже тысячи отдельных элементов. Чтобы пользователь мог легко в ней ориентироваться, нужно уделить много времени созданию четкой и логичной структуры документации. Это похоже на составление путеводителя по огромному лабиринту — без надежной карты легко заблудиться.
Пример организации системы управления компанией, демонстрирующий сложность взаимосвязей:
Интеграция различных модулей
Объединение различных бизнес-процессов и информационных потоков в одну систему — ключевая особенность ERP. Объяснить, как именно между этими модулями передаются данные, каким правилам они подчиняются, — задача сложная. Пользовательская документация должна раскрыть эту взаимосвязь, чтобы пользователь понимал, как его действия в одном модуле отражаются на работе других.
Возможно, имеет смысл разбить на соответствующие модули и саму пользовательскую справку. Небольшие и легко усваиваемые блоки информации помогут не потеряться в массиве инструкций и облегчат понимание материала. Рекомендуется использовать простые предложения без сложной терминологии и придерживаться нейтрального профессионального тона. Выявить наиболее удобное для навигации расположение разделов документации можно в ходе А/Б тестирования.
Специфика бизнеса
ERP адаптируют под потребности определенного предприятия, поэтому создание пользовательской документации для нее — это всегда индивидуальный подход. Предыдущий опыт может быть полезен, но нельзя просто скопировать готовые шаблоны, так как они не учитывают нюансы бизнеса нового клиента. На содержание и формат документа могут существенно влиять специфика производственного процесса, учет региональных особенностей, налоговые и юридические требования.
Специальные приемы создания пользовательской документации для ERP-систем
Целью создания справочной базы является формирование единого источника информации, в котором пользователь может найти ответы на все вопросы. Но поиск ответов должен быть удобным, а изложение материала доходчивым. Для этого следует придерживаться некоторых правил написания, а также применять простые, но эффективные приемы оформления.
Использование реальных примеров работы с инструментами
Включите в документацию примеры и реальные сценарии использования. Люди лучше воспринимают и запоминают информацию через конкретные ситуации, близкие к их повседневной работе. Сделайте документацию более наглядной, сопроводив контент медиа-файлами. Всевозможные блок-схемы, графики, фото и видео важны в любой инструкции, но в данном случае нужно не просто добавить скриншоты интерфейса с подписями, а связать это с реальными кейсами, чтобы пользователь на живом примере понял суть того или иного инструмента и увидел, как именно он поможет ему выполнить задачу. Для того, чтобы получить представление о том, как правильно писать документацию, можно посмотреть на примеры оформления у известных платформ.
В примере ниже сервис Stripe использует интерактивные окна, в которых можно передвигать элементы блок-схемы. Окно можно открыть в отдельной вкладке браузера и рассмотреть его во всех подробностях:
Обратная связь с пользователями
Предусмотрите возможность получения обратной связи от пользователей. Это поможет выявить слабые места в документации и улучшить ее. Часто на страницах авторы размещают кнопки для оценки полезности предоставленной информации.
Например, платформа Twilio выделяет под обратную связь целый баннер со всеми нужными ссылками:
В свою очередь, автор и сам должен работать в постоянном контакте с разработчиками ERP-системы, чтобы знать об изменениях в программе и своевременно отражать это в тексте. Устаревание и несоответствие данных реальному функционалу в перспективе ведет к большим проблемам.
Тестирование пользовательской документации
Этот пункт тесно связан с предыдущим. Тестирование документации пользователями позволяет выявить недочеты и ошибки, которые могут остаться незамеченными при традиционном редактировании. Например, можно предложить выполнить определенные задачи, используя только документацию и понаблюдать, насколько легко выполняются задания.
В опросах и анкетах можно дать возможность оценить удобство, понятность, полноту и высказаться о других аспектах базы знаний. В групповых обсуждениях пользователи могут делиться впечатлениями и предлагать свои идеи по улучшению.
Опыт создания пользовательской документации для ERP-систем на примере реальных проектов
Послушаем специалистов, которые имеют удачный опыт создания пользовательской документации для своих продуктов.
Системы управления бизнес-процессами ELMA
Компания ELMA занимается разработкой и внедрением системы управления бизнес-процессами ELMA BPM с 2006 года. Она создает прикладные приложения для электронного документооборота, управления проектами, продажами и KPI, реализованными на ее основе.
Ольга Михеева, руководитель отдела документирования компании ELMA, рассказывает о том, как программа для написания пользовательской документации Dr.Explain помогает техническим писателям и техподдержке, когда программных продуктов много, они часто обновляются, а справка ведется на четырех языках.
— Раньше для создания справки мы использовали WinCHM, но при работе с ним были некоторые неудобства. Самый главный минус — подготовка справки к публикации занимала очень много времени. Например, чтобы качественно оформить материалы, приходилось отдельно верстать каждую страницу справки в HTML.
В ходе долгого тестирования было принято решение выбрать решение от компании Indigo Byte Systems.
— Как выяснилось в ходе тестирования Dr.Explain, во-первых, дизайн справки легко кастомизируется. Мы смогли быстро воплотить в жизнь нужный нам дизайн. Во-вторых, понравилась возможность установки статусов для разделов. Это очень удобно, особенно в нашем случае, когда приходится поддерживать справку на нескольких языках. Скорость изменения, добавления и компиляции справки стали решающими факторами. Все сотрудники отдела в один голос сказали, что это очень быстро и гораздо удобнее, чем было раньше.
В результате были решены две главные задачи: быстрая публикация пользовательской документации по продуктам ELMA и снижение нагрузки на техподдержку.
Комплексные решения для бизнес-процессов CRM Expert
Наталья Обухова, бизнес-аналитик компании CRM Expert, рассказывает, какие проблемы IT-компания испытывала без полноценной пользовательской документации.
— Компания CRM Expert 12 лет занимается разработкой и внедрением программного обеспечения на собственной платформе Global View, для управления проектами и производственного планирования. Исторически сложилось, что все наши проекты укладывались в рамки одного департамента заказчика, и все пользователи "говорили на одном языке". Но компания одного из заказчиков быстро выросла и оказалась территориально распределена по трем городам. Выделилось три департамента и 26 отделов. И, о ужас, — оказалось, "они говорят на разных языках", т.е. они разными терминами описывают одинаковые производственные процессы.
Пользователи стали засыпать IT-отдел вопросами об изменениях в системе управления предприятием, а времени на ответы у сотрудников не было.
— Мы решили, что нам нужно совершенствовать информационную поддержку пользователей. Система должна автоматически информировать пользователя об изменениях и предлагать простой переход к более подробному описанию.
Для выбора из двух подходящих инструментов был запущен пилотный проект, и в ходе тестирования определился лидер.
— Сначала фаворитом выбора была другая система, но решающим фактором в пользу Dr.Explain стал возглас человека, выполняющего основную часть работы по переносу текста: "Вжух! И вся структура документа перенеслась в файл справки". Функция импорта в Dr.Explain отработала на ура и сэкономила кучу времени. Также очень подкупил дизайн веб-справки, который формируется Dr.Explain, и красивый способ организации подписей к окнам нашей системы. В Dr.Explain это называется "Аннотирование экрана". Возможность установки статуса раздела тоже оказалась очень удобной, особенно, после импорта старой версии справки легко отслеживать, какие разделы требуют обновления, в каких еще ведутся изменения, а какие уже обновлены и актуальны.
После изменения подхода к работе с пользовательской документацией клиенты начали читать справку и перестали задавать большинство вопросов.
Программное обеспечения для автобизнеса ТрэйдСофт
О том, как компания смогла в короткий срок перевести документацию в новый формат, рассказывает Елена Парахина, руководитель отдела документации, компании ТрэйдСофт.
— Наши проекты довольно крупные функционально. Документация является основным источником информации как для клиентов, так и для сотрудников компании. Комбинировали все, что только можно: статьи на сайте, обучающее видео на Youtube-канале, а также персональные консультации по скайпу, ответы на вопросы на форуме и по электронной почте. Ранее документация велась в MS Word, что имело ряд плюсов, но несло больше проблем. Количество страниц неизбежно росло, как и количество графических материалов. Также данный формат накладывал ограничения на используемые изображения и визуальное оформление, ограничивал доступ к документации из продукта.
Было решено сравнить продукты упрощенной верстки, в основном используемые разработчиками, а также специализированный софт для ведения документации и заметок.
Основными критериями выбора нового продукта для ведения документации были:
- легкая конвертация из формата DOC/DOCX в новый;
- сохранение и расширение возможностей визуального оформления документа;
- возможность получить на выходе легкий способ онлайн-доступа к документации.
Среди важных пунктов в списке требований также были стоимость продукта/рабочего места, возможность расширения лицензии, развитие продукта и обновления, доступ к технической поддержке. Dr.Explain подошел почти по всем критериям.
— В короткие сроки мы смогли перевести документацию в новый формат, применить новые принципы оформления для упрощения восприятия информации. Благодаря новому инструменту мы сможем улучшить нашу документацию: добавить анимированные GIF-изображения, встроить обучающие видео с Youtube и других видео-платформ, расширить описание разделов для "пытливых" клиентов и прочее.
Dr.Explain — инструмент, ускоряющий создание пользовательской документации для EPR-систем
Dr.Explain — это десктопная программа для автоматизированного создания пользовательских документаций. Давайте рассмотрим ее особенности.
Автоматическое создание аннотаций
Захват экрана и автоматическое создание аннотаций к скриншотам качественно выделяют программу на фоне похожих продуктов. Программа создает нумерованные аннотации ко всем элементам интерфейса: панелям инструментов, меню, кнопкам и т.д. Вам остается только добавить описания. Можно настраивать внешний вид как самих скриншотов, так и выносок и надписей.
Дизайнер аннотаций
Удобный редактор аннотаций предлагает широкий набор функций для работы с различными типами элементов, включая нумерованные списки и выноски.
Готовые шаблоны документаций
Хорошее начало — половина дела. Выбор Dr.Explain — хорошее начало: применение стандартных шаблонов для различных типов документов значительно ускоряет работу и унифицирует оформление. Разработчики предлагают на выбор четыре самых распространенных типа документации:
- Корпоративная база знаний;
- Руководство пользователя Web-сервиса;
- Руководство пользователя по ГОСТ 34;
- Руководство пользователя ПО.
В каждом шаблоне заготовлена структура разделов и есть базовое оформление, подходящее для большинства случаев.
Вставка перекрестных ссылок
В Dr.Explain можно добавлять перекрестные ссылки пронумерованным изображениям и таблицам. Это помогает быстро находить нужную информацию и помогает лучше ориентироваться в документе.
Совместная работа
Распределенный коллектив авторов сможет работать над одной документацией при помощи облачного сервиса:
Dr.Explain создан отечественными разработчиками, поэтому длительная поддержка пользователей продукта гарантирована.
Заключение
Качественная пользовательская документация — это не просто набор инструкций, а ценный инструмент для повышения эффективности сотрудников и развития компании. Она помогает пользователям быстрее осваивать ERP-систему, снижает риски ошибок и служит хранилищем знаний организации.
Требования к пользовательской документации у такой сложной системы, как ERP строгие, поэтому для создания и поддержки справочной базы обычным текстовым редактором тут не обойтись. Необходимо использовать специализированные инструменты. Они автоматизируют рутинные задачи, значительно ускоряют процесс написания и имеют ряд других преимуществ, благодаря которым донести до читателя сложный материал становится проще.
Как мы уже заметили ранее, пользоваться одним и тем же шаблоном для создания справочной базы нельзя в виду индивидуальных особенностей каждого бизнеса, зато можно применять одну и ту же программу для создания пользовательской документации для предприятий в любой отрасли с самыми разными бизнес-процессами. К счастью для технического писателя, подходящие программы для этого есть.