Некоторые особенности оформления и структурирования технической инструкции:
- Использование заголовков и подзаголовков для упрощения восприятия и навигации. 1 Содержание многостраничных документов добавляют в начале. 1
- Применение нумерованных списков для пошаговых процедур. 1 Процедуры ограничивают 7–9 шагами, чтобы облегчить восприятие. 1
- Логическая разбивка длинных процедур. 1 Для отделения процедур друг от друга используют разрывы страниц. 1
- Соблюдение параллельной структуры в списках. 1 Например, все предложения в списке начинаются с глаголов в повелительном наклонении. 1
- Не злоупотребление цветным шрифтом, особенно красным. 1 Вместо целого предложения или абзаца достаточно выделить первое слово, например, «Важно!». 1
- Использование понятного языка. 1 Не следует использовать сленг. 1
- Чёткие указания в инструкциях, использование глаголов в повелительном наклонении. 1 Например, «откройте» и «перейдите», вместо «пользователь открывает» или «необходимо перейти». 1
- Избегание слишком длинных предложений. 1 Если предложение содержит более 30 слов, его следует разделить на два или преобразовать в маркированный список. 1
Структура и правила оформления технической инструкции зависят от вида продукции, назначения документа и типа производства. 2