Продолжаем изучать различные примеры баз знаний, выделяя эффективные решения и подмечая ошибки. Следующая справочная система интересна для обзора не только содержанием большого количества элементов, улучшающих наглядность и облегчающих навигацию, но также примерами того, что может испортить онлайн документацию: неудачная верстка, не адаптивный текст, ограниченные возможности навигации и поиска.
Мы говорим о справочной системе Comindware — платформе для управления бизнес-процессами. Неискушенному пользователю она может показаться удобной и информативной, но на фоне более удачных примеров, ее слабые стороны становятся слишком заметными. Авторам есть над чем поработать, и убедиться в этом можно по ссылке:
Как и в предыдущем материале, в этом обзоре мы использовали чек-лист из пяти критериев:
- Структура.
- Навигация.
- Содержание.
- Оформление.
- Обратная связь и обновления.
Соответствие справочной системы стандартам мы не затрагиваем, поскольку этот аспект носит рекомендательный характер, а сами стандарты могут быть как внешними, так и внутренними — принятыми в самой компании. Мы же акцентируем внимание на пользовательском интерфейсе и содержании.
Структура пользовательской документации
Удобная структура пользовательской документации — это ясная визуальная иерархия и продуманная группировка разделов. Она позволяет находить ответы даже без использования поисковой строки и формирует целостное понимание работы системы в целом. Логичное расположение разделов помогает читателю не пропустить важные шаги и выполнять операции в правильном порядке. Как со структурированием тем справились разработчики документации Comindware?
Каких-то серьезных замечаний к структуре нет, небольшие недочеты всплывают при более тщательном изучении руководства. Основная претензия сводится к внешнему виду меню: названия разделов сильно сжаты, читать их неудобно, но речь об этом пойдет далее в блоке "Оформление".
На скриншоте выше заметно, что информация, представленная в родительском и в дочернем разделах, частично пересекается. Что это? Разные публикации с одинаковыми заголовками или один и тот же материал? Возникает путаница.
Некоторые разделы имеют слишком большую вложенность. Например:
Руководства → Руководство пользователя → Администрирование → Подключения и пути передачи данных → Системные подключения → Уведомления → Общие уведомления. Настройка
Рекомендуется использовать не более пяти уровней.
Навигация пользовательской документации
Эффективная навигация способствует снижению когнитивной нагрузки, облегчая тем самым восприятие комплексной информации. Наличие четко определенных средств для перемещения между разделами (оглавление, поиск, хлебные крошки) обеспечивает быстрое нахождение нужного контента без траты времени на нерелевантный текст. Ссылки "вперед/назад", создающие последовательное изложение, способствуют целостному восприятию инструкций. Давайте узнаем, есть ли повод для исправления ошибок у создателей справочной системы на этот раз?
Поиск
Поисковая строка Comindware решает главную задачу пользовательской документации: находить ответы.
Текст при этом не отформатирован.
Часто для облегчения поиска в документацию программных средств внедряют специальные фильтры. Разработчики данной документации не остались в стороне и решили добавить расширенные настройки:
Хлебные крошки
Хлебные крошки способствуют лучшему пониманию контекста, однако этого полезного элемента навигации здесь нет. Понять, что путь к текущему разделу выглядит так: Версия 5.0. Текущая рекомендованная → Руководства → Руководство пользователя → Описание Comindware Platform 5 — можно лишь проследив всю цепочку в меню.
Меню
Меню выглядит стандартно и представляет собой дерево разделов. Текущий пункт выделяется цветом и жирным шрифтом. По умолчанию меню свернуто, возможно, стоит его развернуть хотя бы до разделов второго уровня, чтобы сразу можно было видеть главные пункты структуры документации пользователя.
Внутренние ссылки
В контенте много перекрестных ссылок. На скриншоте ниже представлен пример внутренней перелинковки:
А в конце разделов располагается блок со ссылками на статьи, связанные с освещенной темой:
Теги есть, но увидеть их все сразу не представляется возможным — облако тегов не предусмотрено.
Содержание пользовательской документации
Провести глубокий анализ содержания с оценкой актуальности информации можно только поработав с платформой некоторое время. Только в этом случае можно говорить о таких вещах, как, например, корректность описания зависимостей, когда выполнение одного шага зависит от успешного завершения предыдущего, о группировке связанных действий, когда в одном разделе собраны связанные между собой инструкции и т.д.
Все же некоторые выводы можно сделать и при беглом знакомстве с документацией.
Полнота информации
Полнота информации базы знаний онлайн платформы — это ключевой критерий её качества, который напрямую влияет на эффективность взаимодействия пользователя с продуктом. Она должна содержать не только исчерпывающее описание функциональности с примерами и сценариями использования, но и различные предупреждения, инструкции для устранения ошибок, работу с API, совместимость и многое другое.
Авторы поработали над составом документации для своей информационной системы: осветили максимально широкий круг вопросов и затронули круг тем, который чаще всего требует объяснения при работе с подобным сервисом, например, добавили раздел с примерами решения проблем:
Наглядность
Пользовательская документация Comindware отличается наглядностью, разнообразием приемов, с помощью которых авторы демонстрируют возможности и особенности платформы.
Анимация работы с формами:
"Нажмите кнопку «Выбор разделов навигации» . Отобразится меню «Разделы навигации»."
"Установите или снимите флажки, чтобы отобразить или скрыть разделы."
В этом примере непонятно, как открыть форму с картой:
Также не хватает изображений и в этой инструкции:
Это распространенная ошибка: авторы не считают нужным давать определения вещам, которые кажутся им очевидными.
Оформление пользовательской документации
Внешний вид справочной системы — это инструмент, который превращает сырую информацию в удобный и эстетичный источник знаний, которым приятно пользоваться. Для достижения максимальной эффективности этого инструмента, в оформлении онлайн документации используется целый ряд элементов. Это и типографика, и адаптивность, и цветовая схема.
Итак, первое, что бросается в глаза при знакомстве с пользовательской документацией Comindware — верстка. Места, отведенного под контент, мало, но и его "съедает" нескрываемое меню слева. Вот так в боковом меню отображаются длинные заголовки:
Заголовки не адаптируются под маленькие размеры экрана:
С увеличенной шириной меню выглядело бы гораздо лучше:
Следующий раздел встречает нас текстом, который поленились отформатировать:
А вот так можно исправить этот недочет:
В блоке со связанными статьями у ссылок разный шрифт:
Обратная связь и обновления
Обратная связь помогает выявить неточности и недочеты, двусмысленные формулировки, битые ссылки. Если компания прислушивается к мнению пользователей и вносит изменения, это укрепляет доверие клиентов. Обратная связь и обновления превращают документацию из статичного "пособия" в динамичный ресурс, который растет вместе с продуктом и аудиторией. Без этого даже изначально качественный контент быстро теряет ценность.
В данном случае связь авторов с пользователями сводится к оценке полезности статей, которая, впрочем, имеется не на всех страницах. Например, раздел "Карточки. Использование" оценить нельзя, при этом мы видим сообщение о том, что статья была полезна для двух человек. Это вызывает недоверие пользователя.
Что касается информации об обновлениях, в руководстве представлены подробные сведения о разных версиях продукта с пометками о статусе версий: рекомендованная, поддерживаемая, устарелая.
Итог
Справочная система оставляет смешанные впечатления: есть как сильные стороны, так и явные недоработки, например, отсутствие глоссария.
В основном, замечания адресованы к оформлению. Эти недочеты — следствие неудачного дизайна. Слишком узкая ширина контента не позволяет, в частности, увеличить меню или уместить текст:
Пользователи читают инструкции по-разному: кто-то сразу ищет конкретный раздел, а кто-то читает ее последовательно, но возможности переходить на предыдущую и следующую страницу в базе знаний Comindware нет. Нужно дать читателю свободу выбора: двигаться шаг за шагом или перепрыгивать между темами, сохраняя контекст.
Не способствует эффективности справочной системы отсутствие видео и ограниченные возможности навигации.
Сложно сказать, с помощью какого инструмента создавалось эта пользовательское руководство, зато можно с уверенностью заключить, что разрабатывали его не в программе Dr.Explain.
Dr.Explain позволяет избежать типичных ошибок, что крайне полезно, если вы взялись за создание справочной системы в первый раз. Автоматизированные процессы помогут ускорить процесс написания и облегчат экспорт вашего документа в распространенные форматы, не требуя от вас специальных знаний.
Вы можете скачать бесплатно программу для создания пользовательской документации Dr.Explain и приступить к разработке прямо сейчас.
Надеемся, что статья оказалась полезной, и вы используете полученную информацию при написании своей справочной системы.