Инструкция пошаговое руководство это

Как написать статью-инструкцию или пошаговое руководство

author__photo

Как написать статью-инструкцию или пошаговое руководство

Содержание

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

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

Где использовать статьи-инструкции

Пошаговые руководства и инструкции всегда остаются востребованными. К ним обращаются, чтобы решить вопросы, связанные с обустройством дома или карьерой, здоровьем, увлечениями, спортом. Неудивительно, что ролики на YouTube и статьи с заголовками, которые начинаются со слов «как сделать…», — в разы популярнее многих других видов контента.

Пошаговые руководства публикуются:

  • на информационных сайтах;
  • в блогах и на коммерческих площадках;
  • на форумах и в социальных сетях.

Правила написания

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

  • Правильно выбирайте ЦА. Ответьте на вопрос: кто будет читать пошаговое руководство? Гайд для новичков — это одно. Инструкция для тех, кто уже разбирается в теме и хочет прокачать скилы, — совсем другое.

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

  • Досконально разбирайтесь в вопросе. Гайды пишут эксперты или копирайтеры. 

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

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

  • Составляйте план будущего руководства. Основа любой инструкции — хорошо продуманные тезисы. 

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

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

  • Перечитывайте готовый текст несколько раз и убирайте «воду». У человека, который читает гайд, нет времени искать нужную информацию среди «каждому известно» и «актуальность проблемы трудно переоценить».

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

Убирайте из инструкции канцеляризмы, штампы и стоп-слова — читатели не дочитывают такие статьи до конца. Проверяйте тексты на «воду» в таких сервисах, как «Адвего», Istio.com и Text.ru. Норма — 55–75%, но она может варьироваться в зависимости от тематики.

  • Добавляйте картинки и примеры. Гайд без визуального сопровождения — это не гайд.

Добавляйте в текст скриншоты или фотографии, GIF-анимацию и инфографику с диаграммами, блоками и схемами. Они сокращают объем руководства, структурируют информацию, делают ее нагляднее.

Берите на заметку бесплатные сервисы для создания инфографики: Сanva, Easel.ly, Piktochart, Venngage. И еще несколько ресурсов для создания GIF-анимации: Gifovina, Gifs (создает анимацию из видео на YouTube) и Online-convert.

Алгоритм написания

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

Шаг 1. Подготовка и сбор информации

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

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

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

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

caltouch-platform

Технология
речевой аналитики
Calltouch Predict

  • Автотегирование звонков
  • Текстовая расшифровка записей разговоров

Узнать подробнее

platform

Шаг 2. Структурирование 

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

Введение должно состоять из 2–4 предложений. Используйте его, чтобы быстро ввести читателя в контекст и вызвать у него доверие и интерес. Если тема позволяет, поделитесь любопытным фактом или статистикой, если нет — коротко опишите проблему и переходите к ее решению.

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

Заключение — итоги статьи. Сделайте эту часть полезной для читателя. Составьте памятку с краткими выводами, по которым удобно делать то, о чем было подробно рассказано в основной части вашего руководства. Для этого перечислите 5–7 основных тезисов или сделайте выжимку рекомендаций по типу той, которая будет в конце этой статьи.

Заголовок (H1) должен быть коротким, но емким. Вот несколько примеров, которые можно взять на заметку:

  • «Краткая/полная/пошаговая инструкция…»;
  • «Создайте…с нуля»;
  • «Простой/уникальный способ…»;
  • «Как сделать/приготовить/создать…»;
  • «Быстрое решение…»;
  • «8 шагов для…»;
  • «Метод…»;
  • «Секрет правильного…».

Внутренние подзаголовки (H2, H3…) разделяют информацию на блоки или являются этапами пошаговой инструкции — это зависит от объема текста.

Шаг 3. Написание текста

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

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

Шаг 4. Завершение

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

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

caltouch-platform

Сквозная аналитика Calltouch

  • Анализируйте воронку продаж от показов до денег в кассе
  • Автоматический сбор данных, удобные отчеты и бесплатные интеграции

Узнать подробнее

platform

