Versions Compared

Old Version 38

changes.mady.by.user Бибарсова Оксана Рудольфовна

Saved on

compared with

New Version Current

changes.mady.by.user Бибарсова Оксана Рудольфовна

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Если вы работаете в ПИК, значит, вы уже автор инструкций или готовитесь стать им завтра!

light bulb Здесь мы собрали всё, что знаем, чтобы сделать инструкции максимально полезными и понятными.



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

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

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

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




Подготовка

Expand
titleС чего начать

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

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

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

Expand
titleЦель и целевая аудитория

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

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

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

Expand
titleПлан текста
(инструкции)

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

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

(lightbulb) План

 помогает

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

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

 

Структура текста (инструкции)

 

Expand
titleСтруктура

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

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

для технологической инструкции

) и приложения.

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

Expand

Оформление

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

Например:

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

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

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

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

    • titleШаблон

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

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

    Не существует универсального шаблона для всех инструкций. В зависимости от уровня целевой аудитории, назначения, специфики задач, которые должна решать инструкция, и текущей ситуации, шаблоны могут отличаться. Так, например, инструкция для BIM-специалиста будет отличаться от инструкции, предназначенной для проектировщика. Это связано с тем, что BIM-специалист обладает знаниями, которые позволяют ему быстрее освоить информацию. Инструкция для проектировщика должна быть более подробной и разъяснительной, чтобы она была понятной для людей без специальной подготовки. Также инструкция по использованию BIM-инструмента будет отличаться от инструкции по BIM-требованиям к модели. В каждом случае необходима своя структура.

    Содержание



    Expand
    titleОбщие правила
    • Следуйте структуре.

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

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

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

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

    • Избегайте описания ситуаций из личного опыта, так как это отвлекает внимание читателей и увеличивает время чтения.
    Expand
    titleСтиль

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

    Делайте опору на активный глагол. По возможности не используйте пассивный залог и отглагольные существительные.  

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


    Пишите и общайтесь гендерно-нейтрально.

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


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


    Будьте осторожны с юмором:     он не должен быть слишком ярким или задевать чьи-то чувства.

    Expand
    titleОбъём

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

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

    Проверка

    Expand
    titleРедактирование текста

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

    • Сложные конструкции — разбиваем на несколько предложений 
    • Страдательный (пассивный) залог — меняем конструкции предложений
    • Отглагольные существительные — меняем на глаголы 
    • Канцеляризмы — удаляем
    • Вводные слова — проверяем на уместность
    • Риторические вопросы — проверяем на уместность
    • «Воду» — отжимаем
    • Сленг — удаляем (это правило для источника информации, который попадает в публичное пользование, можно оставлять только профессиональные термины)
    Expand
    titleПроверка текста
    • Главред— инструмент для автоматической проверки текста обеспечивает двойной контроль и подсвечивает проблемные зоны. Стремимся к оценке 9 на вкладке «Чистота» и «Читаемость»
    • Яндекс.Степллер помогает находить и исправлять орфографические ошибки в русском, украинском или английском тексте. Языковые модели Спеллера включают сотни миллионов слов и словосочетаний 
    • LanguageToolищет грамматические, стилистические и пунктуационные ошибки 
    Expand
    titleКритерии для проверки инструкции

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

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


    🔗  Чек-лист для проверки инструкции 

    🔗 Создание инструкций. Оформляем в Confluence

     


    thumbs up Если понравилась эта статья, поставь лайк. Так, мы выделяем полезную информацию и обмениваемся актуальными знаниями!

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

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

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

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