Простое пошаговое руководство¶
Итак, вы наконец решили написать новое руководство пользователя о вашем замечательном продукте.
В 2021 году создание руководства пользователя остаётся преимущественно ручным процессом. Вы выбираете наиболее подходящее приложение и начинаете формировать содержание.
Как начать, зачем начинать, почему вообще нужно руководство пользователя? Я попытаюсь ответить на распространённые вопросы о создании руководств и помочь вам создать ваше первое руководство в Docsie, хотя вы можете использовать любой другой инструмент.
.png)
Причины и преимущества создания руководства пользователя¶
Существует множество причин для создания руководств пользователя. Они чрезвычайно полезны и играют важную роль в мире потребителей, электроники, программного обеспечения и всех видов материальных и нематериальных продуктов. Руководства предоставляют пользователям простые пошаговые инструкции по использованию и/или сборке продуктов.
Ваши клиенты должны получать информацию о продуктах, которые вы продаете, услугах, которые вы предоставляете, или методах и процедурах, которым они должны следовать. Руководства предлагают пошаговый процесс, с помощью которого клиенты могут научиться использовать и изучить различные функции вашего продукта.
Правильные руководства пользователя ограничивают юридическую ответственность:¶
Руководства также ограничивают ответственность за неправильное использование продуктов. Руководство особенно полезно для продуктов, которые могут привести к травмам или даже смерти при неправильном использовании или сборке. Например: устройства высокого напряжения, устройства, генерирующие огонь, и даже лазеры требуют подробных инструкций для защиты клиента от неправильного использования.
Качественные руководства экономят время:¶
Хорошие руководства содержат инструкции по использованию продуктов, что экономит время вашей технической команде на объяснениях и команде продаж на демонстрациях. Сложные программные продукты требуют хороших технических руководств, чтобы помочь клиентам научиться использовать их с максимальной эффективностью. Программное обеспечение обычно насыщено функциями, и наличие правильного количества руководств, обеспечивающих клиентов полезной информацией, помогает в долгосрочной перспективе удерживать клиентов и экономить время на объяснении различных аспектов программного обеспечения и сложных продуктов.
Обучение клиентов использованию ваших продуктов:¶
Обучение клиентов работе с техническими продуктами очень важно. Без надлежащих руководств ваши клиенты могут запутаться в множестве скрытых функций и не знать, как использовать весь потенциал технического продукта. Руководства обеспечивают простой процесс, с помощью которого клиенты могут научиться взаимодействовать с различными техническими аспектами вашего продукта и чувствовать себя комфортно, имея под рукой руководство, когда им нужно глубже изучить ваши продукты. Это избавит их от стресса при попытке разобраться в продукте без формальных письменных указаний. Также для опасных в использовании продуктов руководства могут содержать предупреждения против неправильного использования продуктов опасным образом.
Что делает руководство пользователя отличным¶
Чтобы начать создание руководства, вам нужно понять, какую проблему вы пытаетесь решить для конкретного клиента. Создание руководства обо всём на свете превращает его в непонятную путаницу, которую никто не поймёт, включая целевую аудиторию. Если вы посмотрите на лучшие примеры руководств пользователя в интернете, написанные выдающимися компаниями, такими как Stripe или Slack, вы заметите определённую закономерность.
Каждое руководство фокусируется на решении конкретной проблемы.
Что должно делать каждое руководство? Оно должно концентрироваться на простых действиях, которые пользователь может выполнить, следуя этому руководству. Нет необходимости в усложнении. Наоборот, если вы сосредоточитесь на описании распространённых простых действий, которые помогают вашим пользователям решать типичные проблемы с вашим продуктом, у вас получится набор отличных руководств, которые понравятся вашим клиентам.
Давайте внимательно изучим несколько руководств пользователя, чтобы понять структуру отличного руководства, и использовать это как ориентир для написания своего собственного.
Что входит в отличное руководство пользователя?¶
Давайте посмотрим на руководство по управлению книгой выше и определим несколько пунктов
Организация ваших руководств пользователя¶
Использование Docsie для создания руководств пользователя
Docsie предлагает различные инструменты и функции, которые позволяют создавать отличные руководства пользователя. Сначала давайте посмотрим, как работает Docsie. Docsie работает по принципу книг, полок и коллекций.
Коллекции используются для выделения различных книг, которые вы хотите показать разным типам клиентов. Например, эта коллекция используется только для бизнес-пользователей. Это означает, что мы выбрали только 3 книги из всех созданных, чтобы показать их этим конкретным клиентам.
Это полезно, когда у вас есть различные типы клиентов, использующих разные уровни ваших продуктов. В Docsie это делается легко: нужно нажать на три точки рядом с "All" и нажать "add".
Попав в панель инструментов коллекций Docsie, вы можете создать название коллекции и выбрать, какие руководства пользователя включить в эту конкретную коллекцию. Это важно, потому что разным клиентам могут понадобиться разные руководства по вашим продуктам, и этот инструмент позволяет показывать только те руководства, которые им нужно видеть.
Теперь давайте начнем писать ваше первое руководство пользователя с Docsie, это делается с помощью "Книги" Docsie.
Думайте о книге как о вашем руководстве пользователя. В открытой книге вы увидите редактор, место для создания "Статей" и заголовков.
Редактор сверху, возможность создавать различные версии и языки в верхнем левом углу, и, конечно, разделы "Статьи и подзаголовки" слева.
Редактор прост в использовании, он позволяет добавлять видео, изображения и код с помощью простого процесса перетаскивания. Также он позволяет стилизовать ваш контент по своему усмотрению.
Создавать статьи очень просто: просто введите заголовок. В данном случае тип - "Что такое Docsie", но вы можете ввести любой заголовок для вашего руководства пользователя.
Чтобы создать подразделы в ваших руководствах, которые будут отображаться как 1.1, 1.2 и т.д., всё, что вам нужно сделать, - это выбрать расположение вашего текста и установить текст как "Заголовок", нажав на Н в панели редактора.
Docsie также позволяет создавать различные версии и языки ваших руководств пользователя. Это очень удобно для локализации и для описания различных версий руководств по вашему продукту.
После того, как вы подготовили руководства, написали их, оформили фотографиями, которые помогли объяснить различные аспекты ваших продуктов и функций, следующим шагом является публикация.
Подводя итоги: советы и хитрости для создания руководства пользователя¶
Большинство программных и технических продуктов очень сложны и многогранны. Чтобы решить эту проблему при создании руководства для сложных продуктов, хорошей идеей будет разбить информацию и инструкции на более мелкие части. По сути, создавать различные небольшие руководства и объединять их в единый комплекс руководств.
Ваши клиенты не знакомы с вашим продуктом и/или услугой. Чем технически сложнее ваш продукт, тем более подробными должны быть ваши руководства на этапе создания. Расплывчатые слова и фразеология не будут вашими друзьями в этом процессе. Будьте максимально конкретны, чтобы ваш клиент мог понять даже самые простые аспекты вашего продукта.
Изображение стоит больше, чем тысяча слов. Это особенно верно для руководств пользователя. Этот шаг часто игнорируется большинством компаний, но наличие правильных фотографий или снимков экрана функций и аспектов вашего продукта при их объяснении в руководствах очень важно. Таким образом, ваш клиент сможет понять, о каких аспектах вашего продукта идет речь.
Ваши руководства предназначены для того, чтобы помочь клиентам понять различные способы использования ваших продуктов. Объясняйте вещи как можно проще, чтобы они могли легко понять различные функции и аспекты.