Вместо вывода

  • Если вы хотите написать гайд, но не знаете, какую тему выбрать, проанализируйте статьи конкурентов, соберите популярные поисковые запросы в Wordstat. Подумайте, о чем было бы интересно узнать вашей ЦА.
  • Начинайте составлять статью-инструкцию с постановки цели. Определитесь, для кого и для чего предназначено пошаговое руководство. Если хотите, чтобы вашу статью с интересом читали до конца, не перегружайте ее терминологией.
  • Если пишете инструкцию для новичков, то не пропускайте шаги, которые кажутся слишком простыми. Пусть лучше читатель сам пропустит очевидный для себя этап, чем не узнает, что это действие было необходимо выполнить для достижения результата. 
  • Пишите емко, избегайте длинных конструкций и воды. Дополняйте текст инфографикой, скриншотами и тематическими иллюстрациями.

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

инструкции для сотрудников

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

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

3 основных вида инструкций

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

Пошаговая инструкция

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

Пошаговое руководство

Вот как может выглядеть краткое пошаговое руководство по замене картриджа в лазерном принтере Brother HL-1110R:

  1. Откройте верхнюю крышку и извлеките блок фотобарабана
  2. Установите в нижнее положение переключатель в правом нижнем углу блока фотобарабана
  3. Вытащите тонер-картридж
  4. Поставьте на его место новый
  5. Подвигайте в разные стороны зеленую лапку в левом верхнем углу фотобарабана. Обязательно верните ее в исходное положение
  6. Установите фотобарабан обратно в принтер
  7. Закройте крышку
  8. Сделайте пробную печать. Если появляется сообщение «Замените тонер», значит фотобарабан установлен неправильно, и шаги 1-7 нужно проделать заново. Если неисправность не исчезает обратитесь к системному администратору

Инструкция по использованию

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

инструкция по использованию

В отличие от пошагового алгоритма, акцент делается не на достижении определенного результата, а на особенностях применения. Например, вот как можно кратко написать инструкцию по использованию ламинатора Rayson LM 330iD:

  • В зависимости от толщины пленки устанавливают необходимую температуру. Например, для 75 mic нужно 100-120°C, а для 250 mic 160-180°C.
  • Максимальное время работы ламинатора 4 часа. Затем нужно сделать получасовой перерыв.
  • Если внутри ламинатора застрял документ, нажмите кнопку «Реверс» и извлеките его. 
  • Внимание! Не ламинируйте влажные образцы жидкость может повредить электронные компоненты!
  • После ламинирования 10-15 листов, нужно очистить аппарат от клейкого материала. Для этого ламинатор отключают от сети и протирают валы тканью с моющим средством. 
  • Внимание! Не используйте для очистки бензин и растворители – это приводит к возгоранию! 

Должностная инструкция

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

Должностная инструкция

Вот как может выглядеть раздел обязанностей для грузчика ООО «Дельта»:

  1. Работник обязан выполнять погрузочно-разгрузочные работы на территории склада Организации
  2. При работе он может пользоваться спецтехникой (электрокаром) если у него есть необходимые допуски
  3. Бригадир раздает списки, по которым комплектуются грузы. 
  4. Отобранный товар кладут на паллету и закрепляют соблюдая технику безопасности при перевозке грузов
  5. Если есть необходимость, грузчик может привлекаться к другим работам на территории склада уборке, контролю за въездом транспорта и пр.

Должностная инструкция – это скорее юридический документ, чем пользовательский. А чтобы понятным языком проинструктировать сотрудника по его работе, обычно составляют отдельное обучение – «Пособие по должности». В нем подробно рассказывают о роли и ценном конечном продукте, описывают систему мотивации, метрики и алгоритмы выполнения работы. И размещают эти материалы на платформе для онлайн-обучения.

Ниже вы можете получить готовую структуру обучения для курса «Пособие по должности».

