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

15.1 Титульный лист ВЭ выполняют в соответствии с ГОСТ 2.601 [из 15.1 ГОСТ 2.610–2006]

15.2 В ВЭ перечисляют все документы, входящие в комплект эксплуатационных документов на изделие.

Запись документов производят по разделам, которые располагают в последовательности:

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

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

15.3 Документы внутри раздела записывают в ВЭ в последовательности, приведенной в ГОСТ 2.102 и ГОСТ 2.601.

В разделе «Документация общая» первым документом записывают ВЭ [из 15.3 ГОСТ 2.610–2006]

15.4 Сведения в ВЭ рекомендуется излагать в виде таблицы 28.

Таблица 28 — Ведомость эксплуатационных документов

Наименование разделов в таблице записывают в виде заголовков в графе «Наименование документа» [из 15.4 ГОСТ 2.610–2006]

15.5 При записи папок и футляров в таблице 28 указывают:

• в графе «Обозначение документа» делают прочерк;
• в графе «Наименование документа» — наименование и номер папки и футляра, например «Папка № 1», «Футляр № 2»;
• в графе «Количество экземпляров» — количество экземпляров папок и футляров данного наименования, входящих в состав одного комплекта ЭД;
• в графе «Номер экземпляра» — номер экземпляра папки или футляра (при их наличии);
• в графе «Место нахождения» — места расположения папок и футляров;
• в графе «Наименование документа» наименования записывают в порядке, установленном в 2.6 ГОСТ 2.102 и 2.5.1 ГОСТ 2.601.

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

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

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

[из 16.1 ГОСТ 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]