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

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

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

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

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

16.21 ЭД, получаемые с использованием устройств вывода ЭВМ, выполняют с учетом требований ГОСТ 2.004 [из 16.21 ГОСТ Р 2.610–2019]

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

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

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

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

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

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

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

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

Справочная система должна быть предусмотрена для всех разделов ИЭД и доступна в течение всего сеанса работы с ИЭД.

Примечание — Как правило, доступ к справочной системе ИЭД выполняют в виде функции «подсказка».

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