(Действующий) Межгосударственный стандарт ГОСТ 2.610-2006"Единая система...

Докипедия просит пользователей использовать в своей электронной переписке скопированные части текстов нормативных документов. Автоматически генерируемые обратные ссылки на источник информации, доставят удовольствие вашим адресатам.

Действующий
16.2.1 База данных ИЭД должна иметь структуру, позволяющую пользователю быстро получать доступ к нужной информации. База данных ИЭД может содержать текстовую и графическую информацию, а также данные в мультимедийной форме (аудио- и видеоданные). Требования к номенклатуре и составу информации, а также к логической модели данных БД ИЭД должны регламентироваться нормативными документами на изделия конкретных видов техники с учетом их специфики.
16.2.2 ЭСО должна обеспечивать унифицированный для всех ИЭД на изделия конкретных видов техники способ взаимодействия с пользователем и варианты представления информации.
16.3 Содержательная часть ИЭД должна включать в себя: административную информацию, введение, оглавление, описание области применения, обозначение и дату выпуска ИЭД и содержательную часть согласно 5.3-5.9, а также может содержать дополнительную информацию, требуемую заказчиком. Состав данных ИЭД должен обеспечивать полноту, ясность изложения и эффективность применения. Уровень детализации описаний определяется заказчиком. Для обеспечения возможности выдачи пользователю только той информации, которая относится к данной конкретной конфигурации изделия или конкретной ситуации, следует использовать контекстно-зависимую фильтрацию.
16.4 Административная информация, которую пользователь может вывести на отображающее устройство по своему выбору, должна включать:
- название ИЭД, присвоенный ему номер и версию документа (если необходимо);
- уровень доступа к ИЭД, который должен демонстрироваться пользователю при его первом обращении к ИЭД;
- дату выпуска, дату последнего и всех предыдущих внесенных в ИЭД изменений;
- номер редакции ИЭД (если необходимо);
- организацию-разработчика;
- организацию, осуществлявшую технический контроль ИЭД;
- организацию, ответственную за управление конфигурацией оборудования или системы;
- порядок получения дополнительных копий и формат этих копий;
- уведомление об ограничении на экспорт (если необходимо);
- перечень документов и технических руководств, на которые сделаны ссылки в ИЭД, но которые не вошли в состав ИЭД;
- пояснения, касающиеся изделия, к которому относится поставляемое ИЭД, вариантов его конфигурации и их идентификации.
16.5 ИЭД должен иметь четко сформулированное описание области применения, которое однозначно идентифицирует конкретную систему, оборудование или компоненты, к которым оно относится, и указывает уровень обслуживания, для которого оно предназначено. Эти сведения должны ясно указывать, к какому классу изделий, перечню моделей изделий, серийным номерам изделий относится ИЭД.
16.6 Содержание ИЭД должно иметь указания для пользователя, облегчающие поиск нужной информации. Содержание должно быть организовано в логической последовательности представления информации и включать в себя необходимые ветви переходов. Пользователь должен иметь возможность доступа к нужной ему информации непосредственно из меню в содержании.
16.7 Справочная система ИЭД должна обеспечивать пользователю:
- доступ к контекстно-зависимой помощи, необходимой при выполнении определенных действий или в конкретных ситуациях;
- получение описательной информации с разъяснениями отдельных технических моментов, с объяснением специальных терминов;
- информационную помощь по пользованию ИЭД и ЭСО, например, как получить доступ к конкретной информации, как пользоваться функциями системы отображения;
- доступ к дополнительной информации, относящейся к техническому содержанию ИЭД.
Справочная система должна быть предусмотрена для всех разделов ИЭД и доступна в течение всего сеанса работы с ИЭД*.
16.8 Следует, при необходимости, предусматривать выполнение ИЭД вспомогательных функций (например, подготовки отчетов о проведенных мероприятиях по техническому обслуживанию, формирование перечня для заказа запасных частей и т.п.).
16.9 Техническая информация должна дополняться предостережениями, предупреждениями и примечаниями, выполняемыми в соответствии с ГОСТ 2.601. Сообщения с предупреждениями и требованиями мер предосторожности должны всегда выделяться и содержать в себе всю необходимую информацию о том, что нужно сделать, чтобы избежать или снизить степень опасности. Сообщения такого типа должны легко читаться и быть понятными в рабочей обстановке.
16.10 Для обеспечения ясности изложения информации, содержащейся в ИЭД, необходимо соблюдать следующие принципы:
- важную значимую информацию давать в виде описательного текста;
- когда описательный текст приводится совместно с графикой, для сокращения текста необходимо:
устранить все междометия,
начинать предложения с переходных глаголов,
по мере возможности применять повелительное наклонение;
- если нужно указать условие, предложение должно начинаться со слова "когда" (...когда напряжение питания стабилизируется ...) и т.д.;
- не рекомендуется использовать сложноподчиненные и сложносочиненные предложения. Длинные параграфы или предложения необходимо разбивать на части;
- средняя длина предложения не должна превышать 20 слов. Средний абзац не должен превышать шесть предложений. Каждый абзац, по возможности, должен иметь заглавное или основное предложение, весь материал в абзаце должен быть по этой теме;
- за исключением особых обстоятельств, следует строить объяснение операций с максимальным использованием графических и мультимедийных возможностей;
- описательный текст следует давать в логической последовательности выполнения работы;
- описательный текст должен быть выдержан в единой терминологии, едином стиле и формате во всем ИЭД;
- при описании работы устройств, имеющих обозначения на их собственных панелях управления, их следует называть только по именам, указанным на панелях. При необходимости допускается использование дополнительного комментария;
- диалоги должны быть организованы таким образом, чтобы выполнение последующих действий было бы возможным только после ввода ответа пользователя. Информация должна быть представлена в базе данных ИЭД таким образом, чтобы после вывода сообщения на экран и получения ответа, можно было бы произвести анализ ответа, определить потребности пользователя и предоставить ему необходимые данные.
16.11 При разработке графических и мультимедийных изображений для ИЭД следует руководствоваться следующими правилами:
- изображения должны разрабатываться с учетом общих требований к качеству и степени детальности графических изображений, необходимо предусматривать воспроизведение изображения на самых простых устройствах (с наименьшим экраном), предназначенных для применения в составе ЭСО;
- графическая информация (чертежи, иллюстрации) должна строиться по иерархическому принципу и состоять из логически связанных групп графических примитивов, совокупность которых образует графическое изображение;
- графические изображения, предназначенные для интерактивной работы, должны позволять пользователю манипулировать изображением для выбора отдельных элементов с целью детального просмотра;
- графические изображения должны содержать только то оборудование или деталь, к которому относится описываемое действие, а также некоторые элементы окружающей обстановки, которые должны помочь пользователю понять расположение искомой детали;
- графическое изображение следует выполнять под тем же углом зрения, под которым пользователь видит оборудование во время работы, или при выполнении конкретной операции. Если пользователь может смотреть на оборудование с нескольких позиций, следует выбрать угол, дающий наиболее полное представление о необходимой информации;
- графические изображения для указания местоположения интересующих пользователя деталей оборудования, на которые делается ссылка в технической информации, должны показывать, как выглядит конкретный предмет, а также его непосредственное окружение. Доступ к ним рекомендуется осуществлять автоматически в ходе воспроизведения технологической или описательной информации либо из меню.
Разрезы следует использовать только в тех случаях, когда без них невозможно показать точное место установки детали без разборки узла;
- выноски с экспликацией должны применяться для того, чтобы подчеркнуть на изображении особо важные места. Выноска содержит заголовок со стрелкой, идущей от обозначения детали к элементу оборудования на изображении. При этом следует придерживаться следующих правил:
выноска должна иметь стрелку, соединяющую обозначение с нужным местом на изображении,
выноска выводится на экран только тогда, когда она соответствует операции, высвеченной в тексте на экране,