Лучшие примеры пользовательской документации

Пользовательская документация, возможно, является одной из наиболее важных частей разработки вашего продукта. Чтобы пользователи по-настоящему поняли, как работает ваш продукт, им всегда будет нужна точка отсчета.

А когда дело доходит до цифровых продуктов или услуг, пользовательская документация, иногда называемая базой знаний, является одним из лучших способов объяснить все аспекты вашего продукта.

Econsultancy обнаружила, что более 50 % клиентов предпочитают использовать цифровую базу знаний, а более 70 % клиентов предпочитают использовать онлайн-документацию, а не звонить в службу поддержки. Одна только эта статистика подтверждает важность руководств пользователя и документации.

Преимущества пользовательской документации

Давайте посмотрим, почему пользовательская документация важна, а также почему она полезна для вашего бизнеса в долгосрочной перспективе.

• Удовлетворенность клиентов. Последнее место, где клиент хочет быть, — это разговаривать по телефону с вашей службой поддержки после того, как он не понял ваш продукт. Легкодоступная документация поможет вашим клиентам в режиме реального времени разобраться с самыми простыми и самыми сложными функциями.
• Поддерживайте продуктивность команды. Наличие постоянной точки отсчета может снять огромную нагрузку с вашей службы поддержки. Вопросы, на решение которых может уйти 15 минут, можно решить, указав клиентам правильное направление в руководстве пользователя.
• Опыт работы с клиентами. Чаще всего клиенты помнят плохой опыт больше, чем хороший. Таким образом, обеспечение того, чтобы клиенты максимально эффективно использовали ваш продукт с помощью онлайн-документации, является одним из способов предотвратить их замешательство или неудовлетворенность вашим обслуживанием.
  И если вы вернетесь к продуктам, которые используете ежедневно, вы обнаружите, что 99% из них уже имеют руководство пользователя. На самом деле создать базу знаний самостоятельно относительно легко.

Как пользователь WordPress, вы можете использовать определенные темы документации для создания базы знаний WordPress за несколько минут. И если вы не используете WordPress, существует множество системных платформ баз знаний, которые вы можете использовать вне его.

Создайте базу знаний - простой способ!

Создайте базу знаний и помогите своим клиентам помочь себе.

Получить тему

Специально для этой статьи мы сосредоточимся на примерах отличных руководств пользователя и онлайн-документации. Глядя на то, что успешно делают другие бренды, вы можете понять, как структурировать собственное руководство пользователя.

Вы готовы начать? Давайте взглянем.

# 1: Слабость

Slack — один из самых популярных инструментов мгновенного общения в мире. Платформа помогает миллионам компаний вести важные рабочие обсуждения в режиме реального времени.

И, несмотря на простоту общения, Slack предлагает множество функций и инструментов, повышающих продуктивность бизнеса. Само собой разумеется, что понять, как эффективно использовать Slack без документации Справочного центра, было бы невозможно.

Первое, что пользователи увидят при посещении справочного центра Slack, — это большая форма поиска с предлагаемыми ключевыми словами для общих вопросов, которые возникают у пользователей. Это позволяет пользователям сразу приступить к поиску ответов на насущные вопросы.

Во многих случаях одной формы поиска достаточно, чтобы помочь решить большую часть вопросов, которые могут возникнуть у ваших клиентов. Но всегда приятно сделать еще один шаг вперед и предоставить ступеньки. Например, добавляя ссылки на страницы, которые больше всего интересуют пользователей.

Этот раздел главной страницы Справочного центра Slack ведет пользователей по 6 различным направлениям, каждое из которых предназначено для конкретного варианта использования самого продукта. Помимо изучения основ Slack, клиенты также могут перейти на страницы, на которых объясняются более продвинутые функции, включая интересные советы и приемы, которые могут быть незаметны на первый взгляд.

Другими словами, вы можете использовать свою базу знаний или руководство пользователя, чтобы помочь пользователям глубже понять ваш продукт.

И последнее, но не менее важное: будьте тщательны в своем подходе. Отличная страница документации охватывает все, от базовых до самых продвинутых функций. Несмотря на то, что Slack использует интуитивно понятный пользовательский интерфейс, справочный центр максимально полно охватывает все аспекты использования продукта.

# 2: Всезнайка

KnowAll — это ведущая в мире тема базы знаний на основе WordPress, созданная вашим покорным слугой. Такие бренды, как Pagely, Apptentive, OptimizePress и многие другие, используют KnowAll, чтобы предоставлять своим клиентам полезные руководства и ответы на важные вопросы.

Имеет смысл только использовать Справочный центр KnowAll в качестве основы для подробного обзора этой темы.

Как и другие страницы онлайн-документации, KnowAll также включает вводную форму поиска, которую невозможно пропустить. Это хлеб с маслом любого руководства пользователя.

Приятным небольшим дополнением является то, что KnowAll использует поиск в реальном времени:

Результаты поиска извлекаются в режиме реального времени и отображаются как часть самой формы поиска. Это экономит клиентам несколько кликов, поскольку они могут сразу найти страницы справки, связанные с интересующим их ключевым словом.

Сами страницы справки структурированы аналогично сообщениям в блогах. Позволяет вам подробно объяснять определенные темы с использованием всех традиционных элементов редактирования контента, с которыми вы уже знакомы.

В этом примере необходимо учитывать 3 важных фактора пользовательского интерфейса:

1. Хлебные крошки — эффективный способ сообщить клиентам, в какой части страницы они находятся, а также позволить клиентам быстро вернуться к определенной категории поддержки, если они того пожелают.
2. Содержание — страницы подробной справки должны иметь виджет «Оглавление», чтобы клиенты могли перейти к наиболее интересующему их разделу.
3. Поддержка — наконец, средство, с помощью которого клиенты могут связаться с вашей службой поддержки, если страницы помощи окажется недостаточно.

