16 Общие правила выполнения интерактивных эксплуатационных документов (ИЭД) ГОСТ 2.610-2006

16.1 Как правило, ИЭД является объединенным документом и предназначен для:

[из 16.1 ГОСТ 2.610–2006]

16.3 Содержательная часть ИЭД должна включать в себя: административную информацию, введение, оглавление, описание области применения, обозначение и дату выпуска ИЭД и содержательную часть согласно 5.35.9, а также может содержать дополнительную информацию, требуемую заказчиком. Состав данных ИЭД должен обеспечивать полноту, ясность изложения и эффективность применения. Уровень детализации описаний определяется заказчиком. Для обеспечения возможности выдачи пользователю только той информации, которая относится к данной конкретной конфигурации изделия или конкретной ситуации, следует использовать контекстно–зависимую фильтрацию [из 16.3 ГОСТ 2.610–2006]

16.4 Административная информация, которую пользователь может вывести на отображающее устройство по своему выбору, должна включать:

[из 16.4 ГОСТ 2.610–2006]

16.5 ИЭД должен иметь четко сформулированное описание области применения, которое однозначно идентифицирует конкретную систему, оборудование или компоненты, к которым оно относится, и указывает уровень обслуживания, для которого оно предназначено. Эти сведения должны ясно указывать, к какому классу изделий, перечню моделей изделий, серийным номерам изделий относится ИЭД [из 16.5 ГОСТ 2.610–2006]

16.6 Содержание ИЭД должно иметь указания для пользователя, облегчающие поиск нужной информации. Содержание должно быть организовано в логической последовательности представления информации и включать в себя необходимые ветви переходов. Пользователь должен иметь возможность доступа к нужной ему информации непосредственно из меню в содержании [из 16.6 ГОСТ 2.610–2006]

16.7 Справочная система ИЭД должна обеспечивать пользователю:

  • доступ к контекстно–зависимой помощи, необходимой при выполнении определенных действий или в конкретных ситуациях;
  • получение описательной информации с разъяснениями отдельных технических моментов, с объяснением специальных терминов;
  • информационную помощь по пользованию ИЭД и ЭСО, например, как получить доступ к конкретной информации, как пользоваться функциями системы отображения;
  • доступ к дополнительной информации, относящейся к техническому содержанию ИЭД.

Справочная система должна быть предусмотрена для всех разделов ИЭД и доступна в течение всего сеанса работы с ИЭД. Как правило, доступ к справочной системе ИЭД выполняют в виде функции «подсказка».

[из 16.7 ГОСТ 2.610–2006]

16.8 Следует, при необходимости, предусматривать выполнение ИЭД вспомогательных функций (например, подготовки отчетов о проведенных мероприятиях по техническому обслуживанию, формирование перечня для заказа запасных частей и т.п.) [из 16.8 ГОСТ 2.610–2006]

16.9 Техническая информация должна дополняться предостережениями, предупреждениями и примечаниями, выполняемыми в соответствии с ГОСТ 2.601. Сообщения с предупреждениями и требованиями мер предосторожности должны всегда выделяться и содержать в себе всю необходимую информацию о том, что нужно сделать, чтобы избежать или снизить степень опасности. Сообщения такого типа должны легко читаться и быть понятными в рабочей обстановке [из 16.9 ГОСТ 2.610–2006]

16.10 Для обеспечения ясности изложения информации, содержащейся в ИЭД, необходимо соблюдать следующие принципы:

  • важную значимую информацию давать в виде описательного текста;
  • когда описательный текст приводится совместно с графикой, для сокращения текста необходимо:
    • устранить все междометия,
    • начинать предложения с переходных глаголов,
    • по мере возможности применять повелительное наклонение;
    • если нужно указать условие, предложение должно начинаться со слова «когда» (...когда напряжение питания стабилизируется...) и т.д.;
  • не рекомендуется использовать сложноподчиненные и сложносочиненные предложения. Длинные параграфы или предложения необходимо разбивать на части;
  • средняя длина предложения не должна превышать 20 слов. Средний абзац не должен превышать шесть предложений. Каждый абзац, по возможности, должен иметь заглавное или основное предложение, весь материал в абзаце должен быть по этой теме;
  • за исключением особых обстоятельств, следует строить объяснение операций с максимальным использованием графических и мультимедийных возможностей;
  • описательный текст следует давать в логической последовательности выполнения работы;
  • описательный текст должен быть выдержан в единой терминологии, едином стиле и формате во всем ИЭД;
  • при описании работы устройств, имеющих обозначения на их собственных панелях управления, их следует называть только по именам, указанным на панелях. При необходимости допускается использование дополнительного комментария;
  • диалоги должны быть организованы таким образом, чтобы выполнение последующих действий было бы возможным только после ввода ответа пользователя. Информация должна быть представлена в базе данных ИЭД таким образом, чтобы после вывода сообщения на экран и получения ответа можно было бы произвести анализ ответа, определить потребности пользователя и предоставить ему необходимые данные.

