Руководство по продукту это

Чем пошаговые руководства по продукту лучше, чем другие шаблоны онбординга?

Любому SaaS-инструменту на рынке сегодня легко найти бесчисленное множество альтернатив, авторы которых неустанно стараются сделать свое детище лучше и доступнее продукта конкурентов. Да, как правило, эту «гонку» выигрывают те решения, функциональность которых богаче и интереснее, но умение эффективно продемонстрировать ценность продукта все еще остается самым простым, но при этом действенным способом «пробиться» наверх. Однако дивиденды из этого подхода смогут извлечь только те игроки, которые мастерски владеют навыком презентации продукта, используя для этого такие средства и технологии, которые гарантированно позволяют добиться признания аудитории.

Этим и объясняется растущий интерес продакт-менеджеров к такому средству привлечения и удержания клиентов, как онбординг или обучение продукту (product education), в рамках которого одним из наиболее эффективных инструментов являются знакомые всем пошаговые руководства (product walkthroughs) или интерактивные продуктовые туры: благодаря им, наступление «Ага!»-момента у пользователя становится делом более управляемым и прогнозируемым. 

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

Содержание статьи

Что такое product walkthroughs?

Для каких продуктов необходимо разрабатывать пошаговые руководства?

4 простых шага, чтобы сделать эффективное руководство по продукту

1. Определите показатель ценности
2. Определите препятствия на пути к цели
3. Дизайн
4. Разработка

3 примера отличных пошаговых руководств по продукту

CitizenShipper
Evernote
Ninox

Заключение

Что такое product walkthroughs?

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

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

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

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

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

Почему «одноразовый» онбординг — не выход?

Для каких продуктов необходимо разрабатывать пошаговые руководства?

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

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

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

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

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

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

Вы также можете нацелить их на разные сегменты пользователей. Например, вы могли бы обзавестись руководством:

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

11 простых способов прокачать активацию функций вашего продукта

4 простых шага, чтобы сделать эффективное руководство по продукту

Всего 4 шага отделяют от вас от создания руководства, которое ощутимо выделит вас на фоне конкурентов.

1. Определите показатель ценности

Главная задача пошагового руководства — максимально быстро довести пользователей до «Ага!»-момента: того самого мгновения, когда пользователь видит отдачу от продукта и он начинает казаться ему удачной находкой.

То, что происходит в это время, в конечном счете зависит от самого продукта.

Возьмем, к примеру, Instagram.

Наступает ли момент осознания ценности соцсети, когда вы «лайкаете» фотографии своих друзей, публикуете свои собственные или, возможно, когда отмечают «лайком» ваши фото?

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

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

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

Метрики активации: реальная мера успеха вашего стартапа

2. Определите препятствия на пути к цели

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

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

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

Среди наиболее распространенных трудностей— следующие:

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

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

7 этапов адаптации пользователей для бизнеса по подписке

3. Дизайн

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

Наиболее эффективные руководства, как правило:

  • предельно понятны: в них четко указано, что и как нужно делать, чтобы воспользоваться конкретной функцией — никакой двусмысленности или непонятных рядовому юзеру жаргонизмов;
  • лаконичны: пользователи заинтересованы в том, чтобы как можно быстрее получить конкретный результат, ценность, поэтому пошаговые инструкции должны быть емкими (чтобы оставаться понятными), но вместе с тем сохранять краткость;
  • интерактивны: пошаговые руководства уже должны быть интерактивными по определению, они требуют от пользователей взаимодействия и выполнения задач. Задачи должны быть содержательными, с числом рекомендаций, соответствующим сложности рассматриваемого шага, привлекательными графически и понятными по смыслу;
  • имеют возможность пропуска: не всем пользователям будет удобно проходить пошаговое руководство в тот момент, когда вы им это предложите, а кто-то не будет изучать его в принципе. Возможно, кто-то уже плотно работал с вашим приложением раньше, и он не нуждается в помощи. Те сложности, которые вы определили в своем продукте, для некоторых пользователей таковыми не окажутся;
  • дополнительная поддержка: с другой стороны, для некоторых пользователей пошагового руководства может быть недостаточно, и им может потребоваться дополнительная помощь. В рамках руководства этот канал помощь должен быть реализован, например, в виде live-чата.

