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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Выберите свой шаблон или используйте пустую страницу.

Введите заголовок страницы. Не используйте в названии специальные символы ! @ # № $ % ^ & ? : они могут быть некорректно обработаны системой.

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

Используйте общепринятые термины и аббревиатуры. 

Придерживайтесь подхода «От общего к частному»

Основной текст выполняйте стилем «Абзац». Для деления текста используйте систему заголовков. 

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

Форматируйте тест при помощи встроенных инструментов.

Оформляйте перечисления в виде списков, вам доступны два вида.

Маркированный, когда позиции списков не имеют последовательности. При этом если у одной позиции есть преимущества (например, чаще используется), то такую позицию нужно поставить в начало.

• Пример
• Пример
• Пример

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

1. Действие 
2. Действие
3. Действие

Разбивайте текст на слайды для улучшения его восприятия. Следуйте правилу: один абзац должен содержать 4-5 предложений. Или воспользуйтесь инструментом «Разметка страницы». 

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

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

Добавляйте содержание, если в тексте два и более заголовков. Используйте макрос «Оглавление».

Сохраните статью после редактирования, для этого нажмите «Обновить». Если вы хотите, чтобы все, кто подписан на статью узнали об изменениях, установите флажок «Сообщить наблюдателям».

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

Основные правила работы с метками: 

• Не оставляйте разделы, подразделы и страницы без меток. Это важно для сбора информации по рубрикам, включая чат-ботов
• Ставьте обе метки, если страница относится и к программному обеспечению (Revit, Civil3D, PIKTools, FM и др.), и к разделу проектирования (Общий, АР, КР и т.д.)
• Добавляйте метки к одной сущности по принципу: от общего к частному
• Поставьте метку ?, если страница не относится ни к одному из разделов или подразделов
• Используйте слова и словосочетания преимущественно на русском языке. Допускается на латинице указывать названия ПО (Revit, Civil3D, PIKTools, FM и др.), а также общепринятые слова и сокращения
• Не допускается использовать однокоренные слова в единственном и множественном числе в качестве разных меток
• Используйте только _ (нижнее подчеркивание) или - (дефис) в словосочетаниях между словами. Если вы поставите пробел, то каждое слово преобразуется в отдельную метку
• Не добавляйте множество меток, по которым можно найти только одну страницу. Не забывайте, что поиск будет конкретизирован по наименованию страницы

 Изучите каталог меток, прежде чем создавать новую метку. Возможно, что-то похожее уже существует. 

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

Например:

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

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

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

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

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

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

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

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

Для выделения блока лучше использовать эмодзи или символы: ☝ или специальные блоки. Можно также использовать слова: Внимание! Совет и др.

В Confluence

Текст можно выделить при помощи макроса Info: 

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

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

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

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

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