Page History

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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