6 типов UX/UI-шаблонов онбординга: что и когда использовать?

4. Разработка

А теперь о самом сложном.

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

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

3 примера отличных пошаговых руководств по продукту

Рассмотрим три примера веб-продуктов, которые славятся своими образцово-показательными пошаговыми руководствами.

CitizenShipper

CitizenShipper — это маркетплейс услуг доставки, который работает в США и предлагает пользователям различные услуги по отправке и доставке товаров.

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

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

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

Как только новый водитель или подрядчик входит в CitizenShipper, его встречает краткое описание продукта:

Всплывающие подсказки дают пояснение по каждому важному элементу приложения

Всплывающие подсказки дают пояснение по каждому важному элементу приложения

А ниже — мобильная версия того же гида:

«Мы рады, что вы присоединились к нам! Сейчас мы вам покажем, что и как тут устроено»

«Мы рады, что вы присоединились к нам! Сейчас мы вам покажем, что и как тут устроено»

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

Вот что в пошаговом руководстве CitizenShipper оказалось верным:

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

Персонализация онбординга как лучшая стратегия гроуз-хакинга

Evernote

Evernote — это сервис для создания и хранения заметок, который доступен в разных форматах: как мобильное, настольное и веб-приложение. Вы можете создавать списки дел, таблицы, делать заметки и многое другое.

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

«Добро пожаловать в Evernote! Давайте выясним, как и чем мы вам можем помочь. Это займет меньше минуты»

«Добро пожаловать в Evernote! Давайте выясним, как и чем мы вам можем помочь. Это займет меньше минуты»

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

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

«Для каких целей вы собираетесь использовать Evernote: создание заметок, формирование чек-листов, планирование проектов? На каком устройстве вы будете пользоваться решением: настольный компьютер, веб-браузер, смартфон, планшет?» — и т.д.

«Для каких целей вы собираетесь использовать Evernote: создание заметок, формирование чек-листов, планирование проектов? На каком устройстве вы будете пользоваться решением: настольный компьютер, веб-браузер, смартфон, планшет?» — и т.д.

В процессе создания первого списка руководство поможет вам сориентироваться в

редакторе.

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

Evernote не просто показывают, где находятся те или иные элементы, — при помощи GIF-анимаций они демонстрируют, что вы можете сделать с интересующим вас инструментом

Еще один пример, как Evernote демонстрирует различные функции элемента:

пример, как Evernote демонстрирует различные функции элемента

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

Для каждой функции продукта разработано свое руководство, но их изучение осуществляется по запросу.

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

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

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

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

Итак, Evernote хороши в том, что:

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

14 принципов онбординга для вашего сайта или приложения

Ninox

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

Что делает пошаговое руководство по их продукту замечательным, так это его простота. При первом входе в продукт вас встретит «ассистент», который пообещает всего за несколько шагов продемонстрировать весь продукт:

Добро пожаловать! Привет, я ваш персональный помощник. Всего за несколько шагов я познакомлю вас со всем приложением

Добро пожаловать! Привет, я ваш персональный помощник. Всего за несколько шагов я познакомлю вас со всем приложением

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

Нужно ли повторять, что подобные чек-листы — настоящая находка для пользователя? 

Нужно ли повторять, что подобные чек-листы — настоящая находка для пользователя? 

В чек-листе вы найдете еще одно обещание — начать работу с Ninox вы сможете всего за 3 минуты. Выполнив оставшиеся задачи, вы познакомитесь с различными компонентами продукта и откроете для себя его ценность:

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

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

Ресурс внимания пользователей весьма ограничен, поэтому чтобы довести их до «Ага!»-момента, у вас не так много времени.