Общие правила при подготовке инструкций

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

  • Определите уровень подготовленности аудитории. В зависимости от опыта читателей, меняется стиль подачи и структура текста. Пишите на понятном для них языке
  • Не жалейте времени на сбор и обработку информации. Автор должен разбираться в предмете изложения – выступать экспертом или внимательно изучить необходимую документацию. Если первоначальной компетентности недостаточно, нужно проконсультироваться со специалистом
  • Определите исходные данные и результат. Например, «на входе» есть решение руководства о новых правилах доступа в здание, а «на выходе» должно получиться руководство по пользованию электронным пропуском
  • Структурируйте информацию исходя из типа документа. Так, для пошагового алгоритма нужно разбить процедуру на несколько этапов. А должностная инструкция подразумевает серию отдельных описаний с обязанностями. В зависимости от типа меняется и форма подачи
    Как структурировать много данных →
  • Предупреждайте о проблемах, с которыми может столкнуться человек. В первую очередь это касается ситуаций, опасных для жизни и здоровья. Разместите надписи с предостережениями, которые будут выделяться ярким цветом или более крупным размером шрифта

Алгоритм разработки руководства: 9 шагов

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

  1. Собрать информацию
  2. Сгруппировать ее по отдельным этапам
  3. Изложить последовательность выполнения каждого этапа с учетом уровня подготовки читателя

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

Шаг 1. Изучить ситуацию

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

Шаг 2. Разложить все на отдельные этапы

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

  1. Запустить программу Microsoft Word
  2. Создать новый документ
  3. Набрать необходимый текст
  4. Отформатировать его 
  5. Сохранить файл
  6. Сообщить в бухгалтерию, что заявление подготовлено 

Шаг 3. Описать каждый этап

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

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

2. Нажмите на раздел «Новый документ» в правой части экрана 

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

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

Шаг 4. Рассмотреть нестандартные варианты развития ситуации

Стараясь предусмотреть форс-мажорные обстоятельства, улучшите свой алгоритм, предлагая варианты решения. Например:

3. <…> Если печатаются латинские символы, поменяйте раскладку. Для этого одновременно нажмите клавиши «Shift» и «Ctrl» в левой нижней части клавиатуры 

Шаг 5. Подобрать изображения и привести примеры

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

Шаг 6. Придумать заголовок

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

  • «Как написать инструкцию по подготовке заявления»
  • «6 шагов для подготовки электронного документа»
  • «Простой способ написать заявление на компьютере»
  • «Подробный алгоритм подготовки документа для безбумажного оборота»

Шаг 7. Оценить промежуточный вариант

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

Как написать простую инструкцию (образец): 

  1. Запустите программу Microsoft Word
  2. Нажмите на раздел «Новый документ» в правой части экрана 
  3. Наберите необходимый текст в открывшемся окне. Образец приведен ниже.
  4. Отформатируйте набранный текст с помощью верхней панели программы Word.
    • Сначала Выделите шапку заявления (адресата и составителя заявления). Нажмите на кнопку «Выравнивание по правому краю» на верхней панели программы Word. Строки переместятся вправо
    • Аналогичным способом отформатируйте заголовок (используем кнопку «Выравнивание по центру»)
    • Выделите список спецодежды и примените к нему функцию «Маркированный список» 
  1. Сохраните файл. Для этого:
    • Нажмите сочетание клавиш «Ctrl+S» или на иконку дискеты в левом верхнем углу
    • Выберите путь сохранения файла
    • В строке «Имя файла» удалите текущее содержимое и напишите: «Заявление от …». Вместо многоточия укажите фамилию, инициалы заявителя и дату, например «Заявление от Иванова В.И. 27.03.2022»
    • Нажмите кнопку «Сохранить»
  2. Сообщите в бухгалтерию (внутренний телефон: 2-31) или секретарю зам. директора по персоналу (т.: 2-42), что заявление подготовлено. 

Пример объявления, на который можете ориентироваться при подготовке:

Шаг 8. Тестирование

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

Проверьте алгоритм с помощью этих вопросов:

  • Понятен ли указанный порядок действий? Да, мы улучшали его в шагах 2-5
  • Все ли нюансы учтены? Да, последовательность шагов охватывает всю необходимую процедуру
  • Есть ли в алгоритме сложные этапы, которые можно разбить на несколько частей? Нет, все они были скорректированы на предыдущих шагах
  • Достигнут ли результат? Будет ли он неизменным при разных условиях использования алгоритма? Да, на выходе мы получаем файл для безбумажного оборота. При правильном следовании приведенной последовательности, результата можно достичь вне зависимости от того, кто составляет заявление – грузчик или уборщица

