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

Свободное пространство

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

Добавьте совсем немного свободного пространства между элементами списка, и вы дополнительно улучшите восприятие текста.

Сравните два варианта оформления в таблице 3.

Таблица 3. Пространство между элементами списков

Таблицы

Таблица – это элемент визуализации текстово-цифровой информации в структурированном и наглядном виде.

Нумерация таблиц

Все таблицы вашей инструкции последовательно нумеруйте арабскими цифрами (например, таблица 1).

Существуют два варианта нумерации таблиц:

– сквозной,

– секционный.

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

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

К слову, к таблицам приложений в основном применяется секционный вариант нумерации. Особенность лишь в том, что вместо номера раздела (приложения) может использоваться заглавная буква (например, для приложения 1 – таблица 1.1, для приложения А – таблица А.1.).

Номер указывайте сверху непосредственно над таблицей.

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

Наименование таблиц

Каждой таблице в вашей инструкции давайте точное и краткое наименование, которое отражает суть информации в таблице.

Наименование указывайте сразу за порядковым номером (например, Таблица 1. Правила форматирования документации).

Иногда возникает вопрос: «Какой знак препинания ставить после порядкового номера – точку или тире?»

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

Размещение таблиц

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

При этом обращение к таблицам в тексте инструкции выполняйте по их номерам, а не по их расположению.

Сравните два представленных варианта в таблице 4.

Таблица 4. Ссылка на таблицу

Вариант Б однозначно и явно указывает на конкретный объект документа.

Графический материал

Под графическим материалом понимаются иллюстрации (рисунки, фотографии, скриншоты) и диаграммы.

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

Все графические изображения в документации считаются рисунками.

Нумерация графического материала

Правила нумерации графических изображений в инструкции аналогичны принципам нумерации таблиц. Отличие только в том, что вместо слова «Таблица» используется слово «Рисунок» (например, Рисунок 1.)

Наименование графического материала

Здесь также по аналогии с таблицами. Единственное отличие в размещении наименования. Текст наименования рисунка располагайте непосредственно под графическим изображением (рисунком).