Создание инструкций: пишем полезные и понятные тексты

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Если вы готовите несколько типовых инструкций, разработайте шаблон.

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

1. Следуйте структуре.

2. Сопровождайте текст графикой (схемы, иконки, инфографика), чтобы улучшить понимание. Вы можете визуализировать данные и идеи, делая их более доступными и понятными для читателей. К тексту по работе с ПО добавляйте скриншоты. А к скриншотам, в свою очередь, — сопроводительный текст. Желательно, чтобы на скриншотах были выделены зоны, кнопки и места, о которых идёт речь (любые элементы: стрелки, цветные рамки). 

3. Предоставьте алгоритм (последовательность действий, которая ведет к желаемому результату). Вы можете дать алгоритм в начале текста, а затем подробно разъяснить каждый пункт. Или выделить ключевые слова в списке таким образом, чтобы алгоритм легко прочитывался.
4. Не пропускайте шаги, которые кажутся простыми. Если читателю знаком этот шаг, то он пропустит его сам. В то же время не стоит описывать очевидные вещи. Чтобы не пропустить важное и не погрязнуть в излишней детализации, проверяйте текст на фокус-группе или, как минимум, просите вычитать кого-то из коллег.
5. Излагайте мысли последовательно и точно. Ни в коем случае не допускайте ситуаций, когда описание можно не понять или понять двояко (помните о своей аудитории и уровне её подготовки).
6. Избегайте описания ситуаций из личного опыта, так как это отвлекает внимание читателей и увеличивает время чтения.

1. Используйте информационный стиль — полезный, простой, понятный. Формулируйте мысли коротко и просто (в предложении 8-10 слов). Фокус должен быть на решении задачи (проблемы) или действии пользователя.  

2. Делайте опору на активный глагол. По возможности не используйте пассивный залог и отглагольные существительные. 
   Плохо: Курс Revit базовый должен быть пройден вами
   Хорошо: Пройдите обучение по курсу Revit базового уровня

3. Пишите и общайтесь гендерно-нейтрально.
   Плохо: Я хотел(а) бы рассказать, как можно увеличить продажи с помощью настроек
   Хорошо: Разберём, как увеличить продажи с помощью новых настроек

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

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

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

• Указывайте назначение инструкции перед основным текстом
• Оформляйте оглавление 
• Используйте преимущественно простые конструкции предложений
• Оформляйте содержательные ссылки на другие ресурсы 
• Указывайте под основным текстом (сноской) использование информации из [название источника], если заимствуем материал из других источников больше 20%

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

Например:

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

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

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

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

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

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

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

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

Для выделения блока лучше использовать иконки, эмодзи или символы: ☝ 

Можно также использовать слова Внимание! Совет! и др.

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

• Сложные конструкции — разбиваем на несколько предложений 
• Страдательный (пассивный) залог — меняем конструкции предложений
• Отглагольные существительные — меняем на глаголы 
• Канцеляризмы — удаляем
• Вводные слова — проверяем на уместность
• Риторические вопросы — проверяем на уместность
• «Воду» — отжимаем
• Сленг — удаляем (это правило для источника информации, который попадает в публичное пользование, можно оставлять только профессиональные термины)

• Главред — инструмент для автоматической проверки текста обеспечивает двойной контроль и подсвечивает проблемные зоны. Стремимся к оценке 9 на вкладке «Чистота» и «Читаемость».
• Яндекс.Степллер помогает находить и исправлять орфографические ошибки в русском, украинском или английском тексте. Языковые модели Спеллера включают сотни миллионов слов и словосочетаний. 
• LanguageTool ищет грамматические, стилистические и пунктуационные ошибки 

Чек-лист для разработанной инструкции

Чтобы убедиться в качестве разработанной инструкций, проверьте её по критериям: 

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