Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Вы работаете в ПИК? Значит, вы уже автор инструкций или готовитесь стать им завтра! 

Если подбирать образ под понятие «инструкция», то это надёжный друг, который объясняет нам правила и методы, чтобы мы могли качественно и быстро выполнить рабочее задание. Однако некоторые инструкции могут быть сложными, почти как научные статьи. Именно по этой причине многие не открывают их до момента, пока «всё пошло не так». Такая ситуация может привести к более серьезным проблемам. Например, если сотрудники не изучили инструкцию и не поняли, как работает инструмент, они не смогут его использовать и будут решать задачи при помощи «костылей». Упс! А это нарушает технологический процесс, и качество продукта не будет отвечать стандартам компании.

Вот почему важно уделить время и разобраться, как написать полезную и понятную инструкцию! Мы собрали здесь информацию, которая вам в этом поможет (thumbs up)



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


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




Качество инструкций обеспечивают простые принципы: 

  1. Ясность: текст должен быть понятен и прост для восприятия
  2. Краткость: в инструкции нет лишней информации, передана только суть
  3. Последовательность: шаги логически выстроены
  4. Детализация: каждый шаг описан достаточно подробно
  5. Визуализация: текст сопровождается графикой, иллюстрациями и скриншотами
  6. Надёжность: есть подтверждение, что инструкция работает, она протестирована
  7. Эффективность: прочтение инструкции занимает не больше времени, чем это необходимо




Наш подход к созданию инструкций


Table of Contents




Чтобы быстро начать и подготовить основу для инструкции, воспользуйтесь простой формулой «Что–Зачем–Как» и ответьте на три вопроса:

  1. О чём я хочу рассказать? (Заголовок вашей инструкции)
  2. Зачем это нужно читателю? (Цель инструкции)
  3. Как это можно сделать? (Какие шаги нужно выполнить)

(lightbulb) У вас появится эскиз инструкции, который можно дорабатывать и детализировать.


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

(lightbulb) Укажите цель в самой инструкции перед основным содержанием, это поможет установить правильную настройку читателя на работу с информацией. 


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

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

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


(от лат. structura — строение, расположение, порядок) — это внутренняя организация текста, взаимосвязь его частей. Структура определяет логическое и хронологическое разделение, а также последовательность событий, идей или информации в тексте. Структура текста определяется его стилем и жанром. Так, у информационных статей, регламентов, политик, инструкций или постов в соцсетях будут разные структуры. 

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

(lightbulb) Правильная структура помогает достигнуть поставленной цели. 


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

Например:

  • полужирный шрифт — для описания названий элементов интерфейса и кнопок

  • прописная буква и кавычки (ёлочки) — для описания команд, вводимых пользователем

  • курсивный шрифт — для терминов или привлечения внимания к определенным словам (предложения, набранные курсовом плохо читаются)

  • рамка — для оформления фрагментов кода

  • маркеры и иконки — для типовых блоков: путь к файлу, порядок действий, важная информация

Для выделения текста (особенно, если в текстовом блоке больше 3-4 слов) не рекомендуется использовать капслок, красный цвет и курсив: 

ЧТО БЫ НИ СЛУЧИЛОСЬ, НИ В КОЕМ СЛУЧАЕ НЕ НАЖИМАЙ ЭТУ КЛАВИШУ! 

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


Одной «стандартной страницей» текста (формат А4) принято считать 1800 печатных знаков с пробелами. Внимательное чтение текста такого объёма займёт в среднем 9-10 мин. 

Статистика говорит нам, что человек способен воспринимать однообразную информацию не дольше 20 минут. 

(lightbulb) Если текст большого объёма, то вы поможете читателю, оформив оглавление. Или разбейте большую инструкцию на две.