Перед тем как приступить к написанию инструкции необходимо чётко знать цель документа и его целевую аудиторию. Другими словами, зачем и для кого.

Без однозначных ответов на эти вопросы начинать что-то делать категорически запрещено, да и просто глупо.

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

Дело это несложное, ведь этих подхода всего два:

  • инструментальный;
  • функциональный.

Рассмотрю в заметке эти два подхода немного подробнее.


Инструментальный подход

При использовании инструментального подхода описание действий идёт от “инструмента” (продукта, объекта документирования).

В этом случае детально и тщательно описывается каждый элемент продукта, как им пользоваться.

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


Функциональный подход

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

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


Какой подход выбрать?

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

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

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