Национальный стандарт РФ ГОСТ Р 54088-2017 "Интегрированная логистическая поддержка. Эксплуатационная и ремонтная документация в форме интерактивных электронных технических руководств. Основные положения и общие требования" (утв. и введен в действие приказом Федерального агентства по техническому регулированию и метрологии от 29 декабря 2017 г. N 2123-ст)

Integrated logistic support. Operating and maintenance documentation in interactive electronic technical manuals format. General provisions and general requirements

ОКС 01.040.01

Дата введения - 1 июня 2018 г.
Взамен ГОСТ Р 54088-2010

Предисловие

1 Разработан Акционерным обществом "Научно-исследовательский центр "Прикладная Логистика" (АО НИЦ "Прикладная Логистика") и Акционерным обществом "Летно-исследовательский институт имени М.М. Громова" (АО "ЛИИ им. М.М. Громова")

2 Внесен Техническим комитетом по стандартизации ТК 482 "Поддержка жизненного цикла экспортируемой продукции военного и продукции двойного назначения"

3 Утвержден и введен в действие приказом Федерального агентства по техническому регулированию и метрологии от 29 декабря 2017 г. N 2123-ст

4 Взамен ГОСТ Р 54088-2010

1 Область применения

Настоящий стандарт распространяется на промышленные изделия (далее - изделия) и устанавливает основные положения и общие требования к выпуску эксплуатационной и ремонтной документации в форме интерактивных электронных технических руководств.

2 Нормативные ссылки

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

ГОСТ 2.051 Единая система конструкторской документации. Электронные документы. Общие положения

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

ГОСТ 2.503 Единая система конструкторской документации. Правила внесения изменений

ГОСТ 2.601 Единая система конструкторской документации. Эксплуатационные документы

ГОСТ 2.602 Единая система конструкторской документации. Ремонтные документы

ГОСТ 2.603 Единая система конструкторской документации. Внесение изменений в эксплуатационную и ремонтную документацию

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

ГОСТ 19.101 Единая система программной документации. Виды программ и программных документов

ГОСТ 25866 Эксплуатация техники. Термины и определения

ГОСТ Р 53392 Интегрированная логистическая поддержка. Анализ логистической поддержки. Основные положения

ГОСТ Р 53394 Интегрированная логистическая поддержка. Термины и определения

ГОСТ Р 54089 Интегрированная логистическая поддержка. Электронное дело изделия. Основные положения и общие требования

Примечание - При пользовании настоящим стандартом целесообразно проверить действие ссылочных стандартов в информационной системе общего пользования - на официальном сайте Федерального агентства по техническому регулированию и метрологии в сети Интернет или по ежегодному информационному указателю "Национальные стандарты", который опубликован по состоянию на 1 января текущего года, и по выпускам ежемесячного информационного указателя "Национальные стандарты" за текущий год. Если заменен ссылочный стандарт, на который дана недатированная ссылка, то рекомендуется использовать действующую версию этого стандарта с учетом всех внесенных в данную версию изменений. Если заменен ссылочный стандарт, на который дана датированная ссылка, то рекомендуется использовать версию этого стандарта с указанным выше годом утверждения (принятия). Если после утверждения настоящего стандарта в ссылочный стандарт, на который дана датированная ссылка, внесено изменение, затрагивающее положение, на которое дана ссылка, то это положение рекомендуется применять без учета данного изменения. Если ссылочный стандарт отменен без замены, то положение, в котором дана ссылка на него, рекомендуется применять в части, не затрагивающей эту ссылку.

3 Термины, определения и сокращения

3.1 Термины и определения

В настоящем стандарте применены термины по ГОСТ 2.051, ГОСТ 25866, ГОСТ Р 53394, а также следующие термины с соответствующими определениями:

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

Примечания

1 Интерактивность отражает способность электронной системы отображения информации обеспечивать диалог с пользователем через пользовательский интерфейс системы путем генерации взаимных запросов пользователем и системой и выдачей ответов на эти запросы. Интерактивность обеспечивается наличием в электронной системе отображения необходимых элементов управления (кнопки, "флажки", поля для ввода данных и т.д.).

2 Английский эквивалент термина "интерактивное электронное техническое руководство" - interactive electronic technical manual.

3 Программно-технические средства в составе интерактивного электронного технического руководства включают электронную систему отображения и другие необходимые средства (например, драйверы, утилиты шифрования и др.).

3.1.2 электронная система отображения: Комплекс программных и технических средств для воспроизведения данных, содержащихся в интерактивном электронном техническом руководстве.

3.1.3 навигация: Способ просмотра содержания и оперативного поиска с помощью электронной системы отображения необходимых технических данных, содержащихся в интерактивном электронном техническом руководстве.

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

3.1.5 фильтрация: Способ подготовки для отображения данных, обладающих определенными признаками (по применимости, статусу, виду сведений и т.д.).

Примечание - Фильтрация применяется для ограничения объема отображаемых данных и экономии времени пользователя.

3.1.6

модуль данных: Совокупность взаимосвязанных технических сведений по эксплуатации изделия, относящихся к определенной тематике и не допускающих дальнейшего их дробления на составные части. [ГОСТ 2.601-2013, статья 3.1.10]

Примечание - Модуль данных представляет собой один из видов информационных объектов, хранящихся в общей базе данных эксплуатационной документации.

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

Примечания

1 Английский эквивалент термина "общая база данных эксплуатационной документации" - common source data base.

2 ОБДЭ представляет собой автоматизированную систему управления данными об изделии применительно к данным об эксплуатации и ремонте изделия.

3.1.8 информационный объект: Минимальный идентифицированный элемент данных в автоматизированной системе, имеющий один или более атрибутов.

3.1.9 автоматизированная система разработки эксплуатационной и ремонтной документации: Автоматизированная система, решающая задачи разработки, подготовки к поставке, хранения, преобразования и предоставления пользователю эксплуатационной и ремонтной документации (в том числе в виде интерактивного электронного технического руководства).

Примечания

1 Интерактивное электронное техническое руководство как результат работы рассматриваемой автоматизированной системы не входит в ее состав и используется в качестве самостоятельного средства обеспечения применения и технической эксплуатации изделия.

2 Общая база данных эксплуатационной документации является частью автоматизированной системы разработки эксплуатационной и ремонтной документации.

3.1.10 локальная база данных интерактивного электронного технического руководства: Часть данных (модули данных, документы и другие информационные объекты), выделенная из общей базы данных эксплуатационной документации для обособленного использования и хранения в составе интерактивного электронного технического руководства, передаваемого потребителю.

3.2 Сокращения

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

АЛП - анализ логистической поддержки;

АС - автоматизированная система;

БД - база данных;

ЖЦ - жизненный цикл;

ЗИП - запасные части, инструменты и принадлежности;

ИЭТР - интерактивное электронное техническое руководство;

МД - модуль данных;

МТО - материально-техническое обеспечение;

ОБДЭ - общая база данных эксплуатационной документации;

ТЗ - техническое задание;

РД - ремонтная документация;

СЧ - составная часть;

ТО - техническое обслуживание;

ТЭ - техническая эксплуатация;

ЭД - эксплуатационная документация;

ЭСО - электронная система отображения.

4 Основные положения

4.1 ЭД и РД разрабатывают как часть рабочей конструкторской документации по ГОСТ 2.601 и ГОСТ 2.602.

4.2 При выполнении ЭД (РД) в электронной форме ее представляют одним из двух способов:

а) в форме взаимосвязанной совокупности электронных ЭД (РД) по ГОСТ 2.051 или

б) в форме ИЭТР

4.3 В случае применения способа по 4.2 а) электронную ЭД (РД) представляют в общеупотребимых форматах (файлы PDF и т.п.), для работы с которыми используют стандартизованные программные средства (приложения) или аналогичные программы общего назначения в составе операционных систем вычислительных средств.

4.4 В случае применения способа по 4.2 б) для работы с ЭД (РД) используют специализированные программно-технические средства, поставляемые в составе ИЭТР.

4.5 Содержание и назначение ИЭТР определяются согласно требованиям к содержанию и назначению соответствующего вида ЭД или РД по ГОСТ 2.601 или ГОСТ 2.602. ИЭТР имеет такой же вид, как соответствующий ЭД (РД).

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

4.7 Состав и содержание данных для включения в ЭД и РД (ИЭТР) сложных изделий обосновывают в рамках АЛП по ГОСТ Р 53392.

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

4.9 Подготовку и внесение изменений в ИЭТР осуществляет разработчик изделия с учетом требований ГОСТ 2.503 и ГОСТ 2.603. Необходимые изменения вносятся в ОБДЭ, после чего из ОБДЭ формируется комплект изменений в локальную базу данных ИЭТР (совокупность новых МД/файлов и новых ревизий изменяемых МД/файлов). Как правило, внесение изменений осуществляют путем добавления новых МД/файлов или замены версий МД/файлов в локальной базе данных ИЭТР.

5 Общие требования

5.1 Задание требований к интерактивному электронному техническому руководству

Требования к ИЭТР устанавливают на основании настоящего стандарта с учетом требований ГОСТ 2.601 и ГОСТ 2.602. Эти требования должны быть увязаны с другими требованиями к изделию и системе его ТЭ. Разработчик изделия устанавливает требования к ИЭТР самостоятельно или по согласованию с заказчиком (заказчиками) конкретного типа изделия с учетом особенностей его конструкции, применения по назначению и ТЭ. При этом в ТЗ устанавливают:

- виды и комплектность ЭД (РД), выполняемых в форме ИЭТР (виды ИЭТР);

- функциональность ИЭТР;

- требования к содержанию и оформлению ИЭТР;

- требования к ЭСО;

- другие требования по усмотрению заинтересованных участников ЖЦ изделия.

5.2 Требования к видам и комплектности эксплуатационной документации (рабочей документации)

Виды и комплектность ЭД (РД), выполняемых в форме ИЭТР, устанавливают в соответствии с ГОСТ 2.601 для ЭД и ГОСТ 2.602 для РД, а также в соответствии с нормативными документами конкретных видов техники с учетом их специфики.

5.3 Требования к содержанию и оформлению интерактивного электронного технического руководства

5.3.1 Требования к содержанию ИЭТР устанавливаются в соответствии с ГОСТ 2.610 и нормативными документами, применяемыми для конкретных видов техники, в зависимости от вида(ов) ЭД (РД), выполняемого(ых) в форме ИЭТР.

5.3.2 Реквизитная часть информационных объектов в ОБДЭ и в локальной БД ИЭТР - по ГОСТ 2.058.

5.3.3 Для идентификации информационных объектов в ОБДЭ и в локальных БД в составе ИЭТР используют коды (например, код МД, код СЧ по каталогу, логистический контрольный номер СЧ и т.д.) определенного синтаксиса и формата.

5.3.4 Коды информационных объектов в ОБДЭ должны быть постоянными для всего ЖЦ изделия.

5.3.5 ИЭТР представляют в одной из двух форм: странично-ориентированной и полностью интерактивной.

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

Во втором случае ИЭТР содержит локальную БД. ЭСО в составе ИЭТР обеспечивает полноценное интерактивное взаимодействие пользователя с указанной БД.

5.4 Требования к функциональности интерактивного электронного технического руководства

5.4.1 Для подготовки конкретного вида ИЭТР, отвечающего по своим возможностям задачам использования и ТЭ определенного типа изделия, определяют необходимые функциональные характеристики ИЭТР по двенадцати категориям [1]:

а) доступ;

б) создание примечаний;

в) поставка (распространение);

г) контроль и прогнозирование;

д) внешние процессы;

е) использование графических объектов;

ж) создание ссылок;

ГАРАНТ:

Нумерация подпунктов приводится в соответствии с источником

и) навигация и отслеживание;

к) печать;

л) использование специальных сведений;

м) внесение изменений;

н) выбор режима работы пользователя.

5.4.2 В категории "доступ" задают требования в части разграничения доступа к данным между разными категориями пользователей.

5.4.3 В категории "создание примечаний" задают требования в части возможностей пользователей добавлять метки и примечания к тексту и графике ИЭТР.

5.4.4 В категории "поставка (распространение)" задают требования к способам передачи ИЭТР от поставщика к заказчику, а также способы доведения данных до конечных пользователей (эксплуатационного персонала заказчика). При установлении требований в этой категории учитывают располагаемые виды носителей информации и методы передачи данных, возможности существующей инфраструктуры и уровень подготовки пользователей к применению ИЭТР.

5.4.5 В категории "контроль и прогнозирование" задают требования в части функциональных возможностей ИЭТР для его использования при выявлении отказов и повреждений изделия и (или) прогнозировании их появления путем контроля предотказных состояний СЧ изделия или изделия в целом.

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

5.4.7 В категории "использование графических объектов" задают требования к способам взаимодействия с графической информацией, например:

- выбор и активация графических областей на схемах, чертежах и трехмерных моделях для детального отображения отдельных СЧ;

- организация ссылок из графических изображений на текстовую и табличную информацию, а также обратных ссылок;

- подсветка определенных соединений на электрических, гидравлических и иных схемах;

- графическое отображение результатов моделирования работы систем и СЧ изделия (в том числе анимированное изображение движения механических деталей и узлов, движение потоков рабочих тел, энергии и т.д.).

При установлении требований в этой категории учитывают, что более сложные графические представления могут увеличить стоимость ИЭТР и повысить требования к программно-аппаратным средствам.

