Как правильно составлять руководство - RukovodstvoRus.ru - инструкции пользования и руководства

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Запустите программу Microsoft Word
Нажмите на раздел «Новый документ» в правой части экрана
Наберите необходимый текст в открывшемся окне. Образец приведен ниже.
Отформатируйте набранный текст с помощью верхней панели программы Word.
- Сначала Выделите шапку заявления (адресата и составителя заявления). Нажмите на кнопку «Выравнивание по правому краю» на верхней панели программы Word. Строки переместятся вправо
- Аналогичным способом отформатируйте заголовок (используем кнопку «Выравнивание по центру»)
- Выделите список спецодежды и примените к нему функцию «Маркированный список»

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

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

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

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

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

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

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

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

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

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

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

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

Вывод

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

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

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

Готовые курсы для бизнеса: проверенные агрегаторы онлайн курсов

Как учиться эффективно: проверенная технология обучения

Где провести вебинар: лучшие программы для вебинаров

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

Источник

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

Содержание

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

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

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

Пошаговые руководства и инструкции всегда остаются востребованными. К ним обращаются, чтобы решить вопросы, связанные с обустройством дома или карьерой, здоровьем, увлечениями, спортом. Неудивительно, что ролики на 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, чтобы изучить, кто и по каким вопросам звонит в вашу компанию. Сервис определит пол каждого звонящего, присвоит тег, запишет диалог клиента и оператора и переведет его в текст. Вы поймете, чего не хватает вашим клиентам, и на основе их обращений оптимизируете скрипты продаж или даже сам продукт.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Источник

Руководство — отличный пример эффективного контент-маркетинга. Гайды не только демонстрируют знания эксперта, но и приносят пользу людям. Сегодня расскажем о том, как их правильно писать.

Итак, начнем с того, что условно гайды делятся на два типа:

Полное руководство, в котором рассказывается о каком-то сервисе или действии. Пример — создание группы во «ВКонтакте» с нуля, инструкция по пользованию линейкой готовых решений IntecUniverse.
«КАК-руководство» отвечает на конкретный вопрос. Пример — как настроить Google Диск, как почистить серебро, как приготовить лазанью и пр.

Определитесь с ЦА

Первый вопрос — кто будет читать гайд? Руководство для новичков — это одно. Гайд для тех, кто уже умеет что-то делать и хочет прокачать скилл, — совсем другое.

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

Выдержка из руководства по украшению дома к Новому году

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

Отжимайте лишнюю воду

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

Вот пример неудачного вступления:

У всех, кто работает в «Фотошопе», рано или поздно возникает потребность нарисовать круг. Именно для таких пользователей и написано это руководство.

Надо вот так:

В гайде я собрал 11 способов, как нарисовать круг в «Фотошопе». Руководство подходит для версии СС 2015 и выше.

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

Очень много вступлений, речевых оборотов и т.д.

Кратко или подробно: ищите баланс

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

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

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

Для сравнения:

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

И вот так:

Нарушите инструкцию — песец всему.

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

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

Помните о структуре

«Нет» длинным абзацам. Абзацы больше 6 строк лучше разбивать на две части — так текст читается легче.

Используйте списки. Надо что-то перечислить — делайте список, даже короткий, даже всего из трех пунктов.

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

Чтобы что-то сравнить, создавайте таблицы.

Без картинок никуда

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

Вместо тысячи слов — картинка. Можно интересно писать, но лучше показывать. Например, вы рассказываете о каком-нибудь устройстве. На правой панели прибора в верхней части с левой стороны есть большая желтая кнопка, которую надо нажать. Что проще: объяснять словами или сделать фото и обвести кнопку кружком? Конечно, сделать фотографию.

Нет фотографий — есть YouTube. Найдите видео по теме, сделайте скриншот нужного кадра. Другой вариант — нарисуйте схему в графическом редакторе. Так, если вы пишете гайд по работе с компьютером, делайте много скриншотов. Удалить лишние скрины проще, чем обнаружить, что не хватает какого-то шага, и начинать все сначала.

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

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

Пример гифки о редактуре от Максима Ильяхова

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

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

Ссылки

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

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

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