Шаг 9. Обучить сотрудников по инструкции

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

Особенности такого обучения:

  • Информация сопровождается рисунками, схемами, анимацией, формами обратной связи – это увлекательнее, чем простое чтение текста
  • В режиме реального времени руководитель может видеть, какое количество материала уже изучено
  • В конце разделов и всего курса предусмотрены контрольные вопросы. Процент правильных ответов для успешного прохождения курса можно задавать самостоятельно (обычно он составляет 80%)

Примеры готовых инструкций

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

Вывод

Резюмируя все изложенное, можно составить требования к идеальной инструкции:

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

Вам будет интересно

тестирование

Как создать онлайн тест: подробное руководство

План обучения менеджера по продажам

Оценка эффективности обучения персонала: проверенный алгоритм

Перейти на главную блога

Мой Телеграм

Мы живем в век, когда люди хотят сбросить 20 кг за месяц и выучить английский методом 25-го кадра за неделю. И уж наверняка никто не готов читать многотомные пособия, чтобы выполнить какую-то бытовую задачу или профессиональную обязанность. Поэтому умение составлять краткие и понятные гайды – самый ценный навык копирайтера, руководителя и педагога. Давайте же подробно рассмотрим, как правильно написать инструкцию, чтобы ее читали, выполняли и даже распространяли в социальных сетях и сохраняли в закладках.

Как написать инструкцию, правила

Этап №1. Как подготовиться к написанию инструкции

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

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

  • Рецепт – гайд по приготовлению блюд и лакомств.
  • Мастер-класс – пошаговое руководство с картинками, которое раскрывает секрет изготовления изделий ручной работы, установки техники и выполнения строительных, ремонтных работ.
  • Рекомендации по выходу из сложных ситуаций.
  • Руководство по эксплуатации.
  • Должностная инструкция.
  • Модные гайды по подбору и сочетанию одежды.

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

Как написать руководство или инструкцию правильно

Этап №2. Как правильно писать инструкцию

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

  • Краткость – главная ценность инструкции. Не стремитесь украшать текст метафорами и деепричастными оборотами: сокращайте текст до смысла. Позволить себе лирические отступления можно только в виде шутки или примечания о распространенных ошибках.
  • Последовательность. Начинайте с… начала. Удивительно, но многие почему-то начинают писать инструкцию едва ли не с середины. Например, так: «в папке «Мои документы» откройте файл…» – учитывайте, что пользователь с минимальным уровнем знаний наверняка не знает, где искать ту самую папку. Объясните, где она находится.
  • Не допускайте пропуска шагов. Некоторые авторы явно думают, как написать инструкцию для себя, а не для кого-то – они пропускают легкие (на их взгляд) шаги, из-за чего у читателя возникает легкая растерянность, а иногда и ошибки в выполнении задачи. Не пропускайте даже малейших деталей!
  • И еще раз о терминологии. Если обойтись без нее нельзя, напишите приложение к инструкции – словарь. Либо поясняйте их прямо по тексту.
  • Не лейте воду. Пошаговое руководство – именно тот жанр, где не требуется долгих лирических вступлений и разглагольствований на тему «всем известно, что» или «а в Древнем Риме было так» – в двух предложениях поясните смысл или повод для написания инструкции и сразу же переходите к делу.
  • Наглядность. Основная цель статьи-инструкции – помочь человеку справиться с какой-либо задачей. Поэтому инфографика здесь играет особую роль. Желательно проиллюстрировать каждый шаг скриншотами или картинками, вырезанными из видео. Неплохим приложением станет и качественный ролик из YouTube, который легко внедряется на любой сайт.
  • Предостерегайте. Если вы знаете, что на каком-то шаге выполнения люди часто делают ошибки – сделайте сноску с предупреждением о возможных ошибках.

