Как написать понятную инструкцию. Опыт инженера - Владимир Юсупов Страница 4

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Часть 3. Памятка

Соблюдайте принципы создания инструкций

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

Помните о проклятии знаний

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

Описывайте действия пользователя в повелительном наклонении

Побуждайте пользователя выполнить нужное действие. Обращайтесь к нему вежливо. Используйте глаголы в форме множественного числа повелительного наклонения.

Аккуратно оформляйте инструкцию

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

Вычитывайте документ

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

Вычитывайте документ!

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

Вычитывайте документ!!

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

Ответьте на вопросы самоконтроля

После вычитки инструкции ответьте себе на три вопроса:

— Что я пытался сказать?

— Сказал ли я то, о чем собирался?

— Понятно ли это тому, кто впервые слышит об этом?

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

Покажите товарищу

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

Послесловие

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

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

Благодарю вас, что уделили внимание моей небольшой работе и желаю вам успеха в написании понятных инструкций!

С уважением,

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

Неравнодушный к документации инженер

vladimir@techwritex.ru

Примечания

1

ГОСТ Р 2.601-2019 Единая система конструкторской документации. Эксплуатационные документы.

2

Бабайцева В.В. Русский язык. Теория. 5 — 11 классы: Учебник для школ и классов с углубл. рус. яз. — 3-е изд., испр. — М.: Дрофа, 2000. — 432 с.