Посмотр рубрик

Как создавать инструкции

Ответственные: Исполнитель, который создаёт и поддерживает инструкции

Введение #

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

Принцип №1 — Практическая применимость #

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

Что даёт инструкции практичность?

Пошаговость и линейность #

Инструкция — это прежде всего шаги. Шаги идут в логической последовательности, которую НЕЛЬЗЯ менять.

Чем меньше в инструкции вариативности, тем меньше шансов, что человек что-то неверно поймёт и где-то накосячит.

Действие #

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

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

Примеры и шаблоны #

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

Пример:

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

Наглядность #

Всё что можно представить визуально — представляем визуально.

Посмотрите на картинку ниже:

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

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

В хорошей инструкции текст всегда сопровождается понятной графикой.

Вспомните инструкции по сборке мебели от IKEA и делайте так же.

Нюансы #

В хорошей инструкции важны нюансы.

Например описание:

«Загрузите видео в урок и откройте доступ ученикам», — выглядит вроде неплохо. Но…

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

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

Описывайте нюансы каждой операции так, чтобы её понял первоклассник.

Видео или текст #

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

Текст легко отредактировать и «пробежаться» глазами. С видео так сделать не получится.

Текст + скриншоты отлично дополняет скринкаст (видео, записанное с экрана).

Текст + схема отлично дополняет наглядное видео.

Но инструкции состоящие ТОЛЬКО из видео недопустимы!

Принцип №2 — Простота изложения #

Инструкцию должно быть легко читать. Сложные предложения — зло. Короткие. Ёмкие. Понятные. Вот наш стиль.

Если где-то пояснить можно схематично — поясняем схематично. Так проще.

Например предложение:

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

Можно заменить более простой конструкцией:

Для работы воронки используем схему:

Трафик => Лендинг => Прогрев => Продажа

Для человека “в теме” это будет понятно без лишних слов. Согласны?

Важный нюанс:

Простота не подразумевает расхлябанности и изложении.

Нельзя написать:

«Маганер шлёт ТЗшку дизу, а тот рисует графику презы для веба«

Пишем ясно и понятно:

«Менеджер отправляет согласованное техзадание дизайнеру. Дизайнер по техзаданию рисует графику презентации для вебинара».

Принцип №3 — Чек-лист #

Инструкция без чек-листа — это просто прикольное повествование. Человек не запомнит ничего.

Поскольку в инструкции есть чёткие шаги, то в итоге из этих шагов формируется чек-лист.

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

Пример чек-листа по написанию инструкций:

  1. Чётко описываем задачу инструкции (какой результат должен быть в итоге её реализации)
  2. Пошагово описываем структуру действий для достижения результата
  3. Создаём документ, где в роли названия будет описание задачи из пункта 1
  4. Создаём структуру документа, где в роли заголовков будет описание из пункта 2
  5. Описываем каждый шаг максимально чётко и понятно
  6. Оформляем текст инструкции
  7. При необходимости добавляем графику
  8. При необходимости добавляем видео
  9. При необходимости добавляем таблицы
  10. Читаем инструкцию вслух и убираем неточности и шероховатости
  11. Прогоняем инструкцию самостоятельно и добавляем моменты, которые были упущены
  12. Прогоняем инструкцию исполнителем и добавляем моменты, которые были упущены
  13. Проверяем абзацы, интервалы, размеры шрифта, выравнивание текста и картинок
  14. Пишем чек-лист инструкции
  15. Оповещаем о создании/изменении инструкции всех причастных

Если Вы ставите задачи в системе управления задачами, то ставьте чек-лист по пути к результату. Это сильно упростит работу исполнителю, а Вы, как постановщик, убедитесь, что исполнитель всё сделал верно.

Пример чек-листа в задаче
Пример чек-листа в задаче

Принцип №4 — Рамки инструкции #

Инструкция не может быть «всё обо всём». У любой инструкции есть рамки и их следует соблюдать.

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

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

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

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

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

Например инструкцию по подготовке вебинара можно разбить на:

  1. Проработка ключевых смыслов вебинара и заполнение паспорта презентации
  2. Создание и подготовка презентации
  3. Техническая настройка вебинара
  4. Подготовка и тренировка спикера

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

Принцип №5 — Оформляем грамотно #

Все инструкции мы оформляем в корпоративном сайте.

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

  • Понятное название инструкции
  • Структура в виде заголовков
  • Оглавление (создаётся автоматически на основании структуры заголовков)

Давайте подробнее пройдёмся по оформлению.

Название #

Название должно понятно отражать суть инструкции без двояких толкований.

Например:

«Создание вебинарных воронок из 3-х вебинаров»

Видите? Понятно, что продажа не на последнем, а на всех вебинарах. Понятно, что их 3, а не 5 и не 1.

Структура и заголовки #

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

Заголовки могут быть 4-х уровней вложенности (не более).

Структуру инструкции важно продумать ДО написания самой инструкции.

Каждый заголовок — это мини-название, из которого понятно о чём он (заголовок должен трактоваться чётко и понятно без двусмысленностей и недосказанностей).

Нюанс:

Точки в конце предложений в заголовках и названии не ставятся

Оглавление #

Любая инструкция имеет оглавление. Оглавление формируется автоматически на основании структуры заголовков. Например заголовок H2 будет родительским для H3 и так далее.

Оформление #

Шрифт #

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

Выравнивание текста #

По-умолчанию текст выравнивается по левому краю. Другие виды выравнивания без необходимости не используются.

Цвет текста #

Цвета текста стандартные. Иногда можно выделить текст другим цветом (как текст, так и фон), но это делается там, где это действительно требуется. Не нужно превращать текст в “карнавал в Рио”.

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

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

Иногда текст можно написать ЗАГЛАВНЫМИ БУКВАМИ, чтобы сделать важный акцент.

Предложения и абзацы #

Предложения делаем короткие. Стараемся делать абзац не более 3-4 строк, чтобы не было кучности текста.

Картинки #

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

Картинки выравниваем по центру.

Списки #

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

С порядковым номером (когда нужно строго соблюсти последовательности или показать число элементов явно). Например:

  1. Написать заголовок
  2. Написать текст письма
  3. Отправить тестовое письмо
  4. Отредактировать косяки
  5. Отправить письмо по базе

И без порядкового номер (когда не нужно соблюдать последовательность или показать число элементов, а просто структурировать данные). Например:

Над проектом работают:

  • Руководитель проекта
  • Маркетолог
  • Эксперт
  • Куратор

Нюанс:

  • В конце списка точка не ставится

Таблицы #

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

При необходимости выделяйте жирным и/или цветом нужные данные.

Заголовки таблицы, столбцов, строк имеет смысл выделять жирным и/или цветом.

Например удобно показывать в табличном формате «правильно/неправильно»

НеправильноПравильно
ДоговорПроверить и подписать договор с ИП Ивановым К.С.
Допилить письмаОформить и отредактировать письма по запуску «Здоровое сердце — Шаг №1»
Пример таблички как писать заголовки для задач

Принцип №6 — Обновляем своевременно #

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

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

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

Принцип №7 — Прогонка #

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

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

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

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

После таких прогонок актуализируем недостающие элементы, утверждаем чек-лист и… ПОЗДРАВЛЯЮ Вас… инструкция готова!

Оповещение причастных #

ОБЯЗАТЕЛЬНО! После изменения инструкции НЕОБХОДИМО ознакомить всех причастных с акцептом ознакомления.