ГОСТ IEC 82079-1—2014
6 Представление инструкций по применению
6.1 Простота понимания
6.1.1 Признанные коммуникационные принципы
Внутри каждого раздела инструкций по применению, процесс обучения пользователя, должен
быть, насколько это возможно, разбит на последовательность небольших шагов. Степень понимания их
непрерывной последовательности может быть усилена путем нумерации операционных этапов и/или
путем отсылки пользователя (на каждом шаге) к рисунку, наглядно или схематически иллю
стрирующему каждое действие. Каждый шаг должен относиться к отдельной операции.
Функции информационных разделов (например, описание продукта или информация об утили
зации), должны быть легко идентифицируемыми и различные виды информации должны быть четко
определены.
В инструкциях по процедурам объяснение последовательности необходимых шагов должно
быть приведено до описания последовательности выполняемых действий.
Там. где это возможно (в частности, при описании сборки) пользователь должен прочесть со
держимое одного учебного шага, затем выполнить предписанное действие, оценить эффект, и потом
читать текст следующего шага.
Должны быть использованы методы структурирования инструкций по применению, ориентиро
ванные на правильное использование продукта («что» должно быть сделано с продуктом и «как», в
правильном порядке). Общие аспекты должны быть описаны в обзорной главе, конкретные аспекты —
в соответствующем контексте.
Использование иллюстраций увеличивает усвояемость инструкций по применению. Рекоменду
ется добиваться эффективного баланса текста и иллюстраций. Иллюстрации должны быть снабжены
уникальными номерами, на которые можно ссылаться в тексте.
6.1.2 Руководство по стилю
Руководство по стилю должно быть утверждено и должно соблюдаться во всех инструкциях по
применению, например:
- стиль письма (см. таблицу 1);
• формулировки:
• постоянно используемые термины;
• манера обращения к читателям;
• оформление текста и макет страницы, включая выбор типа и размера шрифта (см. таблицу 2).
6.1.3 Структура
Формулировки должна соответствовать структуре, которая поддерживает различные функции
текста. К таким функциям текста, например, относятся:
- тема (заголовок):
• описание;
- цель:
- предпосылка.
• состояние;
• действия:
- результат:
- предупреждение:
• подсказка и напоминание;
- пример:
- подпись (к рисунку или таблице).
Рекомендуется использование метода последовательного структурирования.
Инструкции по применению должны, в первую очередь, охватывать основные или нормальные
функции, а затем уже и другие функции.
Заголовки должны быть простыми для понимания и предпочтительно должны быть краткими и
пронумерованными. В качестве структурных элементов они должны служить руководством пользова
телю для чтения инструкций по применению, и должны помогать пользователю в поиске необходимой
информации.
20