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

Вот лишь несколько простых примеров, которые сходу вспоминаются:

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

– информация, которая логически должна была содержаться в одном разделе хаотично распределялась по всему документу;

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

д.

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

Словом, инженеры разучились писать инструкции…

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

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

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

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

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

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

1.

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

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

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

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

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

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

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

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

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

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

Излагайте материал и описание выполняемых пользователем действий последовательно.