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

Содержание

как сделать любое объяснение понятным


12.12.2017
10 981
Полезно

КнигиКратко. Главные идеи полезных книг.

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

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

Шаг 2. Начните с текущего состояния. Покажите аудитории то, что происходит с ней или с миром сейчас — в зависимости от темы вашего выступления. Помните: вы отталкиваетесь от уровня знаний слушателей. Под запретом ходы вроде: «Всем известно, что…» — и дальше информация, которой владеете только вы. Если вы говорите о чем-то общеизвестном, пусть это действительно будут факты, знакомые людям.

Шаг 3. Разожгите пламя любопытства. А вот теперь призовите на помощь свою фантазию. Теперь вы точно будете говорить о чем-то новом — и так, чтобы люди задались вопросами «почему?» и «как?». В этот момент вы можете вводить в рассказ новую информацию, но только так, чтобы в слушателей проснулось любопытство. Поддерживайте интригу и стимулируйте естественное стремление к познанию.

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

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

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

Подробнее о том, как построить свою речь, чтобы достучаться до любого слушателя, читайте в обзоре книги Криса Андерсена «TED Talks. Слова меняют мир: первое официальное руководство по публичным выступлениям».

Поделиться

КнигиКратко. Главные идеи полезных книг.

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

Содержание

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

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

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

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. Нажмите на изображение, чтобы перейти на страницу с руководством.

Создание и удаление курсов на платформе
Назначение студентов на курс
Проверка ответов на задания и экзамены

Вывод

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

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

Написание пошаговых инструкций — Microsoft Style Guide

Твиттер

LinkedIn

Фейсбук

Электронная почта

  • Статья
  • 2 минуты на чтение

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

См. также
Форматирование текста в инструкциях
Форматирование пунктуации

Сложные процедуры

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

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

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

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

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

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

  • Используйте полные предложения.

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

  • Используйте согласованные структуры предложений. Например, всегда используйте фразу, когда вам нужно сказать клиенту, с чего начать. В остальное время начинайте каждое предложение с глагола.
    Примеры
    На ленте перейдите на вкладку Design .
    Открыть фотографии.
    Для Выравнивание выберите Слева .

  • Делайте первое слово на каждом шаге заглавным.

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

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

    Для создания группы плиток

    1. На начальном экране выберите плитки, которые вы хотите сгруппировать.
    2. Перетащите их на открытое пространство. Когда за ними появится серая полоса, отпустите плитки, чтобы создать новую группу.

    Для планирования спринтов

    1. В представлении Незавершенные работы выберите первый спринт в разделе Текущий . Или откройте журнал спринта по следующему URL-адресу:
      https://AccountName/DefaultCollection/TeamProjectName/\_backlogs/iteration
      Несколько предопределенных спринтов перечислены в разделе Текущий и Будущий . Фактические названия спринтов различаются в зависимости от шаблона процесса, используемого для создания командного проекта. Однако календарные даты не были назначены.
    2. Чтобы установить даты календаря, выберите первый спринт под Current и выберите даты.

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

  • На начальном экране уменьшите масштаб и перетащите группу в нужное место.

Советы по написанию шагов

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

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

  • Если вам нужно убедиться, что клиент начинает с нужного места, укажите короткую фразу в начале шага.
    Пример
    На вкладке Design выберите Строка заголовка .

  • Если есть вероятность путаницы, укажите вводный шаг.
    Пример
    На ленте перейдите на вкладку Design .

Простые инструкции с угловыми скобками

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

Пример
Выберите Учетные записи > Другие учетные записи > Добавить учетную запись .

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

Обратная связь

Просмотреть все отзывы о странице

Создатель пошаговых инструкций (бесплатный шаблон)

{{#каждый элемент}}
{{#каждый элемент}}
{{#iff path ‘===’ ‘SystemExtension.shippingcalculation’}}

Доставка:

{{this.total}}

{{/iff}}
{{/каждый}}
{{/каждый}}
{{#каждый заказ}}
{{#iff taxValue «!==» 0}}

 

{{#taxLabel taxType ‘Налог:’ ‘НДС:’ ‘Налог на потребление:’}}{{/taxLabel}}

{{tax}}

{{/iff}}

{{itemCount this}} {{#isPlural this }} items{{else}} Item{{/isPlural}}

Итого:

{{total}}

{{/каждый}}

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

Снагит

5

«Новые шаблоны с высокой степенью профессионализма»

HearForm • декабрь 2019 г.

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

Снагит

5

«Потрясающие шаблоны»

dmd18 • март 2020 г.

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

Снагит

5

«Отличный продукт для обучения»

Spenceyll • май 2020 г.

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

Создавайте простые инструкции за считанные минуты

 

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

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

Ваши письменные инструкции можно легко совместить с пользовательским снимком экрана.

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

 

Скачать Snagit

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

Узнайте, как шаг за шагом создать один из шаблона.

1. Выберите изображения для использования в руководстве

Чтобы использовать шаблон, нажмите кнопку Создать и выберите Изображение из шаблона или выберите изображения из области последних снимков, затем щелкните правой кнопкой мыши и выберите Объединить в шаблоне .

2. Выберите шаблон

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

Примечание.  Snagit поставляется с бесплатными базовыми шаблонами, а с годовой подпиской на TechSmith Assets for Snagit доступно больше шаблонов.

3. Расположите изображения, добавьте заголовок и подписи

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