В большинстве случаев, когда хотят написать инструкцию, пример берут с популярных ресурсов – Яндекс. Справка, Мануал. База и других. Но важно учесть и тот факт, что этот формат не всегда подходит. Например, подросткам тяжело продираться сквозь дебри наставлений. Для такой аудитории лучше использовать разговорный или публицистический стиль. Не стремитесь «содрать» материал – пишите свой материал в соответствии с требованиями вашего потенциального читателя.

Руководство, инструкция, как писать, как правильно написать руководство, инструкцию

Немного о логической структуре инструкций

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

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

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

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

Как написать пошаговую инструкцию

Этап №3. Проверка инструкций: читабельность, доступность и фактчекинг

Знание вопроса – важный аспект написания инструкций. Но профессионалы нередко грешат обилием терминов, чрезмерно сложным описанием процесса и «чеканной», будто бы отрепетированной речью. И даже если вы внимательно прочитали выше, как написать пошаговую инструкцию, учли все пункты и нюансы, проверить себя все же нужно. И для этого лучше всего использовать технику 3 ролей или найти 3 реальных людей, которые дадут вам свой отзыв:

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

Руководство, инструкция, как писать, как написать

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

Инструкция – справочный документ, где собраны правила эксплуатации товара. Это может быть руководство пользователя бытовой техники, указания к применению лекарственного препарата, статья в разделе FAQ или текст на пачке риса. Продавец обязан предоставить покупателю информацию о товаре согласно статье 10 закона России «О защите прав потребителей».

Написать понятную инструкцию – рассказать о технически сложном товаре простым языком, без потери смысла.

Виды инструкций

По содержанию инструкции бывают:

  1. Описательные. Цель описательной инструкции – познакомить покупателя с товаром: рассказать о полезных функциях смартфона, возможностях сервиса, материалах оконного профиля или применении битумной мастики.

Пример:

«Фалевая защелка – часть дверного замка для максимального прилегания полотна к коробке в закрытом положении».

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

Пример:

«Включите стиральную машину с помощью кнопки СТАРТ.

Удерживайте кнопку таймера «5» до появления индикации «3h» на диалоговом окне».

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

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

Как написать понятную инструкцию Как написать понятную инструкцию

Еще инструкции разделяются по формату:

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

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

Как написать понятную инструкцию

Продвинем ваш бизнес

В Google и «Яндексе», соцсетях, рассылках, на видеоплатформах, у блогеров

Подробнее

Продвинем ваш бизнес

Правила составления текстовых инструкций

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

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

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

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

Структура

Типовая инструкция включает следующие разделы:

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

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

Как написать понятную инструкцию

Спасибо!

Ваша заявка принята.
Мы свяжемся с вами в ближайшее время.

122 статьи по контент-маркетингу: императорская подборка полезностей

122 статьи по контент-маркетингу: императорская подборка полезностей

Оформление текста

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

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

Примеры:

Плохо

Хорошо

Для этого необходимо перейти в режим записи видео.

Перейдите в режим записи видео.

Ламинированное покрытие нужно протирать обычными моющими средствами.

Протирайте ламинированное покрытие обычными моющими средствами.

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

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

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

Примеры:

Плохо

Хорошо

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

Эта надпись говорит о поломке механизма.

Сбор данных скорее всего займет 10 минут.

Сбор данных займет 10 минут.

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

Примеры:

Плохо

Хорошо

Удерживайте кнопку «Пуск» до появления желтой индикации на экране. Затем выберите в меню режим «Блок».

  1. Удерживайте кнопку «Пуск» до появления желтой индикации на экране.
  2. Выберите в меню режим «Блок».

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

Для регулировки створки вам понадобятся:

  • шестигранник;
  • шлицевая отвертка;
  • монтажный клин.

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

Примеры:

Плохо

Хорошо

  1. Закрепите радиатор на стене.
  2. От правого края батареи отмерьте 10 см для установки воздуховода.
  1. Закрепите радиатор на стене.
  2. От правого края радиатора отмерьте 10 см для установки воздуховода.

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

Плохо

Хорошо

