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

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

Помогайте пользователю решить его задачи

Описывайте не интерфейс, а действия. У пользователя есть задачи, он хочет их решить, а ваша задача объяснить ему, как это сделать с помощью вашего продукта. К примеру, есть у нас какой-нибудь утюг.

Описан интерфейс, описано глажение паром. Если пользователь никогда не гладил, ему надо все изучить, запомнить все кнопки, прикинуть, нужно ли ему сейчас глажение с паром или можно обойтись без пара.

Я бы сделала иначе. В моей инструкции была бы описанием «Как погладить одежду». Если бы это был онлайн-утюг, добавила бы ссылки на статьи «Как погладить постельное», «Как погладить синтетику» и так далее. Потому что задача пользователя — погладить.

Разбивайте на логические части

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

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

Рассказывайте, с чего начать

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

Вот так выглядит руководство пользователя в одном из конструкторов. Мне нравится, что оно разбито на логические блоки, но оно не закрывает один очень важный вопрос «С чего начать?».

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

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

Просто добавляем раздел «Начало работы»
и пользователю будет легче знакомиться с продуктом

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

Добавляйте примеры и сценарии использования

Например, в сервисе Кайтен появилась фича — можно создать карточку на канбан-доске из пользовательской истории. Пользователю может быть неочевидна польза от этого, тогда добавляем пример.

Примеры и сценарии использования помогут пользователю понять ценность продукта. В какой ситуации мне понадобится эта вкладка? Зачем мне менять режимы? И так далее.

Упрощайте

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

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

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

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

Нет

Да

Переход в личный кабинет осуществляется путем нажатия на данную кнопку.

Чтобы перейти в личный кабинет, нажмите на эту кнопку.

Обнаружили баг? Напишите нам.

Нашли ошибку? Напишите нам.

Используйте даблклик, чтобы оффнуть буллит.

Снимите отметку двойным щелчком мышки.

Иллюстрируйте схемами, скриншотами, гифками

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

Рассказываю, как создать карточку, и показываю на скриншоте куда нажимать

Я делаю скриншоты с помощью Лайтшота. На Маке есть родная программа, но Лайтшот мне привычней.

Сделайте гифку, если нужно показать несколько действий подряд. Я использую сервис GIPHY, его можно найти в Аппсторе. Примера не будет, почему-то Вордпресс не слушается и не вставляет гифку так, как я хочу 🙁

Схемы помогают описать принцип работы.

Проиллюстрировала принцип показа смарт-баннеров

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

Подойдите серьезно к верстке

Часто вижу проблему в гайдах — их тяжело читать. То шрифт дурацкий, то скриншоты слишком мелкие или, наоборот, огромные. Это влияет на то, как быстро и легко пользователь сможет найти ответ на свой вопрос. Вот мои советы, как сделать верстку руководства нормальной и читабельной:

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

Чек-лист по сознанию понятного руководства пользователя

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

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

Обсудим?