Содержание статьи:
- Что такое пользовательская справка
- Целевая аудитория
- Структура пользовательской справки
- Разработка пользовательской справки: советы
- Точки входа в справку
- Наполнение справки
- Инструменты для создания пользовательской справки
Первое, с чем сталкивается пользователь, начиная работать с новой программой, устройством или сервисом, — это необходимость разобраться в функциях и возможностях. На помощь ему, в числе прочих способов обучения, приходит пользовательская документация.
Хорошо структурированная, написанная простым языком и содержащая нужные примеры пользовательская справка может в несколько раз ускорить процесс освоения нового инструмента. В этот статье мы разберем конкретные задачи, которые можно решить с ее помощью, и посмотрим, как именно это делать.
Что такое пользовательская справка?
Пользовательская справка — это разновидность документации, сопровождающей ваш продукт в качестве самостоятельной единицы или части руководства пользователя. С ее помощью пользователь может получить информацию о функциях продукта, элементах интерфейса, инструментах. Также справка может включать краткие инструкции, советы и рекомендации по использованию продукта.
Справка может быть встроенной, онлайн или гибридной.
- Встроенная справка, собственно, встроена в продукт и устанавливается в одну папку с приложением.
- Онлайн-справка, как правило, располагается на сайте разработчика. При вызове из приложения она открывается в браузере по умолчанию.
- Гибридная справка объединяет локальные и сетевые ресурсы. Часть информации хранится на компьютере пользователя, а другая подгружается из интернета по мере необходимости.
Стандартные форматы для создания справки — CHM-файл (HTML Help), WebHelp или PDF. Справка в формате HTML Help (CHM) представляет собой скомпилированный HTML — автономный веб-сайт. Можно также использовать HTM2CHM (который позволяет отсортировывать статьи в алфавитном порядке автоматически или вручную.)
Так как цель справки — помочь пользователям быстро прояснить срочные моменты и разобраться в продукте, она может также обладать функцией поиска, перекрестными ссылками (для открытия других связанных окон), возможностью добавлять закладки и так далее.
Целевая аудитория
Проще говоря, ЦА вашей справки — это любой потенциальный пользователь продукта. Тем не менее, можно выделить два основных типа пользователей.
- Неопытные пользователи, которые только начинают работать с продуктом. Для них в справке нужно отобразить и максимально подробно описать базовую функциональность, последовательность действий, привести пошаговые инструкции, добавить изображения.
- Опытные пользователи, которые уже знакомы с продуктом, но нуждаются в информации о более сложных и расширенных функциях, новых опциях и настройках. Для них можно включить в справку возможность перейти к более подробным инструкциям, например, с помощью ссылок на определенные разделы в пользовательской документации, различные мануалы и так далее.
Следовательно, составлять пользовательскую справку необходимо таким образом, чтобы в первую очередь она была доступна и очевидна для новичков, но при этом не отталкивала профессионалов.
Структура пользовательской справки
Сегодня считается, что базовая структура пользовательской справки довольно проста.
- Навигация. Справка должна содержать удобную и доступную навигационную панель, позволяющую мгновенно перейти в любой раздел. Обычно это древовидная структура с возможностями разворачивания и сворачивания блоков.
- Алфавитный указатель. То есть, список ключевых слов и фраз, упорядоченный по алфавиту, который позволяет быстро найти нужный фрагмент справки.
- Полнотекстовый поиск осуществляется по содержимому документов, а не по их именам, целиком или в существенной их части.
- Внутренние ссылки. Они связывают между собой разделы справки и дают возможность быстро переходить от одного фрагмента текста к другому, взаимосвязанному по смыслу.
А теперь поговорим о том, как составить справку правильно.
Разработка пользовательской справки: советы
Итак, основные задачи пользовательской справки:
- объяснить назначение и основные функции продукта;
- ответить на наиболее частые и важные вопросы пользователей;
- помочь предотвратить или оперативно решить наиболее типичные проблемы и ошибки.
Начать решение этих задач необходимо с ответа на следующие вопросы:
- Насколько сложен ваш продукт? Для некоторых продуктов достаточно встроить необходимую справочную информацию в интерфейс. Но с ростом сложности и функциональности продукта потребность в отдельной, достаточно подробной справке растет.
- Используете ли вы справку для восполнения недостатков интерфейса? Ведь чаще всего пользователи обращаются к справочной системе тогда, когда не могут получить ответ на вопрос или решить задачу в моменте, непосредственно пользуясь приложением. Следовательно, при достаточно понятном, интуитивном, проработанном интерфейсе продукта справку можно сосредоточить на информации, которую невозможно передать пользователю иными способами.
- Ориентирован ли продукт на технических специалистов? Опытные пользователи ожидают расширенных технических сведений о работе продукта.
Исходя из ответов, попробуйте спрогнозировать типичные трудности в освоении продукта и постарайтесь максимально разрешить их еще на стадии интерфейса, разместив краткую контекстную справку там, где она наиболее востребована.
Для иных случаев реализуйте удобные и очевидные точки доступа к более подробным разделам справки из ключевых мест приложения.
Точки входа в справку
- Делайте ссылки на конкретные и актуальные разделы. Избегайте ссылок на главную, пустые страницы или списки частых вопросов.
- Ссылки на справку не обязательно дублировать на каждом экране или странице. Размещайте их в наиболее актуальных местах, там, где пояснения действительно могут понадобиться: в диалоговых окнах, сообщениях об ошибках и настройках, под элементами управления.
- Используйте четкие и конкретные фразы в заголовках вместо абстрактных: «Как исправить ошибку ABC?» вместо «Дополнительно».
Наполнение справки
Хорошая пользовательская справка отвечает следующим критериям.
Удобно пользоваться
- Ориентация на задачи пользователя, не на функции продукта.
- Точность и достоверность изложения фактов.
- Полнота информации для эффективного применения продукта.
Легко понять
- Ясность и недвусмысленность формулировок.
- Конкретика и фактические данные вместо общих слов.
- Единообразие стиля и терминологии, отсутствие ошибок.
Просто искать
- Логичность структурирования в соответствии с задачами пользователя.
- Развитые средства навигации — оглавление, перекрестные ссылки, поиск.
- Использование визуальных и графических элементов.
Дополнительно можно придерживаться еще пяти принципов.
- Не дублируйте информацию, которая уже есть в интерфейсе. Это не добавляет справке ценности.
- Избегайте абстрактных рассуждений. Чтение справки должно приводить к пониманию и выполнению определенных действий. Исключение: информация, важная для понимания той или иной концепции, принципа.
- Не рекомендуйте тупиковые решения вроде переустановки. Исключение: случаи, когда иных вариантов попросту нет.
- Сфокусируйтесь на типичных задачах и потребностях. Описать исключения важно, но в приоритете все же стандартные ситуации. Если решить задачу можно несколькими способами, задокументируйте тот, которым пользуются чаще всего.
- Собирайте отзывы пользователей о полезности разделов. Оцените удобство использования справки.
Инструменты для создания пользовательской справки
Придерживаясь основных принципов и рекомендаций, указанных выше, составить довольно полезную справку может даже достаточно вдумчивый новичок. Но для того, чтобы еще больше упростить процесс и в дальнейшем без проблем контролировать актуальность справки, рекомендуем работать с документацией на платформе, специально разработанной именно для этого.
Документерра позволяет автоматизировать многие рутинные задачи на всех этапах от подготовки и компиляции до публикации и поддержки контента. Причем вы можете разместить здесь не только пользовательскую справку: онлайн-инструкции, руководство пользователя, программная документация, базы знаний и многое другое — единое хранилище дает возможность хранить материалы внутреннего и внешнего пользования в одном месте, тонко настраивая необходимые уровни доступа.
Следующее безусловное преимущество Документерры — это использование технологии единого источника данных и повторного применения контента. Забудьте о постоянных правках во множестве документов и версий при обновлении продукта и необходимости создавать новые документы. Достаточно поправить оригинал в редакторе — все связанные тексты автоматически заменят устаревшие данные на актуальные.
Также Документерра отлично решает задачи командной работы. Нет необходимости устанавливать дополнительные инструменты для синхронизации — единое рабочее пространство с проектами доступно сразу. В нем можно структурировать и хранить документы, настраивать уровни доступа и назначать ответственных исполнителей. Система уведомлений позволит оперативно координировать задачи в команде.
Более подробно наши специалисты готовы рассказать на бесплатном демо!
* * *
Итак, мы разобрали основные задачи, которые призвана решать пользовательская справка, рассмотрели оптимальную структуру и ключевые принципы ее составления.
Следуя основным рекомендациям, опираясь на отзывы реальных пользователей и используя современные инструменты вроде Документерры, можно создать по-настоящему полезную справку, которая станет неотъемлемой частью успеха вашего продукта.
Главное — всегда помнить, что справка должна служить помощником пользователю в момент затруднения, а не новым источником проблем. Поэтому ключ к успеху — максимальная ориентация на конечного потребителя.