Номинальная мощность микроволновки – 700 Вт.

Номинальная мощность микроволновой печи – 700 Вт.

Граната автомобиля передает крутящий момент на ось колеса.

Шарнир равных угловых скоростей (ШРУС) автомобиля передает крутящий момент на ось колеса.

Подберите читаемый шрифт текста. Шрифты с засечками (Times New Roman, Georgia) имеют небольшие черточки по краям линий. Они подходят для объемных печатных документов в 12 размере. Шрифты без засечек (Arial, Verdana) хорошо читаются на электронных документах.

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

Примеры шрифтов:

С засечками

Без засечек

Допустимое напряжение в сети от 215 до 230 Вольт.

Допустимое напряжение в сети от 215 до 230 Вольт.

Иллюстрации

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

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

Как я стала писать для «Текстерры»: история бывшего копирайтера

Как я стала писать для «Текстерры»: история бывшего копирайтера

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

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

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

TL;DR

  • Пошаговое руководство – это ресурс, созданный для того, чтобы любой сотрудник или клиент мог следовать ему и выполнять необходимые задачи. В нем изложен и описан каждый шаг для успешного выполнения процесса.
  • Создание пошаговых руководств необходимо для любого масштабируемого бизнеса. Она способствует обмену знаниями (предоставляя пользователям быстрый доступ к информации), уменьшает количество человеческих ошибок и снижает эксплуатационные расходы.
  • Хорошее пошаговое руководство должно быть легко понятным для любого человека, должно определять четкие хронологические шаги для завершения процесса, и должно включать дополнительные форматы, такие как видео и визуальные материалы, дополняющие руководство.
  • Существует четыре шага для документирования и использования ваших процессов:
  1. Вместе с командой определите процессы, которые должны быть задокументированы, и создайте черновой вариант.
  2. Изучите свою целевую аудиторию и составьте точный портрет человека, который будет читать руководство (будь то сотрудники или клиенты).
  3. Составьте план и напишите свое руководство. Добавляйте как можно больше деталей.
  4. Добавьте контрольные списки в свои руководства и перечислите каждую задачу в хронологическом порядке.
  • Вот несколько советов по созданию пошаговых инструкций:
  1. Создавайте интерактивные маршруты, в которых каждый новый шаг запускается после того, как пользователь завершил предыдущий.
  2. Вставьте пошаговые руководства в ресурсный центр , чтобы пользователи могли вернуться к ним в любое время, когда они им понадобятся.
  3. Структурируйте свои руководства и создавайте путеводители, чтобы пользователи могли прочитать только часть статьи, чтобы найти нужную информацию.
  4. Используйте искусственный интеллект для создания и вставки видео в руководства в приложении, просто набрав текст. Интеграция между Synthesia и Userpilot делает это возможным!
  5. Внедряйте локализацию и предлагайте руководство на нескольких языках, чтобы облегчить понимание и воспроизведение ваших инструкций для тех, кто не является носителем английского языка.
  6. Собирайте отзывы ваших учеников и улучшайте свои руководства, основываясь на мнениях пользователей.
  7. Регулярно обновляйте свои инструкции и поддерживайте документацию в актуальном состоянии.
  • Вот три инструмента, которые вы можете использовать, чтобы сделать пошаговые руководства менее трудоемкими:
  1. Userpilot – это инструмент для успешной работы с клиентами, который поможет вам направлять пользователей с помощью таких моделей пользовательского интерфейса, как модалы, всплывающие подсказки, интерактивные проходы и так далее. Кроме того, вы можете создать свою базу знаний и персонализировать ее содержимое на основе сегментов пользователей.
  2. Scribe – это приложение, которое может записывать ваш экран при выполнении задачи и мгновенно создавать руководство со скриншотами и подробными инструкциями.
  3. Loom – это приложение для асинхронного общения и записи видеоуроков, которые вы можете использовать для дополнения документации по процессу (а также для совместной работы с коллегами).

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

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

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

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

Его основные преимущества включают:

Улучшенный обмен знаниями

По данным McKinsey, сотрудники тратят 20% своей рабочей недели на поиск информации о задаче.

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

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

