8 рекомендаций и советов по созданию инструкций

  • топ
Загрузите текст

Перетащите файл илиЗагрузите документ

Поддерживаются форматы: txt, docs, doc, rtf, odt, pdf

Максимальный размер: 20 МБ

Укажите нужный процент уникальности
60%
Выберите систему обработки
Загрузите текст

Перетащите файл илиЗагрузите документ

Поддерживаются форматы: txt, docs, doc, rtf, odt, pdf

Максимальный размер: 20 МБ

Укажите нужный процент уникальности
60%

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

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

Для хорошей инструкции характерны следующие характеристики:

  1. четкий алгоритм. Действия пользователя описаны пошагово. Детальность материала зависит от экспертности. Чем лучше человек разбирается в том, о чем идет речь, тем короче гайд;
  2. конкретный результат. Следуя инструкции, пользователь должен достичь цели. Если результата нет, значит, гайд составлен неправильно.

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

Виды руководств

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

  • по сборке или строительству;
  • применению (в частности, медицинских препаратов);
  • приготовлению блюд (рецепты).

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

Рекомендации по написанию инструкции

  1. Учитываем степень осведомленности читателя

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

  2. Предлагаем только конкретику, без воды

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

  3. Выбираем стиль изложения

    Стиль зависит от целевой аудитории, Tone of Voice компании и тематики. Например, в гайды для подростков-геймеров можно добавлять молодежный сленг и юмор, для разработчиков игр ― профессиональную терминологию.

  4. Добавляем иллюстрации

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

    Варианты иллюстраций:

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

    • видео. Сделайте скринкаст или пригласите эксперта, который обо всем подробно расскажет.

    • gif-анимация. Этот способ хорошо работает, когда нужно показать процесс, например, как делать упражнение или перетащить иконку приложения с одного места на другое.

  5. Даем экспертные рекомендации

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

  6. Соблюдаем последовательность

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

  7. Составляем структуру

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

  8. Вычитываем гайд

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

Заключение

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

Оцените статью

Оценка

5

из

5

Всего голосов: 7784

Антиплагиат:

Интересно: