Р 50.1.029-2001

Группа П87

     

РЕКОМЕНДАЦИИ ПО СТАНДАРТИЗАЦИИ

ИНФОРМАЦИОННЫЕ ТЕХНОЛОГИИ ПОДДЕРЖКИ ЖИЗНЕННОГО ЦИКЛА ПРОДУКЦИИ


ИНТЕРАКТИВНЫЕ ЭЛЕКТРОННЫЕ ТЕХНИЧЕСКИЕ РУКОВОДСТВА

Общие требования к содержанию, стилю и оформлению

Continuous acquisition and life-cycle support. Interactive electronic
technical manuals. General requirements for content, style and user-interaction

ОКС 25.040.40

ОКСТУ 4002

Дата введения 2002-07-01

     

Предисловие

1 РАЗРАБОТАНЫ Научно-исследовательским центром CALS-технологий "Прикладная логистика" при участии Всероссийского научно-исследовательского института стандартизации (ВНИИстандарт)

ВНЕСЕНЫ Техническим комитетом по стандартизации ТК 431 "CALS-технологии"

2 ПРИНЯТЫ И ВВЕДЕНЫ В ДЕЙСТВИЕ Постановлением Госстандарта России от 2 июля 2001 г. N 256-ст

3 ВВЕДЕНЫ ВПЕРВЫЕ

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

Настоящие рекомендации устанавливают общие требования к содержанию, стилю и оформлению интерактивных электронных технических руководств (ИЭТР).

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

     2 Определения

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

2.1 база данных: Организованное управляемое хранилище технической информации.

2.2 информационный объект: Смысловая и структурная единица технической информации.

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

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

     3 Сокращения

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

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

CALS - Continuous Acquisition and Life-cycle Support;

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

     4 Общие положения

4.1 Интерактивные электронные технические руководства

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

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

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

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

ИЭТР предназначены для решения следующих задач:

- обеспечения справочным материалом об устройстве и принципах работы изделия;

- обучения персонала правилам эксплуатации, обслуживания и ремонта изделия;

- обеспечения персонала справочными материалами, необходимыми для эксплуатации изделия, выполнения регламентных работ и ремонта изделия;

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

- диагностики оборудования и поиска неисправностей;

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

- планирования и учета проведения регламентных работ;

- обмена данными между потребителем и поставщиком.

4.2 Взаимодействие между ИЭТР и электронной системой отображения

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

4.3 Общие требования к содержанию и стилю ИЭТР

4.3.1 Общие требования к содержанию ИЭТР

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

4.3.2 Требования, относящиеся к техническим функциям

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

4.3.3 Общие требования к стилю ИЭТР

Требования к "стилю" ИЭТР определяют:

а) требования языкового характера (грамматика, синтаксис, применяемый словарь, критерии отбора технической терминологии, нумерация, сокращения);

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

4.3.4 Общие требования к интерактивному взаимодействию с пользователем

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

а) требования к функциям управления дисплеем (окна, курсор, прокрутка и т.д.);

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

     5 Требования к базам данных ИЭТР

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

База данных ИЭТР должна отвечать требованиям, изложенным в 5.1-5.6.

5.1 Текст

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

5.2 Таблицы

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

5.3 Графическая информация

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

5.4 Диалоги

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

5.5 Ссылки для снижения избыточности объема информации

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

5.6 Контекст

Контекстно зависимая фильтрация должна использоваться для обеспечения возможности выдачи пользователю только той информации, которая относится к данной конкретной конфигурации изделия или конкретной ситуации.

     6 Требования к содержанию ИЭТР

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

В 6.2-6.9 установлены общие требования к представлению вспомогательной информации, предупреждений, предостережений и замечаний.

6.2 Вспомогательная информация, относящаяся к техническим аспектам

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

6.3 Административная информация

Все ИЭТР должны содержать следующую административную информацию, которую пользователь может вывести на отображающее устройство по своему выбору:

- название ИЭТР, присвоенный ему номер и версию документа (если необходимо);

- уровень доступа к ИЭТР, который должен демонстрироваться пользователю при его первом обращении к ИЭТР;

- дата выпуска, дата последнего и всех предыдущих внесенных в ИЭТР изменений;

- номер редакции ИЭТР (если необходимо);

- организация-разработчик;

- организация, осуществлявшая технический контроль ИЭТР;

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

- адрес для сообщений с замечаниями и предложениями;

- порядок получения дополнительных копий и их формат;

- список рассылки;

- уведомление об ограничении на экспорт (если необходимо);

- перечень документов и технических руководств, на которые сделаны ссылки в ИЭТР, но которые не вошли в состав ИЭТР;

- пояснения, касающиеся изделия, к которому относится поставляемое ИЭТР, вариантов его конфигурации и их идентификации.

6.4 Описание области применения