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

Шрифт:

Описание действий и указаний

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

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

Также обратим внимание на требование стандарта по эксплуатационным документам¹ в части изложения указаний:

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

Русский язык в школе все изучали (а также повторяли в рамках обучения в ВУЗах), но скорее всего, было это давно. Поэтому, на всякий случай, немного освежу ваши знания по теме данного раздела.

Для этого взял у сына прекрасный школьный учебник по русскому языку под редакцией В.В. Бабайцевой² (как бы это смешно ни казалось). Вот что там написано:

Глаголы в повелительном наклонении выражают побуждение к действию (просьбу или приказ).

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

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

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

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

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

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

Вычитка

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

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

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

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

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

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

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

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

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

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