Предотвращение человеческих ошибок

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

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

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

Снижение эксплуатационных расходов

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

Ключевые особенности и элементы эффективных пошаговых руководств

Итак, что же в первую очередь делает хороший путеводитель? Вот на что вам следует обратить внимание:

Простой для понимания язык и инструкции

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

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

Четко определенные хронологические этапы

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

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

пошаговое руководство по введению в должность пример контрольного списка userpilot

Создайте контрольные списки для регистрации в Userpilot.

Визуальный контент и примеры

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

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

Видеоуроки Loom – отличный пример, поскольку это очень короткие видео, объясняющие пользователю конкретные задачи, которые можно найти прямо в приложении (не нужно выходить).

видеоуроки по ткацкому станку примеры пошаговых руководств

Видеоуроки Loom.

Как документировать любой процесс с помощью пошаговых руководств

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

1. Определите, какие процессы вы документируете

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

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

Затем составьте черновой вариант задания, включив в него следующее:

  • Название задания
  • Цель
  • Результаты
  • Определение понятия “сделано”

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

2. Определите персоны пользователей и поймите свою целевую аудиторию

Вы не можете объяснить что-то, не зная, с кем вы говорите.

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

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

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

Возьмем в качестве примера персону менеджера по маркетингу продукта:

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

Пример персоны менеджера по маркетингу продукта.

3. Опишите каждый этап процесса и напишите содержание

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

Сначала сделайте набросок ресурса, который вы создаете.

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

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

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

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

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

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

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

Совет: Лучшая практика UX-дизайна – добавление индикатора выполнения и фиктивных задач (уже вычеркнутые шаги), чтобы пользователь чувствовал, что он достиг прогресса. Это работает, потому что – согласно эффекту Зейгарник – наш мозг запоминает незавершенные задачи, что дает нам большую мотивацию закончить то, что мы уже начали.

контрольный список-технология-принятие-кривая

Советы по созданию эффективных пошаговых руководств

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

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

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

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

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

interactive-walkthrough-step-by-step-guides

Интерактивное прохождение Kommunicate, созданное с помощью Userpilot.

Встраивайте пошаговые руководства в свой ресурсный центр

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

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

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

пошаговые руководства база знаний пример userpilot

Пример базы знаний в приложении на Userpilot.

Поддерживайте хорошо структурированное руководство, в котором легко ориентироваться

Легко опубликовать много руководств и забыть об их организации.

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

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

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

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

пошаговые руководства структура пример асаны

Как Asana структурирует свои руководства.

Используйте искусственный интеллект для создания и встраивания видео в руководства в приложении

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

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

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

synthesia-automatic-video-creation-step-by-step-guides

Предлагайте руководство на нескольких языках

Как международная SaaS-компания, вы, вероятно, имеете клиентов со всего мира.

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

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

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

SaaS-localization-step-by-step-guides

Userpilot позволяет локализовать ваши руководства одним щелчком мыши.

Собирайте отзывы своих учеников и улучшайте свои руководства

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

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

userpilot-feedback-survey-step-by-step-guides

Создавайте опросы в приложении без кода с помощью Userpilot.

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

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

Инструменты для создания пошаговых руководств

Создание, повторное использование и организация ресурсов может отнимать много времени.

К счастью, есть несколько полезных инструментов, которые можно использовать для облегчения этого процесса (и они не называются Microsoft Word):

Userpilot

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

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

Userpilot-UI-patterns-step-by-step-guides

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

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

Писарь

Если вам нужен инструмент для создания фактических ресурсов, Scribe – это тот инструмент, который вы ищете.

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

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

Руководствами можно делиться с помощью ссылки или экспортировать их в другие форматы.

писец

Loom

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

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

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

Подведение итогов

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

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

Понравилась статья? Поделить с друзьями:
  • Руководство по эксплуатации канал вент
  • Руководство умом декарта
  • Стрекар фунгицид инструкция по применению для томатов под корень
  • Мирамистин инструкция по применению для горла взрослым спрей противопоказания
  • Руководство по ремонту ваз калина 1119