Как создать руководство пользователя: от нуля до героя (полное руководство)

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

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

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

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

Чтобы это произошло, вот все, что мы собираемся осветить:

• Различные типы руководств пользователя
• Где опубликовать руководство пользователя
• Как создать руководство пользователя

Давайте копать!

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

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

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

Вот краткий обзор различных типов руководств пользователя:

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

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

Где опубликовать руководство пользователя

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

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

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

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

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

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

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

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

Чтобы опубликовать свое руководство пользователя в Интернете, вы можете использовать большую часть программного обеспечения документации или базы знаний. Если вам нужен инструмент, который может обрабатывать как общедоступные, так и внутренние руководства пользователя, вы можете рассмотреть плагин Heroic Knowledge Base с открытым исходным кодом для WordPress. Мы поговорим об этом более подробно в учебнике.

Вот пример онлайн-руководства пользователя из базы знаний Heroic (и о базе знаний Heroic):

Говоря об учебнике…

Как создать руководство пользователя за шесть шагов

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

1. Создайте свой профиль пользователя

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

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

Почему это важно?

Ну вот например:

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

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

2. Определите ключевую проблему (проблемы) и цель (цели)

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

То есть, какова конечная цель (или конечные цели) людей, которые будут читать это руководство?

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

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

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

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

3. Создайте логическую структуру и иерархию

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

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

Вот несколько советов, которые помогут вам сделать это:

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

4. Напишите содержимое руководства пользователя

После того, как вы наметили свой контент, вы готовы начать писать.

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

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

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

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

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

5. Опубликуйте руководство пользователя

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

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

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

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

Например, с плагином Heroic Knowledge Base WordPress вы можете опубликовать свое руководство пользователя, используя программное обеспечение WordPress с открытым исходным кодом.

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

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

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

6. Обновляйте и пересматривайте руководство пользователя по мере необходимости.

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

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

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

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

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

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

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

Вы также можете отсутствовать статьи по темам, с которыми у пользователей возникают проблемы. Чтобы помочь вам найти эти отсутствующие темы, база знаний Heroic также включает встроенную аналитику поиска, чтобы вы могли отслеживать, какие поисковые запросы не имеют результатов по темам ( а также общие поисковые запросы в целом ):

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

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

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

Для простого способа опубликовать свое руководство пользователя в Интернете и помочь своим клиентам ориентироваться в нем, вы можете использовать WordPress и плагин Heroic Knowledge Base.

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

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

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