Можно с уверенностью сказать, что пример руководства по продукту Ninox весьма показателен:

  • сервис обещает, что обучение не отнимет у пользователя много времени (так и происходит);
  • процесс адаптации донельзя прост и ориентирован на скорейшее наступление «Ага!»-момента.

Топ-5 KPI онбординга пользователей

Заключение

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

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

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

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

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

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

Прокачайте свой онбординг!

По материалам: userguiding.com Изображение: freepik.com

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

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

Цель руководства по эксплуатации: Обеспечить безопасное и эффективное использование продукта

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

Процесс разработки

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

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

Советы по созданию руководства по эксплуатации

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

– Четко определите цель руководства. Что пользователи должны узнать, прочитав его?

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

– Используйте заголовки, чтобы разбить текст и облегчить читателям понимание. Например, начинайте каждый раздел с заголовка, такого как «Начало работы», «Использование камеры» или «Управление фотографиями».

– Приведите примеры выполнения заданий, чтобы читатели могли увидеть, что от них ожидается. Это поможет им понять и запомнить то, что они читают.

Как написать руководство пользователя программы или сайта — инструкции, советы, помощь, программное обеспечение

Журавлев Денис

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

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

Каждый программный продукт нуждается в руководстве пользователя

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

Общие советы по созданию пользовательской документации

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

После этого важно подумать о том:

  • Где пользователь будет к нему обращаться: дома, на работе, в машине?
  • Как часто он будет его просматривать?
  • Насколько объективно сложен для понимания продукт?

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

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

Структура руководства пользователя

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

В первом разделе желательно рассказать общую информацию о программе:

  • Для чего создан продукт.
  • Какие задачи он решает.
  • Какие основные выгоды от использования для клиента.

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

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

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

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

Инструменты для быстрого создания руководства пользователя

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

