Читать книгу: «Как написать понятную инструкцию. Опыт инженера», страница 5

Часть 2. Оформление

Зачем нужно оформление?

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

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

Для этого просто применяйте следующие четыре элемента структуры документа:

– заголовки,

– списки,

– таблицы,

– графический материал.

Заголовки

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

Каждый раздел документа начинайте с заголовка.

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

Сравните два варианта, представленные в таблице 1.

Таблица 1. Уровни текстовых заголовков

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

Вариант Б является правильным. Здесь сразу видна разница уровней заголовков. Размер шрифта заголовка подраздела должен быть меньше шрифта заголовка раздела.

Это правило также касается и нумерованных заголовков.

Посмотрите пример в таблице 2.

Таблица 2. Уровни нумерованных заголовков

Списки

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

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

– тип,

– длина,

– свободное пространство.

Типы списков

При имеющихся плюсах списков неправильное их оформление может оказать противоположное (негативное) влияние на восприятие информации.

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

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

– маркированный,

– нумерованный.

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

Нумерованные списки применяйте в обратных случаях, когда последовательность перечисления имеет значение. Пункты нумерованного списка оформляются уникальными порядковыми номерами или буквами (как заглавными, так и строчными).

Длина списка

Длина списка – это число элементов этого списка.

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

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

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