Чтобы объяснить человеку как выполнять задачу или работать с инструментом, нужно составить понятную инструкцию. Неизвестная компьютерная программа или новые функции на работе – все это требует разъяснений для успешного взаимодействия. В статье рассмотрим, как правильно написать инструкцию.
Инструкция – это документ, который объясняет способы или правила выполнения определенных действий. А понятная инструкция делает то же самое, но простым языком. Многие руководства написаны очень сложно и люди предпочитают не заглядывать в них, пока что-то не сломается.
Однако такой подход может привести к не самым лучшим последствиям. Например, работник не изучил правила по работе на буровой установке или неверно понял описанный материал, и получил травму из-за неправильного использования техники. Поэтому важно ответственно подойти к составлению и разобраться, как правильно написать инструкцию.
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. Подумайте, о чем было бы интересно узнать вашей ЦА.
- Начинайте составлять статью-инструкцию с постановки цели. Определитесь, для кого и для чего предназначено пошаговое руководство. Если хотите, чтобы вашу статью с интересом читали до конца, не перегружайте ее терминологией.
- Если пишете инструкцию для новичков, то не пропускайте шаги, которые кажутся слишком простыми. Пусть лучше читатель сам пропустит очевидный для себя этап, чем не узнает, что это действие было необходимо выполнить для достижения результата.
- Пишите емко, избегайте длинных конструкций и воды. Дополняйте текст инфографикой, скриншотами и тематическими иллюстрациями.
Загрузить PDF
Загрузить PDF
Написание инструкций по выполнению определенных функций покажет руководству на работе ваши способности. Такая инструкция также подтвердит, что вы способны выполнить проект самостоятельно.
Шаги
-
1
Укажите тему. Будьте точны в ее границах и сфере.
-
2
Определите, для кого готовится инструкция.
- Вы пишите для новичков, профессионалов или для кого-то со средними знаниями?
- Вашу инструкцию будут использовать на групповых занятиях или для самостоятельного изучения?
-
3
Точно определите, о чем будет сказано в инструкции.
- Пример: Вы готовите руководство «Как установить двери». Один раздел может быть посвящен дверям-купе, другой – входных дверям, еще один – дверям для черного входа.
-
4
Решите, какая логическая структура изложения материала подойдет лучше всего. Взаимосвязь разделов относится не только к последовательности действий. Иногда вначале необходимо включить раздел с описанием некоторых терминов и понятий, а также лучше описать задания, повторяющиеся в разных разделах. Но если вы предполагаете, что читатель уже имеет определенные навыки для выполнения задания, описания общих процедур лучше привести в приложениях.
-
5
Если в инструкции используется профессиональная терминология или жаргон, нужно подготовить словарь терминов. Если знание читателями терминологии маловероятно, глоссарий лучше поместить сразу после содержания. Обновляйте список терминов по мере написания инструкции.
- В глоссарии нужно использовать максимально точные описания терминов. Если используется акроним, объясните его значение (например, Scuba – «Self Contained Underwater Breathing Apparatus» автономный аппарат подводного дыхания).
-
6
Решите, какие темы требуют дополнительного исследования. Если инструкция подготовлена некачественно, она бесполезна. Предварительные исследования нужно завершить до того, как вы приступите к написанию инструкции.
-
7
Подумайте об организационной структуре каждого раздела.
- Пример: Вы готовите инструкцию об определенных компьютерах. В этом руководстве может быть раздел «Устранение проблем». Часть материала в нем можно посвятить проблемам с дисковым пространством, другую – чрезмерному использованию оперативной памяти и т.д.
-
8
Организуйте каждый раздел и секцию в логической последовательности, сужая границы каждой темы.
-
9
Приступайте к написанию! Используйте организационную систему, как основу, но можете смело модифицировать ее, чтобы полнее раскрыть тему.
- Напишите описание разных заданий.
- Подготовьте примеры, выполняя которые читатель лучше поймет инструкцию.
- Подготовьте соответствующие иллюстрации. Не вставляйте рисунки, пока инструкция не написана. Иллюстрации необходимо подогнать под размеры текста.
- Внесите изменения, чтобы облегчить читателю поиск необходимой информации.
- Пример 1: (Используйте нумерованный список) В редакторе можно привязать рисунок к пункту 13-му параграфу инструкции.
- Пример 2: (Сортировка) В редакторе можно увеличить размер текстовой строки, если она выделяется из общего порядка.
-
10
Не списывайте чужие инструкции! Используйте указатели и список литературы, указывая, откуда заимствована цитируемая информация (другие авторы, инструкции и т.д.).
- Ничто не разрушает доверие к автору быстрее, нежели плагиат. Подумайте, что бы вы чувствовали, когда кто-то «украдет» часть вашей работы для своей инструкции?
-
11
Добавьте соответствующие иллюстрации. Расположите их в тексте. Не бойтесь оставлять пустое пространство.
-
12
Проверьте, проверьте и еще раз проверьте. Поиск ошибок должен быть постоянным. Делайте заметки об обнаруженных ошибках или упущенной информации. Исправляйте их. Отметьте параграфы, которые кажутся непонятными другим людям. Перепишите эти места заново, чтобы облегчить понимание. Дайте разным людям прочесть вашу инструкцию, чтобы удостовериться в том, что она написана наилучшим образом.
-
- Лучший, по нашему мнению, порядок проверки готовой инструкции:
- Вычитайте ошибки самостоятельно.
- Попросите друга проверить ошибки.
- Дайте работу на проверку специалисту в данной области, чтобы он также проверил ее.
- Если инструкция готовится для вашей компании, попросите начальника проверить ее.
- Дайте работу на проверку новичку.
- Проверка неопытным специалистом поможет понять, насколько понятно изложен текст для людей, у которых в данной области минимум знаний.
- Лучший, по нашему мнению, порядок проверки готовой инструкции:
Реклама
-
Советы
- Убедитесь, что на титульной странице и в нижнем колонтитуле каждой страницы указана ваша фамилия, как автора руководства. Распечатайте копии инструкции до того, как отсылать ее по электронной почте. Включите знак копирайта (с) в нижнем колонтитуле. Можете набрать (с), и большинство текстовых редакторов автоматически исправит это на нужный символ. В результате нижний колонтитул будет выглядеть «© Ваше Имя». Это не помешает компании копировать инструкцию, но вы сохраните свое авторство.
Реклама
Об этой статье
Эту страницу просматривали 46 893 раза.
Была ли эта статья полезной?
Как написать инструкцию так, чтобы тебя поняли
Время на прочтение
2 мин
Количество просмотров 45K
Есть такая поговорка: «Хочешь сделать хорошо — сделай сам».
Для себя, действительно, так будет быстрее и спокойнее. Однако любому руководителю известно, что плохой менеджер это тот, кто не умеет объяснять и делегировать полномочия. Соответственно, умение давать четкие инструкции и план действий — задача хорошего руководителя. А помогает ему в этом «юзабельность». Давайте и разберёмся с этим понятием.
Юзабилити (от англ. usability) означает удобство в использовании, эргономичность и легкость в понимании.
Инструкция для сотрудников — эффективная и легкая, если результат ее выполнения успешен. При подготовке статьи анализировались внутренние инструкции для сотрудников, выложенные на внутреннем ресурсе Wiki. Однако многие из них оставляют вопросы даже при подробном изучении материала.
Итак, а теперь непосредственно к главному.
Выражение: «И так сойдет» — точно не для инструкций.
1. Постановка цели: для кого и для чего инструкция предназначена. Здесь следует упомянуть, что не следует памятку перегружать терминологией, иначе к ней будет прилагаться словарь терминов — целая энциклопедия и, увы, мало шансов, что её прочитают.
2. Не используем в инструкции много сленга. Есть шанс, что не все сотрудники его поймут.
Пример: «Уточнить у манагеров, получила ли апрув статья». С одной стороны, написано всё понятно, но для официального документа такой сленг не подходит.
3. Текст разбавляем скриншотами. Их желательно делать на своем компьютере и в той программе или интерфейсе, который есть у всех сотрудников. Возможно редактирование скриншотов стрелками и выделением цветом пунктов.
Примеры скриншотов с вполне понятными шагами:
4. Не пропускаем шаги, которые кажутся нам слишком простыми. Пусть лучше сотрудник, читая инструкцию, сам пропустит этот степ.
5. В тексте нежелательно использовать большие предложения. Коротко: «Зайдите в меню», «Добавьте значение…», «Выберите параметр…» и т.д.
6. Для сокращения объема текста возможно применение графических элементов. Например,
Local area connection —–> properties–>TCP/IPv4–>properties.
7. Применение шрифтовых выделений допустимо. Это привлекает внимание на особо важных пунктах.
8. Не используйте в инструкции ничего из вашего личного опыта применения того или иного продукта или использования программы. Для этого существуют отдельные встречи с сотрудниками, где вы передаете им свой ценный опыт. А инструкция — это логичная структура, где описан «шаг — действие» и ничего более.
9. Будьте точны и логичны в написании. Помните, если сотрудник, работая по вашей инструкции сделает ошибку, то это будет ваша недоработка.
Эффективная юзабельная инструкция — это не простая формальность, это один из шагов к успешности и автоматизации рабочего процесса. Зеркальный юзабилити эффект заключается в том, что вещи, которые имеют отношение к собственного опыту, мы запоминаем лучше, чем те, которые не имеют к нам никакого отношения. Поэтому написание инструкций и памяток прокачивает менеджерские навыки специалистов. А это, в свою очередь, идет в «копилку скилов».
Имя собственный ресурс, для привлечения постоянного и качественного трафика, требуется размещать на нем полезный и нужный целевой аудитории материал. Таким материалом, практически всегда, является хорошая инструкция.
Инструкция — это некие указания, правила и порядок действия, для достижения какой-либо цели. Таких статей в сети Интернет тысячи и все они несут некую полезную информацию.
Как написать инструкцию — это вопрос больше к самому себе, так как написание хорошей инструкции полностью зависит от владения темой самого автора, но также существует некий план по ее написанию, придерживаясь которого можно создать действительно полезный материал для своего сайта или на заказ.
Для чего нужна любая инструкция
Ответ на этот вопрос очевиден, но поскольку мы говорим с точки зрения автора, то, для чего нужна инструкция, нам нужно разобраться чуть детальнее.
- С точки зрения читателя — это решение его проблемы, в том или ином вопросе, в зависимости от тематики сайта, на котором она опубликована;
- С точки зрения заказчика (владельца сайта) — привлечения целевого трафика, а как следствие потенциальных клиентов;
- С точки зрения копирайтера — написание качественного текста, который принесет доход или упорядочит информацию в голове.
Но, всеже в конечном итоге, инструкцию будет читать человек, которому нужно что-то сделать, а значит она должна быть в первую очередь рассчитана именно на читателя. То есть, быть максимально полной, информативной, структурированной, пошаговой и главное решать проблему пользователя.
Какие бывают инструкции
Четких критериев и определений на то, какие бывают инструкции, вряд ли кто-то сможет дать. Это сугубо индивидуальная тематика и даже для решения одного и того же вопроса, инструкция может быть совершенно разной и подана в разных стилях, в зависимости от места размещения и контекста.
Но некоторой классификации, в общих чертах, инструкции всеже можно подвергнуть, и так какие виды инструкций бывают:
- Инструкция по строительству или сборке чего-либо;
- Инструкция по применению чего-либо;
- Медицинская инструкция;
- Инструкция из разряда «Как сделать…»;
- Инструкция по приготовлению пиши (рецепт);
Естественно, это далеко не весь перечень, даже самых распространенных видов инструкций, но наиболее известный — это точно.
Существует отдельный вид инструкций, я его называю «специфический», к нему можно отнести:
- Пошаговую инструкцию как написать книгу;
- Инструкцию как в домашних условиях сделать что-то для этого не предназначенное;
- Инструкция как вести себя в той или иной ситуации.
И аналогичные этому.
Как написать пошаговую инструкцию (самое интересное)
По сути, эта статья — инструкция как написать инструкцию, плюс неплохо заточенные под СЕО текст с ключами. То есть, структура, выделенные ключи и заголовке в этой статье — это уже первый пример инструкции.
Но, помимо всего, я все же расскажу начинающим копирайтерам, по какому плану следует идти, чтобы написать качественную инструкцию, гайд или свод правил:
- Найдите проблему — это очень важный этап. Кроме того, проблема, которую решит ваша инструкция должна полностью соответствовать тематике вашего сайта или сайта заказчика;
- Разобраться в вопросе — полностью, досконально и глубоко разобраться в вопросе, о котором будете писать инструкцию;
- Разбить решение проблемы на шаги — составе план, в котором первым пунктом будет наличие проблемы, а последним описание результата ее решения. Промежуточными же пунктами должны стать, последовательные, четкие, полные и грамотные шаги по достижению цели;
- Распишите более подробно каждый шаг — даже уже написав текст в него всегда есть что добавить. Пусть последовательность решения проблему будет максимально подробной;
- Схемы, картинки, примеры — добавьте в статью максимально доступную визуальную информацию. Ее должно быть немного, но в тоже время и не мало. Но помните, что не для всех инструкций такой ход необходим, как, скажем, в этой;
- Полезные советы — добавите вставки в текст с полезными советами (также не для всех видов инструкций);
И вот теперь, как написать инструкцию, образец плана выше, можно понять наглядно, но еще прочитав эту статью и хорошо ее проанализировав, можно понять, как написать СЕО-текст с определенной тематикой.
Вы пришли сюда из поиска? Это доказывает вышесказанное.
Как написать инструкцию: пример
Как я уже говорил выше, пример написания инструкции — это вся эта статья. Более того, большинство статей на этом сайте, которые начинаются со слова «Как» — являются инструкциями, в той или иной степени.
Повторюсь еще раз, классификации и стандарта по написанию инструкций не существует. Главное в написании такого материала — это подробное и пошаговое решение проблемы читателя. Если читающий разобрался со своей проблемой, то инструкция написана верно.
