Kitabı oku: «Как написать понятную инструкцию. Опыт инженера», sayfa 3

Подходы к составлению инструкций

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

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

– инструментальный;

– функциональный.

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

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

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

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

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

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

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

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

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

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

Структурирование

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

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

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

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

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

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

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

Рисунок 3. Дедуктивный метод структурирования материала для инструкции