Одним из популярных инструментов для создания качественного руководства является программа Dr. Explain (https://www.drexplain.ru), в которой уже есть готовые шаблоны руководств пользователя с готовой структурой разделов и в которой удобно обновлять документацию, как бы часто эти обновления не происходили.

Видео-обзор основных возможностей программы Dr.Explain

Удобной особенностью инструмента является возможность экспортировать один и тот же документ в форматы: HTML, CHM, PDF. Простой и понятный интерфейс сам подскажет, как быстро просмотреть документ в различных форматах и настроить его под вывод в эти форматы.

Любой проект в Dr.Explain вы можете создать с нуля или импортировать уже существующую документацию, например из формата MS Word, HTML или CHM-файла, и буквально за несколько минут создать из нее онлайн-помощь, файл справки в формате CHM, или документ в формате PDF.  

Экспорт руководства пользователя в различные форматы

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

Структура разделов руководства пользователя

У программы свой собственный редактор, оптимизированный под работу со сложной документацией. Основные функции редактора вынесены в компактный тулбар. Это — управление стилем текста, форматирование абзацев, вставка ссылок, изображений, видео, таблиц и списков, а также вставка специальных объектов. Dr. Explain экономит время и силы своих пользователей. Разработчики документации часто сталкиваются с проблемой многократного использования одного и того же фрагмента текста и прибегают к очевидным решениям — «Ctrl+c», Ctrl+v». Dr.Explain предлагает решение по повторному использованию контента — текстовые переменные. Это решение экономит время, когда нужно много раз использовать один и тот же текст, особенно, который может периодически изменяться — например, версия документируемой системы.

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

Многие российские компании сталкиваются с тем, что руководство пользователя нужно писать согласно ГОСТ 19 и ГОСТ 34. Dr.Explain активирует поддержку требований ГОСТ фактически одним кликом. Программа автоматически сформирует структуру обязательных разделов и установит требуемые параметры страницы, стили абзацев, списков и заголовков.

Создание руководства пользователя по ГОСТ 34 и ГОСТ 19

Часто техническим писателям при документировании пользовательского интерфейса приходится снабжать изображения пояснительными выносками. Для таких случаев программа поддерживает специальные графические объекты — аннотированные экраны. Чаще всего аннотируются скриншоты программ и страниц веб-сайтов. Уникальной особенностью Dr.Explain является автоматическая аннотация изображений, получаемых при захвате экранов с окнами программ или сайтов. Программа анализирует структуру окон и добавляет пояснительные выноски ко всем значимым элементам.

Аннотирование скриншотов пользовательского интерфейса в руководстве пользователя

Кроме того, Dr.Explain позволяет нескольким авторам одновременно работать над проектом с использованием сервиса www.tiwri.com, учетную запись на котором можно создать бесплатно за пару минут. При внесении правок одним автором сервис блокирует редактируемые разделы проекта для изменения другими авторами.  По окончании редактирования изменения отправляются на сервер, и блокировка снимается. Так несколько человек могут одновременно работать над различными разделами проекта без риска помешать друг другу.  

Многопользовательская работа над проектом

Попробовать режим многопользовательской работы в Dr.Explain можно даже с бесплатной лицензией. Вы можете создать общий проект и полноценно работать с ним в многопользовательском режиме до семи дней.

Почему компании выбирают Dr.Explain для создания руководств пользователя

Павел Свиридов

Павел Свиридов, профессиональный военный, полковник, создатель астрологической системы «Вега Матрица»

«Только программа Dr.Explain обладала всеми необходимыми возможностями. А главное — она давала простор для творчества. Можно было выбрать цветовую гамму, вид и форму служебных элементов, настраиваемые шаблоны. Это позволило мне сохранить стилевое единство документации и самой программы. Ну, и конечно, полуавтоматическая обработка материала существенно облегчает и ускоряет работу по созданию хелпа.

Обучение работе в Dr.Explain было наглядным и сделано возможностями самой программы, что безусловно повлияло на мой выбор в ее пользу».

Руководство пользователя к программе Вега Матрица

Прочитать полный кейс компании «Вега Матрица вы можете перейдя по ссылке


Наталья Обухова

Наталья Обухова, бизнес-аналитик компании CRM Expert

«По классике жанра был пилотный проект на двух фаворитах (Dr.Explain и HelpNDoc) и муки выбора.

Через неделю справка была полностью готова. Конечно, если мы набивали ее «с нуля», за это время мы бы не успели. Мы просто конвертировали все бумажные инструкции во внутренний формат программ, изменили каталогизацию и организовали систему гиперссылок.

Сначала фаворитом выбора была другая система, но решающим фактором в пользу Dr.Explain стал возглас человека, выполняющего основную часть работы по переносу текста: «Вжух! И вся структура документа перенеслась в файл справки». Функция импорта в Dr.Explain отработала на ура и сэкономила кучу времени.

Также очень подкупил дизайн веб-справки, который формируется Dr.Explain, и красивый способ организации подписей к окнам нашей системы. В Dr.Explain это называется «Аннотирование экрана».

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

Прочитать полный кейс компании CRM Expert


Николай Вальковец

Николай Вальковец, разработчик компании 2V

«Мы значительно сократили время работы техподдержки с новыми клиентами на этапе подключения. Раньше требовалось проводить онлайн презентации и видео конференции для новых клиентов, объясняя особенности программы. Сейчас же, один раз постаравшись максимально подробно всё описать, мы избавили себя и нашу техподдержку от этой работы. Нам импонирует простота программы и скорость работы. Можно быстро редактировать, добавить новые пункты в документацию, сохранить в формате HTML и выложить на сайт».

Руководство к программе 2V Стоматология

Прочитать кейс компании V2  


Подытожим

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

Скачать Dr.Explain с неограниченной по срокам возможностью бесплатной работы можно по адресу: https://www.drexplain.ru/download/

Успешных вам разработок!

Смотрите также

  • Dr.Explain — инструмент для создания мобильной версии пользовательской документации к программным продуктам
  • Шаблоны файлов помощи, руководства пользователя программного обеспечения или сайта, шаблон базы знаний — бесплатные шаблоны и примеры пользовательской документации

На чтение 10 мин Просмотров 1.1к. Опубликовано 30.10.2021

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

Зачем писать практические руководства?

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

Например, посчитайте, сколько людей каждый день ищут в Google «Как [любое слово]»:

Как написать подробное руководство

Эти поисковые запросы демонстрируют одну из основных причин, по которой люди обращаются к Интернету: чтобы узнать, как что-то сделать.

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

Достаточно сказать: практические руководства стоит добавить в ваш арсенал контента.

Как сделать практическое руководство

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

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

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

  • Проведите исследование ключевых слов, чтобы узнать, что люди хотят узнать.
  • Используйте Ahrefs, SEMrush или любой другой инструмент SEO для определения похожих ключевых слов и запросов. Это может помочь вам создать всестороннюю статью, которая ответит на все вопросы ваших читателей и поможет вам получить рейтинг в Google.
  • Посмотрите на своих конкурентов, чтобы увидеть, как они пишут свои руководства.

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

Понять проблемы и проблемы вашей целевой аудитории.

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

Например, если вы пишете «Как создать стратегию контент-маркетинга», вы можете выполнить следующие действия:

  • Начните с ответов на вопрос «Что такое контент-маркетинг?» На Яндекс.Кью, например. Эти пользовательские ответы могут помочь вам определить общие темы, заблуждения или путаницу в контент-маркетинге.
  • Обратитесь к своей исследовательской маркетинговой группе, чтобы определить общие болевые точки или вопросы, которые они видели в опросах или фокус-группах относительно «контент-маркетинга». Например, вы можете обнаружить, что большая часть вашей аудитории считает контент-маркетинг для них приоритетом, но они не знают, как это сделать в рамках бюджета.
  • Проведение подобного качественного исследования предоставит вам информацию, необходимую для того, чтобы в вашем практическом руководстве были рассмотрены все актуальные проблемы по данной теме.

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

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

Многие читатели будут использовать ваше практическое руководство как список инструкций. Например, если вы пишете «Как сделать снимок экрана на Mac», вы захотите записать каждое конкретное действие, необходимое для создания снимка экрана. По возможности используйте визуальные эффекты, такие как GIF, изображения, снимки экрана и видео, чтобы дополнить свои инструкции.

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

Расскажите читателю, почему это важно.

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

Как написать практическое руководство

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

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

Существует огромная разница между читателями, которые ищут «Что такое запрос предложения?», И теми, кто ищет «Как написать запрос предложения?».

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

При написании практического руководства следует помнить о некоторых методах:

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

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

Например, «Как создать канал на YouTube», вероятно, привлекает новичков на YouTube, которые просто заинтересованы в создании канала для просмотра и комментирования сообщений друзей. Однако это, вероятно, также привлекает профессиональных маркетологов, которым необходимо создать канал для своего бизнеса, чтобы привлекать и конвертировать потенциальных клиентов.

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

Есть ли разница в том, как вы пишете руководство пользователя и практическое руководство?

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

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

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

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

Примеры практического руководства

  1. Практическое руководство по рецептам.Как написать подробное руководствоНа сайте Гастроном аккуратно структурированы рецепты, поэтому читатели могут быстро определить: сколько времени займет приготовление, ингредиенты, которые им понадобятся, количество порций и т.д. Если читатель уже знает ингредиенты, он может щелкнуть «Инструкции», чтобы сразу начать. В качестве альтернативы, скажем, читатель предпочитает просматривать инструкции, а не читать, он может щелкнуть «Посмотреть видео с практическими рекомендациями». Это предлагает хороший выбор для посетителей, которые по-разному потребляют контент.

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

  2. Практическое руководство для B2B.В статье Atlassian «Как написать идеальный 90-дневный план» приведены важные контекстные детали для 90-дневного плана, в том числе «Что такое 90-дневный план?» и «Что должно быть включено в 90-дневный план?» Публикация хорошо проработана и написана с сочувствием.Лучше всего то, что в руководстве есть загружаемый PDF-файл с 90-дневным планом, так что читатели могут сразу загрузить и использовать план Atlassian со своей командой.

    Вывод: подумайте, какие электронные книги, PDF-файлы, диаграммы, дизайны Canva или Google Таблицы вы можете создать самостоятельно и предложить читателям для загрузки. Читатели оценят возможность немедленно применить то, что они узнали.

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

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

  4. Практическое руководство по продукту.Статья How-To Geek под названием «Как найти данные в Google Таблицах с помощью ВПР» не обязательно является самой интересной темой. Тем не менее, бренд эффективно поддерживает интерес к контенту с помощью чутких заявлений вроде: «ВПР может показаться запутанным, но это довольно просто, если вы поймете, как это работает».Кроме того, How-To Geek включает полезные оригинальные изображения, демонстрирующие каждый совет, который они описывают. Эти изображения не обязательно должны быть ультрасовременными визуальными эффектами, созданными профессиональной командой дизайнеров — как показывает этот пост, несколько простых снимков экрана имеют большое значение для того, чтобы помочь читателям понять сложную тему.

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

  5. Практическое руководство по образу жизни.Еще один пример — пост на Medium под названием «11 способов быстро избавиться от стресса в вашей жизни». Ожидается, что в ней будет нескольких простых и быстрых советов, как избавиться от стресса. Но первый раздел поста — «Влияние стресса на вашу жизнь». В этом случае важно, чтобы читатели понимали, почему, а не как .

    Вывод: поиграйте со структурой. Подумайте, что ваши читатели должны знать, чтобы остальная часть сообщения имела для них значение. Например, вы можете начать с раздела «Что такое …?» и «Почему … имеет значение» перед тем, как погрузиться в «Как делать …». Таким образом, ваши читатели будут полностью заинтересованы в том, чтобы узнать, как эти советы могут улучшить их жизнь в небольшом (или большом) смысле.

Шаблон для написания практического руководства можно получить как гуглдок здесь. Чтобы сохранить к себе, нажмите Файл -> Создать копию. Там же шаблоны и других материалов для блога.

Статья является адаптированным переводом https://blog.hubspot.com/marketing/how-to-guide.

Читайте также:

  • Как написать отличную пошаговую инструкцию
  • Создание контента: полное руководство для начинающих
  • Анатомия самых популярных статей: успешный и невидимый контент

Photo by James McKinven on Unsplash.

Ценность продукта для клиента – один из важных критериев для построения эффективного и успешного бизнеса. Но даже идеальный с точки зрения пользовательских характеристик продукт может провалиться на рынке, если у него нет качественной технической и сервисной поддержки. Один из ключевых элементов такой поддержки – грамотная справочная документация. О том, как повысить ценность IT-продукта с помощью руководства пользователя, в своей авторской статье для портала Biz360.ru рассказал основатель компании «Индиго Байт» Денис Журавлёв.

Досье

Денис Журавлёв – 42 года, IT-предприниматель из Самары, основатель и директор компании «Индиго Байт». Окончил факультет информатики Самарского государственного аэрокосмического университета, там же защитил кандидатскую диссертацию по автоматизации систем качества на производстве. Флагманский продукт компании «Индиго Байт» – ПО для создания пользовательской и справочной документации и баз знаний Dr.Explain.

Денис Журавлёв

Узкие места сервисной поддержки

Сразу хочу задать несколько вопросов уважаемым читателям:

  • Как вы считаете, что делает ваш продукт ценным в глазах клиента?

  • За что пользователь ценит и любит ваш продукт?

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

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

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

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

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

Кроме того, большая загрузка техподдержки – это ещё и прямые затраты на оплату рабочих часов специалистов, оплату входящих звонков, если вы используете номер 8-800, оплату более дорогих планов helpdesk-систем.

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

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

И тут на помощь может прийти качественная пользовательская документация.

Помоги себе сам

Есть устойчивый миф, что в наше время сопроводительную документацию никто не читает. Могу с уверенностью сказать – это не так.

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

Если перед человеком стоит задача получить определённый результат в вашей программе, он постарается её выполнить, даже если упрётся в трудности. Преодолеть возникшие трудности он сможет тремя путями:

  1. Загуглить вопрос в открытых источниках – на профильных сайтах, в Youtube, на форумах;

  2. Читать документацию – в самом программном продукте или на сайте;

  3. Обратиться в поддержку – по email или телефону.

Наш опыт показывает, что клиенты (а особенно IT-шники и иже с ними) в первую очередь попытаются самостоятельно найти ответ на свой вопрос первыми двумя способами. И это очень удачная для нас, как для владельцев бизнеса, ситуация. 

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

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

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

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

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

Итак, делаем вывод, что пользовательская документация – это способ повлиять на значимость и ценность продукта и на расходы компании.

Однако, это влияние может быть как в хорошую, так и в плохую сторону. Так что делает документацию качественной?

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

  1. Структурированность.

  2. Многоформатность и доступность.

  3. Качество контента.

Фактически, дальнейший текст можно считать чек-листом для создания хорошей документации.

Фактор №1: структурированность

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

Найти что-то конкретное в подобной документации – ещё та задача, которая займёт много времени и совсем не порадует пользователя. Минус балл к ценности продукта.

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

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

Совет №1: структурируйте руководство пользователя под задачи пользователя

Поставьте себя на место пользователя и представьте его путь выполнения разных задач в вашей программе что он будет делать в первую очередь, что во вторую и так далее. Используйте этот путь (customer journey) как основу для структуры документации. Для построения customer journey map очень полезно общаться с реальными пользователями и понаблюдать за их работой с вашим продуктом.

Совет №2: нарезайте контент на разделы

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

Совет №3: делайте помощь контекстно-зависимой

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

  • Пример: если вы работаете в нашем продукте для создания пользовательской документации и зайдёте в настройках проекта в раздел «Аннотирование экрана», вы увидите там целый набор опций: стили аннотации, тени, фон, эффекты и так далее. Предположу, что вы можете не знать ничего об аннотации скриншотов вообще. Однако, при нажатии клавиши F1 или кнопки «Помощь» перед вами открывается руководство пользователя именно на том разделе, где рассказано об процессе аннотирования экранов приложения в документации.

Удобно, не правда ли?

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

Фактор №2: многоформатность и доступность

За 20 с лишним лет работы в сфере проектирования и разработки ПО, я регулярно сталкиваюсь с ситуацией, когда справку по продукту тяжело найти или её просто нет в нужном формате – подходящем для распечатки или, наоборот, для работы в контексте продукта.

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

Совет №4: предоставьте пользовательскую документацию в различных форматах

Выложите инструкцию на сайт, интегрируйте её в продукт в виде файла помощи и создайте печатную PDF-версию, чтобы пользователь мог скачать её, переслать коллеге или распечатать.

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

Совет №5: сделайте информацию легко находимой и доступной

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

Фактор №3: качество контента

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

Совет №6: в документации должны быть описаны все элементы интерфейса и все типовые сценарии, с которыми может столкнуться пользователь

Разделы документации должны отвечать на два типа вопросов – «Что я сейчас вижу перед собой?» и «Как мне сделать…». Документация должна описывать и сам продукт, и задачи, которые с его помощью можно решить.
Очень часто разработчики забывают либо первую часть, либо вторую.

Совет №7: не допускайте ошибок и не нарушайте единства стиля

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

Совет №8: руководство должно быть максимально простым и ёмким

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

Совет №9: обязательно визуализируйте информацию

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

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

P.S.

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

Спасибо за внимание и удачи в бизнесе!

Biz360.ru

Чтобы не пропустить интересную для вас статью о малом бизнесе, подпишитесь на наш Telegram-каналстраницу в «ВКонтакте» и канал на «Яндекс.Дзен».

Понравилась статья? Поделить с друзьями:
  • Ибупрофен акос инструкция по применению в таблетках 400мг
  • Замена поролона в диване своими руками пошаговая инструкция
  • Скачать руководство по autocad 2008
  • Руководство по эксплуатации toyota rav4 2014
  • Руководство по эксплуатации подъемников вышек