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

Владимир Юсупов, 2023

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

Часть 1. Методология

Принципы создания инструкции

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

1. Решение конкретной задачи

2. Последовательность

3. Краткость и аккуратность

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

Пересечение всех этих кругов как раз и является той самой «понятностью» в инструкции.

Рисунок 1. Основные принципы создания понятной инструкции

Принцип 1 — Решение конкретной задачи

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

Принцип 2 — Последовательность

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

Конец ознакомительного фрагмента.