[из 16.10 ГОСТ 2.610–2006]

16.11 При разработке графических и мультимедийных изображений для ИЭД следует руководствоваться следующими правилами:

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

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

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

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

[из 16.11 ГОСТ 2.610–2006]

16.12 При разработке звуковой информации для ИЭД следует руководствоваться следующими правилами:

  • звуковая информация должна состоять из неречевых звуковых сигналов и компьютерной или записанной электронным способом речи. При использовании звуковой информации всегда должна подаваться избыточная зрительная информация на случай отсутствия или бездействия звукового устройства;
  • применение звуковых тональных сигналов должно ограничиваться только теми случаями, где их немедленное восприятие не связано с безопасностью персонала или работой оборудования. Частота тональных сигналов должна быть от 500 до 3000 Гц;
  • если неречевой звуковой тональный сигнал используют совместно с выводимым на экран сообщением об ошибке или тревоге, то он должен состоять из одной частоты и предварять визуальное представление сообщения не более чем на 0,5 с;
  • звуковой тональный сигнал должен быть совместим с условиями, в которых предполагается использовать ИЭД. Применение неречевых тональных сигналов, которые можно по ошибке принять за тональные сигналы, традиционно применяемые в рабочих условиях, не допускается;
  • использование компьютерной речи и записи речи должно быть ограничено только случаями представления процедурно–методической информации;
  • при использовании речевой или тональной звуковой сигнализации и (или) речи пользователь должен иметь возможность регулировать громкость звука и включать либо выключать звук.

[из 16.12 ГОСТ 2.610–2006]

16.13 При разработке средств взаимодействия пользователя с ЭСО следует руководствоваться следующими основными правилами:

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

[из 16.13 ГОСТ 2.610–2006]

16.14 ЭСО должна обладать возможностью выводить на экран одновременно несколько окон, причем в каждый момент активным может быть лишь одно из них, которое должно быть зрительно отличимо.

Как правило, окно должно состоять из зоны пользователя, титульной строки, строки меню и органов управления окном. Структура и количество окон устанавливаются соответствующими корпоративными нормативными документами или требованиями заказчика. Если заказчик особо оговаривает, что ЭСО должна иметь только одно окно, то в качестве этого окна должен выступать весь экран дисплея [из 16.14 ГОСТ 2.610–2006]

16.15 ЭСО должна обеспечивать представление статических и интерактивных изображений. Статические изображения должны отображаться ЭСО сразу во всех деталях. При выводе интерактивных изображений ЭСО должна обеспечивать возможность манипуляций с изображением [из 16.15 ГОСТ 2.610–2006]

16.17 Построение ИЭД должно соответствовать требованиям настоящего стандарта и ГОСТ 2.105. Для изделий с многоступенчатой системой деления на составные части рекомендуется ЭД оформлять с применением блочного принципа построения документов в соответствии с ГОСТ 2.601.

Для изделий, поставляемых на экспорт, ИЭД выполняют с учетом требований международных стандартов на техническую документацию и дополнительных указаний потребителя [из 16.17 ГОСТ 2.610–2006]

16.18 Любой МД может содержать в себе ссылочную информацию двух видов:

  • внешние ссылки на другие МД;
  • внутренние ссылки между элементами содержательной части МД.

Внешние ссылки создают с помощью указания кода МД, на который дается ссылка. Внутренние (или перекрестные) ссылки используются в тексте содержательной части МД и ссылаются на его внутренние объекты. Такой способ обеспечивает сохранение целостности ссылок после внесения изменений в документацию. Не следует использовать способы простановки ссылок, основанные на номерах страниц или названиях разделов [из 16.18 ГОСТ 2.610–2006]

16.19 В оглавлении ИЭД должны быть перечислены все структурные элементы документа. Пример визуального представления оглавления ИЭД приведен на рисунке 8. Оглавление ИЭД представляют в ЭСО, как правило, в виде иерархической структуры, позволяющей производить разворачивание (сворачивание) структурных элементов документа. Последовательность и содержание разделов, подразделов, пунктов устанавливают соответствующими нормативными документами.

- Пример визуального представления оглавления ИЭД

Рисунок 8

[из 16.19 ГОСТ 2.610–2006]