Этот рецепт работает и с полными руководствами. Не размещайте огромное текстовое полотно на одной странице, а разбивайте его на разделы с грамотной перелинковкой. Google и Яндекс именно так и устроили гайды для своих сервисов.

Заключение

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

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

Источник

Загрузить PDF

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

1

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

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

Используйте практический подход. Попробуйте и сами сделать то, о чем пишете, и вы поймете, о чем захочется узнать вашему читателю и что выяснить.
4
Почитайте больше тематических источников. Прочтите то, что уже написано по теме вашего руководства — это будет только на пользу.
- Аналогичные руководства помогут понять, о чем и как надо писать.
  - Анализируйте прочитанное, ищите общие черты к описанию особенностей и функционала.
  - По аналогии поступайте с различиями. Так вы сумеете описать уникальные функции своего товара или продукта. Чем больше информации в руководстве, тем лучше и тем больше вероятность, что читатель будет заинтересован ею и дочитает ее до конца.
- Читайте тематические журналы. Узнайте, как пользуются тем или иным инструментом люди, которым он необходим в повседневной практике. Может, исходя из этого следует уделить больше внимания какой-нибудь особенности вашего продукта.
Реклама

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

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

Возьмите этот шаблон за основу содержания руководства.
4

Прочитайте все и проверьте. Убедитесь, что ничто не отходит от выбранной вами схемы повествования.
5

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

Реклама

1

Напишите введение. Это задаст тон всему руководству и покажет читателю, что его ждет. А то, каким должно быть вступление, зависит от вашего читателя. Понятно, что инструкция о том, как сделать открытку к дню рождения будет слегка отличаться от “инструкции” по проведению операции на открытом сердце. Выберите стиль повествования и не отходите от него.
2
Выполните все действия, параллельно записывая все. Так не только будет честно, но еще и вы сами ничего не пропустите.
- Если такой возможности нет, то обязательно проконсультируйтесь в конце с экспертом.
3
Пронумеруйте действия. С нумерованным списком людям работать проще, это факт.
- Если вы пишете на бумаге, оставляйте между строчками достаточно места, чтобы выставить еще линию-другую. И не забудьте сдвинуть нумерацию, если что.
4
Напишите советы и предупреждения. В процессе работы над руководством вас может посетить мысль о том, что без должной тщательности выполнение того или иного действия пользователем может привести к проблеме.
- Плюс если у вас есть в памяти интересный факт, которым будет полезно поделиться с читателем — напишите и его.
5
Проверьте все. Итак, у вас есть инструкция — теперь сделайте нужное действие строго по вашему руководству. Если вы найдете места, где ваше руководство непонятно, неадекватно, неточно и т.д. — исправьте все как надо. Повторяйте этот этап до тех пор, пока ваше руководство не станет полным.
- Полезно будет дать почитать руководству другу и посмотреть, поможет ли оно им. Следите за их реакцией и затем внесите в руководство нужные изменения.
6

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

Реклама

1
Начните с верхнего уровня. А верхний уровень — это заголовки. Закончив все выше перечисленные пункты, перечитайте руководство и найдите в нем будущие заголовки будущих разделов.
- Дайте им название и запомните, на какой они строке находятся.
2

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

Советы

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

Об этой статье

Эту страницу просматривали 9131 раз.

Была ли эта статья полезной?

Источник

Мой Телеграм

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

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

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

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

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

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

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

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

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

Последовательность. Начинайте с… начала. Удивительно, но многие почему-то начинают писать инструкцию едва ли не с середины. Например, так: «в папке «Мои документы» откройте файл…» — учитывайте, что пользователь с минимальным уровнем знаний наверняка не знает, где искать ту самую папку. Объясните, где она находится.

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

И еще раз о терминологии. Если обойтись без нее нельзя, напишите приложение к инструкции – словарь. Либо поясняйте их прямо по тексту.

Не лейте воду. Пошаговое руководство – именно тот жанр, где не требуется долгих лирических вступлений и разглагольствований на тему «всем известно, что» или «а в Древнем Риме было так» — в двух предложениях поясните смысл или повод для написания инструкции и сразу же переходите к делу.

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

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

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

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

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

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

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

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

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

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

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

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

Эксперт. Он поможет убрать фактические неточности и сделать инструкцию достоверной.

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

Источник