Если вы зашли на эту статью, значит, вы автор инструкций или станете им завтра!
Инструкции для нас — это не просто скучный текст, а дружеские советы. Они помогают легко справляться с рабочими задачами.
Но стоит признать, что иногда инструкции похожи на научные статьи, и их сложно читать. Именно так некоторые и поступают, пока «упс, что-то пошло не так». Это может привести к более серьёзным проблемам, когда задачи решаются при помощи «костылей».
и нарушается технологический процесс и влияет на качество продукта компании. Не хочется с этим сталкиваться. Вот почему важно разобраться, как написать инструкцию.
Мы собрали здесь всё, что знаем, чтобы сделать ваши инструкции максимально понятными и полезными
В ПИК инструкции используют для объяснения кому, что и в каком порядке надо делать для выполнения задачи (операции, процедуры). Инструкции отличаются от других корпоративных документов своей конкретикой и ориентацией на действие. Они не содержат общих описаний, в отличие от политик и регламентов.
Цель инструкции — предложить алгоритм действий (конкретные шаги) или объяснить особенности, что поможет достигнуть требуемого результата с минимальными затратами времени и ресурсов.
Подготовка
Чтобы быстро начать и подготовить основу для инструкции, воспользуйтесь простой формулой «Что–Зачем–Как» и ответьте на три вопроса:
- Что я хочу рассказать? (Заголовок вашей инструкции)
- Зачем это нужно читателю? (Цель инструкции)
- Как это можно сделать? (Какие шаги нужно выполнить)
У вас появится эскиз инструкции, который можно дорабатывать и детализировать.
Определите, какая цель у вашей инструкции, кому она предназначена и чем будет полезна.
Представьте свою целевую аудиторию, тогда текст будет настроен именно на неё, информация будет полезной и понятной.
Укажите цель в самой инструкции перед основным содержанием, это поможет установить правильную настройку читателя на работу с информацией.
Это краткая запись содержания, своего рода скелет. План отображает порядок и последовательность изложения информации. Он состоит из предложений или ключевых слов, которые определяют основное содержание текста.
Существуют виды планов: вопросный, назывной, опорный, тезисный, цитатный. Для подготовки инструкции чаще всего используют назывной или тезисный план.
План не содержится в инструкции, он помогает вам структурировать мысли в цельный и связный текст.
(от лат. structura — строение, расположение, порядок) — это внутренняя организация текста, взаимосвязь его частей. Структура определяет логическое и хронологическое разделение, а также последовательность событий, идей или информации в тексте. Структура текста определяется его стилем и жанром. Так, у информационных статей, регламентов, политик, инструкций или постов в соцсетях будут разные структуры.
Структура инструкции обычно состоит из четырёх частей: заголовок, общие положения (сюда можно включить цель), основной текст (шаги или особенности использования) и приложения.
Правильная структура помогает достигнуть поставленной цели.
Если вы готовите несколько типовых инструкций, разработайте шаблон.
Шаблоны обеспечивают чёткую структуру и логическую последовательность, что упрощает восприятие инструкций. Они также обеспечивают единый стиль и формат, делая инструкции более понятными. Использование шаблонов помогает соблюдать корпоративные стандарты документации. И, наконец, шаблоны ускоряют процесс создания инструкций, поскольку основная работа по структурированию и форматированию уже выполнена.
Содержание
- Следуйте структуре.
Сопровождайте текст графикой (схемы, иконки, инфографика), чтобы улучшить понимание. Вы можете визуализировать данные и идеи, делая их более доступными и понятными для читателей. К тексту по работе с ПО добавляйте скриншоты. А к скриншотам, в свою очередь, — сопроводительный текст. Желательно, чтобы на скриншотах были выделены зоны, кнопки и места, о которых идёт речь (любые элементы: стрелки, цветные рамки).
- Предоставьте алгоритм (последовательность действий, которая ведет к желаемому результату). Вы можете дать алгоритм в начале текста, а затем подробно разъяснить каждый пункт. Или выделить ключевые слова в списке таким образом, чтобы алгоритм легко прочитывался.
- Не пропускайте шаги, которые кажутся простыми. Если читателю знаком этот шаг, то он пропустит его сам. В то же время не стоит описывать очевидные вещи. Чтобы не пропустить важное и не погрязнуть в излишней детализации, проверяйте текст на фокус-группе или, как минимум, просите вычитать кого-то из коллег.
- Излагайте мысли последовательно и точно. Ни в коем случае не допускайте ситуаций, когда описание можно не понять или понять двояко (помните о своей аудитории и уровне её подготовки).
- Избегайте описания ситуаций из личного опыта, так как это отвлекает внимание читателей и увеличивает время чтения.
Используйте информационный стиль — полезный, простой, понятный. Формулируйте мысли коротко и просто (в предложении 8-10 слов). Фокус должен быть на решении задачи (проблемы) или действии пользователя.
Делайте опору на активный глагол. По возможности не используйте пассивный залог и отглагольные существительные.
Плохо: Курс Revit базовый должен быть пройден вами
Хорошо: Пройдите обучение по курсу Revit базового уровняПишите и общайтесь гендерно-нейтрально.
Плохо: Я хотел(а) бы рассказать, как можно увеличить продажи с помощью настроек
Хорошо: Разберём, как увеличить продажи с помощью новых настроекВ тексте может использоваться обращение к пользователю на «ты», но всегда сохраняйте вежливый и нейтральный тон, всю коммуникацию делайте обезличенной. Будьте осторожны с юмором: он не должен быть слишком ярким или задевать чьи-то чувства.
«Стандартной страницей» текста (формат А4) обычно считается 1800 печатных знаков с пробелами. Внимательное чтение такого объема займет в среднем 9-10 минут. Статистика также показывает, что человек способен воспринимать однообразную информацию не дольше 20 минут.
Если текст большого объёма, то вы поможете читателю, оформив оглавление. Или разбейте большую инструкцию на две.
Оформление
- Указывайте назначение инструкции перед основным текстом
- Оформляйте оглавление
- Используйте преимущественно простые конструкции предложений
- Оформляйте содержательные ссылки на другие ресурсы
- Указывайте под основным текстом (сноской) использование информации из [название источника], если заимствуем материал из других источников больше 20%
Введите маркировку типовых элементов и на протяжении всего текста придерживайтесь правил этой маркировки.
Например:
полужирный шрифт — для описания названий элементов интерфейса и кнопок
прописная буква и кавычки (ёлочки) — для описания команд, вводимых пользователем
курсивный шрифт — для терминов или привлечения внимания к определенным словам (предложения, набранные курсовом плохо читаются)
рамка — для оформления фрагментов кода
маркеры и иконки — для типовых блоков: путь к файлу, порядок действий, важная информация
Чтобы выделить текст (особенно, если в текстовом блоке больше 3-4 слов), не рекомендуется использовать капслок, красный цвет и курсив:
ЧТО БЫ НИ СЛУЧИЛОСЬ, НИ В КОЕМ СЛУЧАЕ НЕ НАЖИМАЙ ЭТУ КЛАВИШУ!
Обычно текст, оформленный подобным образом, читатели игнорируют или просматривают бегло. Текст, набранный основным шрифтом, прочтут с большей вероятностью.
Для выделения блока лучше использовать иконки, эмодзи или символы: ☝
Можно также использовать слова Внимание! Совет! и др.
Проверка
Вычитайте подготовленный текст. Каждую найденную сущность из списка ниже нужно ставить под сомнение. Если вы не сможете чётко ответить, почему она здесь — удаляйте или переделывайте:
- Сложные конструкции — разбиваем на несколько предложений
- Страдательный (пассивный) залог — меняем конструкции предложений
- Отглагольные существительные — меняем на глаголы
- Канцеляризмы — удаляем
- Вводные слова — проверяем на уместность
- Риторические вопросы — проверяем на уместность
- «Воду» — отжимаем
- Сленг — удаляем (это правило для источника информации, который попадает в публичное пользование, можно оставлять только профессиональные термины)
- Главред — инструмент для автоматической проверки текста обеспечивает двойной контроль и подсвечивает проблемные зоны. Стремимся к оценке 9 на вкладке «Чистота» и «Читаемость».
- Яндекс.Степллер помогает находить и исправлять орфографические ошибки в русском, украинском или английском тексте. Языковые модели Спеллера включают сотни миллионов слов и словосочетаний.
- LanguageTool ищет грамматические, стилистические и пунктуационные ошибки
Чтобы убедиться в качестве разработанной инструкций, проверьте её по критериям:
- Ясность: текст инструкции понятен и прост для восприятия
- Краткость: в инструкции нет лишней информации, передана только суть
- Последовательность: шаги логически выстроены
- Детализация: каждый шаг описан достаточно подробно
- Визуализация: текст сопровождается графикой, иллюстрациями и скриншотами
- Надёжность: есть подтверждение, что инструкция работает, она протестирована
- Эффективность: прочтение инструкции занимает не больше времени, чем это необходимо