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

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

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

16 Общие правила выполнения интерактивных эксплуатационных документов

16.1 Как правило, ИЭД является объединенным документом и предназначен для:
- обеспечения справочным материалом об устройстве и принципах работы изделия;
- обучения персонала правилам эксплуатации, обслуживания и ремонта изделия;
- обеспечения персонала справочными материалами, необходимыми для эксплуатации изделия, выполнения регламентных работ и ремонта изделия;
- обеспечения информацией о технологии выполнения операций с изделием, потребности в необходимых инструментах и материалах, количестве и квалификации персонала;
- диагностики оборудования и поиска неисправностей;
- обеспечения заказа материалов и запасных частей;
- планирования и учета проведения регламентных работ;
- обмена данными между потребителем и поставщиком и др.
16.2 Данные ИЭД предоставляются конечному пользователю через ЭСО - комплекс программных средств, обеспечивающий визуализацию содержащейся в ЭД информации и интерактивное взаимодействие с пользователем.
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 слов. Средний абзац не должен превышать шесть предложений. Каждый абзац, по возможности, должен иметь заглавное или основное предложение, весь материал в абзаце должен быть по этой теме;