Как написать руководство пользователя программного обеспечения: полное руководство (включая шаблон)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Почему важно создать руководство пользователя программного обеспечения?

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

1. Улучшенный пользовательский опыт — упрощая пользователям изучение того, как использовать ваше программное обеспечение, и максимизируйте ценность, которую они получают от вашего программного обеспечения, ваши пользователи будут иметь лучший опыт.
2. Уменьшение нагрузки на службу поддержки — предоставляя пользователям возможность самостоятельно решать свои проблемы, вы можете уменьшить нагрузку на свои каналы поддержки. Это особенно верно, если вы объединяете свое руководство пользователя с другими типами вспомогательного контента, такими как база знаний и/или часто задаваемые вопросы (FAQ).

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

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

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

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

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

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

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

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

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

Для примерного шаблона руководства пользователя программного обеспечения вы можете использовать что-то вроде этого…

1. Оглавление — перечислите различные разделы в руководстве пользователя, чтобы пользователи знали, чего ожидать.
2. Введение – объясните цель руководства пользователя вашего программного обеспечения.
3. Системные требования — подробно опишите любые конкретные требования, которые люди должны использовать для использования вашего программного обеспечения, такие как технические характеристики оборудования, операционная система и т. д.
4. Инструкции по установке — описывают, как пользователь может установить программное обеспечение.
5. Обзор пользовательского интерфейса — общий обзор интерфейса.
6. Как использовать определенные функции — создайте раздел для каждой основной функции, который покажет пользователям, как она работает.
7. Часто задаваемые вопросы — охватывают некоторые общие вопросы, которые могут возникнуть у пользователя.
8. Устранение неполадок — поделитесь советом по устранению неполадок.
9. Глоссарий — если ваше программное обеспечение использует определенную терминологию, вы можете добавить глоссарий в конец руководства пользователя вашего программного обеспечения.
10. Контактные данные службы поддержки — объясните, как пользователи могут связаться со службой поддержки, если им потребуется дополнительная помощь. Вы хотите оставить это в конце, чтобы пользователи пытались помочь себе, прежде чем обращаться в службу поддержки.

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

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

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

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

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

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

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

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

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

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

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

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

Heroic Knowledge Base — это программное обеспечение с открытым исходным кодом, которое расширяет аналогичную систему управления контентом (CMS) WordPress с открытым исходным кодом всеми функциями, необходимыми для публикации руководства пользователя программного обеспечения.

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

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

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

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

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

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

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

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

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

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

Поймите, кто ваша аудитория

Если вы хотите создать полезное руководство пользователя, важно знать, для кого вы пишете:

• Откуда приходят ваши пользователи.
• Чего они пытаются добиться с помощью вашего программного обеспечения.
• Какие болевые точки они испытывают.
• Их общий уровень знаний о вашей отрасли и / или любых соответствующих технических областях.
• В какой компании они работают (или являются ли они индивидуальными пользователями).
• И т. д.

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

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

Используйте логическую структуру и организацию

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

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

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

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

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

Пишите просто и последовательно

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

Вот некоторые вещи, которые нужно иметь в виду, чтобы это произошло:

• Не используйте жаргон или запутанные слова — не все ваши пользователи будут иметь одинаковые знания, когда речь идет о вашей отрасли и/или языке вашего продукта, поэтому важно избегать ненужного технического жаргона и запутанной лексики. Вы можете проверить свой контент с помощью таких инструментов, как тест Flesch Reading Ease, чтобы найти проблемы.
• Избегайте пассивного залога — использование пассивного залога может быть особенно запутанным в руководстве пользователя. Например, вместо использования пассивного залога, такого как «Сохранение копии вашего черновика можно сделать, нажав кнопку «Сохранить черновик », лучше использовать активный залог, такой как «Нажмите кнопку « Сохранить черновик» , чтобы сохранить копию вашего черновика». черновик."
• Используйте короткие предложения — разбивайте ваш контент на короткие предложения, чтобы пользователям было легче потреблять и просматривать содержимое вашего руководства пользователя. По возможности избегайте длинных абзацев («стен текста»).
• Сохраняйте последовательность — использование последовательной формулировки и форматирования облегчит пользователям понимание вашего руководства. Например, если вы всегда используете упорядоченный список для перечисления отдельных шагов в определенной задаче, постарайтесь сохранить это форматирование во всем руководстве пользователя.
• Избегайте проблем с грамматикой — убедитесь, что у вас нет грамматических ошибок, которые могут затруднить понимание вашего руководства пользователями. Вы можете проверить это с помощью таких инструментов, как Grammarly и Hemingway.

Включайте изображения и видео там, где это полезно

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

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

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

Например, Slack отлично справляется с аннотированием вводных изображений интерфейса.

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

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

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

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

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

Heroic Knowledge Base — это плагин с открытым исходным кодом, который позволяет вам использовать WordPress CMS для создания собственного руководства пользователя программного обеспечения, которое полностью находится под вашим контролем.

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

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