Главная цель любой инструкции — дать ответ на вопрос читателя. Инструкция не выполняет свою функцию, если читатель не смог быстро найти нужную ему информацию. Поэтому написать текст инструкции мало — нужно ещё и оформить его так, чтобы помочь пользователю в его нелёгкой задаче. Для этого можно использовать ряд универсальных приёмов. 

Представьте себе такую ситуацию: ваша любимая кошка каждую ночь будит вас ни свет ни заря. Что делать? Вы открываете поисковик, вводите запрос и погружаетесь в список страниц со ссылками на лонгриды, в которых описано всё, что угодно, кроме того, что вам действительно нужно. Вы листаете мемуары о кошке-абьюзере, истории эволюции кошек, исследования их характера. И так бывает очень часто — у вас есть простой вопрос, но найти на него ответ очень непросто. Что уж говорить про руководства к сложным техническим системам и приложениям.

Меня зовут Анна Гончарова, я ведущий технический писатель в компании Bercut. В этой статье разберем пять практических приемов из нашего руководства по стилю, которые помогут структурировать материал и упростить восприятие.

1. Преамбула

Каждый раздел лучше начинать с краткого описания. В двух-трех предложениях объясните, о чем пойдет речь и какие вопросы будут затронуты.

Добавьте ссылки на все подразделы. Это поможет читателю увидеть содержание и быстрее понять, стоит ли углубляться.

2. Краткость и прямота

Многословие и канцелярит осложняют понимание текста. Они перегружают читателя и мешают усвоить суть.

Лучше придерживаться следующих правил:

• Убирайте избыточные слова. Речь идет о словах-паразитах, которые не несут смысла. Чаще всего это — канцеляризмы и “бессмысленные” глаголы. Присмотритесь к конструкциям вроде произвести мониторинг, осуществить проверку или выполнить анализ. Смело выбрасывайте лишнее звено: проверить, запустить, анализировать. 

• Избегайте причастий и деепричастий. Заменяйте сложные обороты на:

  • Прямые повелительные конструкции.

  • Придаточные определения с союзами который, что, если.

  • Последовательные простые предложения.

• Заменяйте страдательный залог активным.Предложения вроде Была выполнена проверка системы или Файл должен быть сохранен оставляют вопросы у пользователя: кто это сделал и кто это должен сделать? Остается ощущение, что действия происходят сами по себе, без участия человека или программы.

3. Структура и выделение

Сплошная «простыня» текста отталкивает. Современный пользователь не читает, а сканирует страницу глазами.

Лучше использовать:

• Нумерованные списки для последовательности действий.

• Маркированные списки для перечисления свойств, возможностей или элементов.

• Выделение для ключевых терминов, названий кнопок и параметров.

• Моноширинный шрифт для команд и фрагментов кода.

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

4. Алгоритмы и ветвления

Инструкции редко бывают линейными. Прямо указывайте на ветвление алгоритмов. Такой подход превращает статичный текст в динамичный алгоритм, это помогает лучше удерживать внимание читателя.

Как отучить кошку будить хозяина ночью:

1. Кошка подошла к кровати ночью.

2. Определите причину:

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

   • Недостаток внимания. Займите кошку активными играми днем.

   • Скука или усталость. Добавьте игрушки или автоматические развлечения рядом с местом сна.

3. Наблюдайте за поведением кошки в течение недели. Если прогресс есть, то закрепляйте режим. Иначе — корректируйте действия:

   • смените расписание игр;

   • попробуйте автоматическую кормушку;

   • исключите болезни и стресс.

5. Визуальные маяки

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

Ключевой принцип: иллюстрация должна прояснять, а не усложнять. Ее тип и детализацию выбирайте, ориентируясь на аудиторию. Например, для описания бизнес-процесса техническому специалисту подойдет точная диаграмма BPMN, а для пользователя — упрощенная блок-схема, которую можно понять с первого взгляда.

Перечисленные приемы — не просто украшение, а основа понятного и полезного технического текста. Внедряйте их, и ваши статьи и документы станут заметно лучше.