Создайте эффективное практическое руководство, которое привлечет вашу аудиторию

Как часто коллеги прерывают вас и просят о помощи?

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

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

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

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

Давайте научимся делать практическое руководство.

Прекратите повторять вопросы

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

Попробуйте бесплатно

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

Краткое руководство — это пошаговое руководство по выполнению конкретной задачи.

• Ясно – читатели должны иметь возможность следовать инструкциям. Часто это означает объединение текста с изображениями или видео.
• Привлекательность. Организуйте руководство так, чтобы привлечь внимание читателей и помочь им сэкономить время.
• Соответствующая информация. Предоставьте контекст и варианты использования, которые помогут читателю понять, почему это для него ценно.

Другие важные части базы знаний различаются.

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

Шаг 1. Поймите болевые точки вашей целевой аудитории.

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

Определите их болевые точки

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

• Проводить опросы
• Просматривайте интернет-форумы
• Запрашивайте обратную связь от клиентов

Адаптируйте свое руководство к уровню навыков и точке зрения вашей аудитории.

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

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

Шаг 2. Структурируйте свое руководство

«Просто как 1-2-3» — создавайте пошаговые нумерованные списки и маркированные списки.

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

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

Стена текста? Следующий!

Snagit позволяет более эффективно общаться с помощью визуальных эффектов.

Узнать больше

Следуйте шаблону руководства

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

Например, рассмотрите возможность включения в шаблон введения, позволяющего определить:

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

Рассмотрим вывод в вашем шаблоне:

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

Обязательно ознакомьтесь с готовыми, профессионально разработанными шаблонами Snagit. У нас даже есть категория шаблонов «Шаги», предназначенная для размещения 2–6 шагов на одной странице. Эти шаблоны также можно изменить, добавив дополнительные шаги на большее количество страниц по мере необходимости!

Шаг 3. Напишите пошаговые инструкции.

Создавайте четкие и краткие шаги

Теперь пришло время писать!

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

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

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

Добавить изображения

Я делаю скриншоты или фотографии в режиме реального времени во время выполнения задачи.

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

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

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

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

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

Шаг 4. Добавьте дополнительную информацию и ресурсы.

Включите соответствующие ссылки и ресурсы

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

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

Предоставьте контекст и предысторию

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

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

Аннотируйте и редактируйте снимки экрана с помощью Snagit.

Профессиональные инструменты разметки и мощные функции упрощают создание полезных изображений.

Попробуйте бесплатно

Шаг 5. Проверьте свое практическое руководство

Обеспечьте точность и удобство использования

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

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

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

Этот человек может помочь гарантировать, что ваша документация не только точна, но и проста в использовании:

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

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

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

Вносите изменения на основе отзывов

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

Шаг 6. Опубликуйте и распространите руководство.

Выберите правильную платформу

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

• Если эта документация является внутренней, ее легкость поиска может значительно повысить производительность.
• Если ваше руководство общедоступно, нужно ли его распространять? Например, отправляются ли отделы продаж или менеджеры по работе с клиентами по электронной почте новым клиентам?
• Или, если оно будет размещено на вашем веб-сайте, как его найдет целевая аудитория?
• Если вы планируете широко распространять свое руководство, лучше отправлять онлайн-ссылки, а не использовать PDF-файлы или публиковать его в разных местах. Управляйте руководствами в одном месте, чтобы облегчить обновление и предотвратить распространение устаревших версий.
• Будут ли у некоторых из ваших читателей вопросы, комментарии или советы, которые будут полезны другим? Рассмотрите возможность размещения руководства на платформе со встроенными диалогами, например Screencast.

Оптимизировать для SEO

Если оно будет опубликовано публично, как ваша целевая аудитория найдет ваше руководство?

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

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

Рассмотрите возможность использования инструментов SEO-оптимизации, таких как SEMrush или плагин Yoast для WordPress. Улучшение SEO улучшает способность находить ваш контент, когда это необходимо.

Резюме: лучшие практики написания практического руководства

Используйте простой и прямой язык

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

Включите изображения для пояснения каждого шага.

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

Регулярно обновляйте руководство

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

Важная часть: облегчите себе задачу

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

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

Прекратите повторять вопросы

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

Попробуйте бесплатно