Эти факторы убеждают клиентов в том, что они всегда могут получить необходимую им поддержку, даже если что-то не совсем понятно.

И, наконец, вопрос мобильной поддержки. Все больше и больше клиентов просматривают Интернет со своих мобильных или портативных устройств, а это означает, что адаптивный веб-сайт имеет решающее значение для вашего успеха.

Интегрированный адаптивный дизайн KnowAll гарантирует, что ваша база знаний будет великолепно выглядеть как на настольных, так и на мобильных устройствах.

№3: Гугл

Google — самый популярный веб-сайт в мире. Будь то Поиск, Gmail или Android — миллиарды людей пользуются услугами Google каждый день. Компания владеет сотнями продуктов и инструментов, и в большинстве случаев у каждого продукта есть своя страница документации или руководство пользователя.

Наиболее распространенные вопросы и отзывы обрабатываются через справочный портал Google. Там вы найдете ответы в стиле базы знаний и форумы сообщества для отправки отзывов или вопросов.

А для бренда размером с Google имеет смысл поддерживать онлайн-форум, где пользователи могут помогать друг другу с конкретными вопросами. Это дает клиентам возможность объяснить проблемы, которые могут не охватываться вашей документацией, а также участвовать в обсуждении потенциальных функций, которые клиенты хотели бы видеть добавленными в будущем.

Одним из подходов, которые использует Google, является функция «Upvote». Это позволяет всем вашим клиентам обсуждать вопросы или отзывы, которые наиболее важны для них.

Аналогично тому, как вы назначаете приоритет определенным заявкам в службу поддержки с помощью программного обеспечения службы поддержки.

Кроме того, клиенты могут либо подписаться на новые ответы, либо оставить свой комментарий.

В долгосрочной перспективе это поможет выявить уникальные проблемы, а также поможет вам создать гораздо больший каталог ответов на вопросы службы поддержки.

# 4: Цифровой океан

DigitalOcean — один из ведущих поставщиков облачного хостинга для разработчиков. И, в отличие от традиционных справочных страниц, DigitalOcean полностью поддерживает свои ресурсы документации через страницу сообщества. Как следует из названия, большая часть поддержки предоставляется самим сообществом.

Это происходит в виде письменных руководств, вопросов на форумах и отдельных страниц документации по продуктам DigitalOcean.

Подход к документации, управляемый сообществом, может иметь огромные преимущества для вашей прибыли. И вот почему.

1. Это побуждает клиентов участвовать в вашем продукте или услуге за пределами его основной функциональности.
2. Вы можете создавать определенный контент, который затем индексируется и ранжируется поисковыми системами. Таким образом, предоставляя вам ценные преимущества SEO.
3. Активное сообщество помогает формировать положительную репутацию в глазах потенциальных новых клиентов.

Понятно, что преимущества подхода, основанного на сообществе, во многом зависят от типа продукта или услуги, которые вы предоставляете. Но об этом стоит подумать, учитывая, насколько успешным он может быть.

# 5: Арефс

Как один из ведущих SEO-инструментов — Ahrefs — управляет пользовательской документацией для, казалось бы, сложного продукта? Ответ прост. Справочный центр Ahrefs сразу переходит к делу, когда дело доходит до предоставления помощи с ответами, которые могут быть у клиентов.

Тем не менее, одна вещь выделяется больше, чем остальные.

Что является фактическими страницами справки. Ahrefs относится к своей документации так же, как к странице блога, с подробными и подробными статьями, объясняющими каждую уникальную функцию их продукта.

Поскольку сам продукт относительно сложен и требует крутой кривой обучения, написание страниц документации в стиле блога помогает клиентам лучше понять, как использовать продукт. Без необходимости полагаться на сторонние руководства.

Излишне говорить, что это позволяет вам ранжировать собственные страницы документации в поисковых системах. Скорее всего, клиенты будут искать уникальные взаимодействия с вашим продуктом, и публикация этой информации поможет повысить удержание клиентов.

Советы по улучшению руководства пользователя

Примеров, которые мы рассмотрели в этой статье, должно быть достаточно, чтобы помочь вам начать работу со свежими идеями.

И в завершение давайте рассмотрим некоторые способы дальнейшего улучшения вашего руководства пользователя и/или страниц документации.

• Используйте визуальные эффекты. Визуальное обучение гораздо более доступно, чем в длинных абзацах. Клиенты должны чувствовать, что могут найти ответ за считанные секунды, потому что в противном случае вы рискуете представить продукт более сложным, чем он есть на самом деле.
• SEO. Некоторые продукты перерастают сами себя. В результате клиенты будут обращаться к поисковым системам, чтобы найти ответы на уникальные вопросы и/или взаимодействия. Убедитесь, что вы пишете свои страницы документации с намерением найти их через поисковые системы.
• KYC — знай своего клиента. Какова их техническая мощь? Почему они используют ваш продукт? Понимание личности вашего идеального клиента поможет вам адаптироваться к стилю общения, который вы используете на страницах документации.

Отслеживание вопросов, которые клиенты задают вам напрямую, также поможет сформировать вашу документацию. Кроме того, следите за упоминаниями в социальных сетях и на сайтах вопросов и ответов. Вы никогда не узнаете, как клиенты захотят использовать ваш продукт, пока не увидите его сами.

Вывод

Основная цель руководств пользователя и документации — сократить время, необходимое покупателю для понимания вашего продукта. И, как мы узнали из этой статьи, существует множество способов приблизиться к этому.

Четкие, хорошо проинструктированные и организованные руководства пользователя помогут вашим клиентам использовать ваш продукт в полной мере. И это сэкономит вашей команде поддержки много времени, которое можно потратить на решение критических проблем.