Как написать понятную инструкцию. Опыт инженера

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

Есть такая замечательная профессия — технический писатель. Это как раз тот самый специалист, который пишет техническую документацию и оказывает инженерам неоценимую помощь, чтобы мы, инженеры, больше времени уделяли своим основным задачам и не отвлекались на подготовку документации. К сожалению (или к счастью) для инженеров, технические писатели до сих пор достаточно редкие специалисты в российских компаниях, да и в целом на территории СНГ, в отличии от США и Европы.

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

И здесь нам снова поможет все тот же школьный учебник по русскому языку:

При вежливом обращении к одному человеку употребляют глагол в форме множественного числа повелительного наклонения.

Если применить это правило к ранее представленному примеру, то получается следующее: не «Открыть люк», а «Откройте люк»; не «Нажать кнопку», а «Нажмите кнопку».

Вычитка

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

Вычитка включает в себя логическую и грамматическую проверки.

Логическая проверка

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

Грамматическая проверка

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

Двухфакторная проверка

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

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

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

Рисунок 4. Двухфакторная вычитка инструкции

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

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

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

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

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

— заголовки,

— списки,

— таблицы,

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

Заголовки

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

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

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

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

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

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

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

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

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

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

Списки

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

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

— тип,

— длина,

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

Типы списков