Из ГОСТ Р 2.610–2019 Единая система конструкторской документации. Правила выполнения эксплуатационных документов

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

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

[из 16.10 ГОСТ Р 2.610–2019]

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

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

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

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

[из 16.11 ГОСТ Р 2.610–2019]

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

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

[из 16.12 ГОСТ Р 2.610–2019]

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

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

[из 16.13 ГОСТ Р 2.610–2019]

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

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

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

16.16 При выводе на экран видеоинформации или мультипликаций ЭСО должна обеспечивать выполнение следующих функций: начать демонстрацию, пауза, повтор, завершение демонстрации [из 16.16 ГОСТ Р 2.610–2019]

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

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

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

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

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

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

[из 16.18 ГОСТ Р 2.610–2019]

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

Примечание — Последовательность и содержание разделов, подразделов, пунктов устанавливают соответствующими нормативными документами.

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

[из 16.19 ГОСТ Р 2.610–2019]