5.4.8 В категории "создание ссылок" задают требования в части функциональных возможностей для организации переходов от одного элемента информации к другому (разные связи данных в составе ИЭТР), например переход по ссылке от содержания к указанному пользователем разделу или во внешние источники данных (например, для связи с БД материалов, оборудования и т.д.).

5.4.9 В категории "навигация и отслеживание" задают требования к применяемым методам навигации по содержанию ИЭТР, времени поиска нужных сведений, способам отслеживания истории работы с ИЭТР, установления закладок и т.п. При этом учитывают возможности использования как традиционных интерфейсов, так и голосовых команд, диалогового общения пользователя с ИЭТР, различных способов фильтрации, например фильтрации данных по наименованию типа, модели, идентификационному номеру (например, обозначению или заводскому номеру) изделия, номеру извещения об изменении (бюллетеня) или коду исполнителя работ и др.

5.4.10 В категории "печать" задают требования к организации с помощью ИЭТР печати ЭД (РД) в соответствии с требованиями к бумажной ЭД (РД) либо к печати отдельных элементов данных (таблиц, иллюстраций, снимков экрана и т.п.). Здесь же реализуют функции, обеспечивающие учет распечатанных на бумаге копий ЭД (РД).

5.4.11 В категории "использование специальных сведений" задают требования к воспроизведению с помощью программы просмотра дополнительных типов данных (например, аудио- и видеоданных или анимации). При установлении требований в этой категории учитывают, что включение возможности вывода более сложных мультимедийных данных может увеличить стоимость ИЭТР и повысить требования к программно-аппаратным средствам.

5.4.12 В категории "внесение изменений" задают требования к способам внесения изменений в данные, содержащиеся в ИЭТР, и способам их отображения ЭСО. При просмотре изменения могут отмечаться специальными метками и иными признаками.

5.4.13 В категории "выбор режима работы пользователя" задают требования к способам реализации в ИЭТР разных режимов работы пользователя, включая режимы доступа к внешним источникам данных. Как правило, функциональные возможности этой категории зависят от организации работ, производственного оснащения эксплуатанта изделия и возможностей программного обеспечения по взаимодействию с внешними источниками данных.

5.4.14 Дополнительные элементы требований к функциональным характеристикам ИЭТР по указанным в 5.3.1 категориям приведены в приложении А.

5.4.15 Для различных видов ИЭТР применяют разные виды требований из числа указанных в настоящем стандарте. Для систематизации требований к разным видам ИЭТР, выпускаемых для одного изделия, при составлении ТЗ, разработке, испытаниях и контроле качества ИЭТР рекомендуется использовать матрицу функциональности ИЭТР. В матрице используют установленные настоящим стандартом наименования категорий функциональных требований и оформляют ее в виде таблицы.

В заголовки столбцов таблицы (слева направо) помещают:

- "Функциональные требования";

- "Форма ИЭТР";

- "Наименование".

В столбце "Функциональные требования" в качестве заголовка каждой из строк таблицы помещают категории функциональности (виды функциональных требований) согласно 5.3.1 и приложению А к настоящему стандарту.

В столбце "Форма ИЭТР" для каждого вида ИЭТР указывают его выполнение: странично-ориентированное или интерактивное.

В столбце "Наименование" для каждого вида ИЭТР указывают применимые функциональные требования. Для этого в ячейках матрицы, находящихся на пересечении столбца с наименованием вида ИЭТР и строки с наименованием (видом) функционального требования, проставляют символы (например, "X" или "+"), указывающие на необходимость данной функциональности для данного вида ИЭТР.

5.4.16 Заполненная матрица функциональности содержит формализованные требования к функциональным характеристикам ИЭТР и может использоваться впоследствии при оценке соответствия ИЭТР заданным требованиям.

5.5 Требования к электронной системе отображения

5.5.1 На ЭСО, поставляемую в составе ИЭТР, разрабатывается комплекс программных документов в соответствии с ГОСТ 19.101. Виды программных документов устанавливаются разработчиком ИЭТР и согласуются с заказчиком.

5.5.2 ЭСО может включать справочную систему, предоставляющую необходимые технические сведения об использовании ИЭТР по запросу пользователя. Содержание и функциональность справочной системы устанавливаются разработчиком ИЭТР и согласуются с заказчиком.

Библиография

[1]

AC 1.1.S1000DR-2014

Международная спецификация на технические публикации, выполняемые на основе общей базы данных (International specification for technical publications using a common source database)