Классификация интерактивных электронных технических руководств

 

В зависимости от функциональности ИЭТР (ИЭТП), их подразделяют на 5 классов сложности в соответствии с ГОСТ Р 54088-2010:

 

Класс 1 - индексированные цифровые изображения страниц

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

Для создания ИЭТР 1 класса необходимо взять исходный текст и отсканировать его на сканере.

 

Класс 2 - линейно-структурированные электронные документы

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

Для создания ИЭТР 2 класса необходимо отсканированный текст распознать, вставить в MS Word или лучше в Microsoft Office Power Point, создать в нём содержание. После чего необходимо создать гиперссылки в этом содержании на аудио, видео или картинки.

 

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

Класс 3 - иерархически-структурированные электронные документы

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

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

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

Класс 4 - интегрированные ИЭТР

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

 

Класс 5 – ИЭТР с системой накопления данных

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

 

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

1) Индексированные цифровые изображения документов.

2) Линейно-структурированные электронные технические публикации (IETP-L).

3) Иерархически-структурированные электронные технические публикации (IETP-D).

4) Интегрированные электронные технические публикации (IETP-I).

5) WEB-ориентированные электронные технические публикации (IETP-X).

 

В рекомендациях Р5 0 .1.030-2001 рассматриваются требования к организации БД для поддержки интерактивных электронных технических руководств классов 3 и 4 (по ГОСТ Р 54088-2010 и класса 5).

В соответствии с требованиями ИСО 8879 структура БД описывается путем декларации (объявления) набора информационных объектов, составляющих БД, их атрибутов, связей и иерархии. Совокупность указанных объявлений в терминах SGML называется описанием логической структуры документа – DTD (Document Type Definition). Таким образом, БД любого ИЭТР представляет собой совокупность данных, логическая структура которых соответствует некоторому заданному DTD.

Пояснения:

1) DTD - файл, содержащий описание информационных объектов базы данных и их атрибутов, а также правил, которым должна удовлетворять логическая структура базы данных (Document Type Definition).

2) SGML - язык разметки текстовой информации (Standard Generalized Markup Language).

 

Формат представления информации в созданной с использованием языка SGML базе данных регламентирован международным стандартом STEP. В этом формате можно хранить объекты, выполненные в САПР:

- SolidWorks;

- AltiumDesigner;

- и др.

 

Язык разметки SGML

 

Основную роль в ИЭТР играют язык разметки текстовой информации SGML и XML.

SGML – документ состоит из трех частей:

- DTD (Document Type Definition) - набор правил, регламентирующих структуру документа;

- Document Instance - сами размеченные данные;

- Style sheet - таблица стилей.

 

Первая часть – DTD

Правила построения структуры документа DTD содержат правила, по которым строится логическая структура базы данных. DTD описывает типы данных (объекты) и их атрибуты и взаимосвязь. Описываемые в DTD элементы можно разбить на две группы:

– элементы первой группы предназначены для разбиения документа на смысловые модули,

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

Первую группу элементов назовем ассоциативным видовым уровнем, вторую группу – родовым уровнем элементов SGML.

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

 

Рис. 5 - Схема (структура) документа DTD

 

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

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

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

Вторая часть - размеченный документ SGML (Document Instance)

 

Размеченный документ SGML представляет собой текстовый файл, либо совокупность текстовых файлов, размеченных в соответствии с некоторым DTD.

Любой размеченный документ SGML должен начинаться с объявления типа документа:

 

<!DOCTYPE poem SYSTEM “defs.dtd”>

 

где после ключевого слова DOCTYPE указывается корневой элемент документа poem, затем (в большинстве случаев) ставится ключевое слово SYSTEM и указывается имя файла defs.dtd, в котором находится DTD. После такого объявления может идти непосредственно размеченный текст:

 

Третья часть - Таблица стилей (Style sheet)

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

- MIL28001 FOSI- (Formatted Output Specification Instance) – стандарт американского военного ведомства, используемый в интерактивных руководствах подрядчиков министерства обороны США;

- ISO DSSSL – (Dynamic Style, Semantic and Specification Language)- стандарт ISO, который, однако, не получил пока поддержки у производителей ПО;

- W3C CSS – (Cascading Style Sheets) – рекомендация WWW консорциума. Это популярный стандарт, используемый при разработке Web-страниц. Он широко поддерживается производителями.

 

Таким образом, подготовка ИЭТР включает:

1) разработку документа DTD, который определяет структуру документа;

2) разработку документа таблицы стилей CSS, который определяет разметку текста, цветовую палитру, способ отображения на дисплее и др.;

3) разработку структуры документа(Document Instance) на основе правил, регламентированных в DTD.

 

Структура базы данных ИЭТР

 

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

Информационные объекты условно разделены на два типа:

- общий (generic) и

- контекстный (content specific).

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

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

Для описания объектов обоих типов используются шаблоны (templates), регламентирующие перечень обязательных атрибутов объектов, а также иерархию (входимость и взаимосвязь) объектов как общего, так и контекстного типов. В структуре БД объекты общего типа находятся на нижнем уровне иерархии, как показано на рисунке 6.

Соответственно, DTD, описывающий информационный объект общего типа является DTD общего типа - единого для любых ИЭТР.

DTD контекстного типа представляет собой набор правил смысловой структуризации данных. Разработка DTD контекстного типа должна осуществляться для каждой предметной области и является объектом отраслевой стандартизации.

 

 

Рис. 6 - Логическая структура БД ИЭТР

 

Описание документа SGML

 

Размеченный документ SGML представляет собой текстовый файл либо совокупность текстовых файлов, размеченных в соответствии с некоторым DTD. Любой размеченный документ SGML должен начинаться с объявления типа документа:

 

<!DOCTYPE techdesc SYSTEM “defs.dtd”>

 

или

 

<!DOCTYRE techdesc PUBLIC “-//RUS-CALS //DTD Content Data Model //EN ”>

 

где после ключевого слова DOCTYPE указывается корневой объект документа, затем ставится ключевое слово SYSTEM или PUBLIC и указывается местоположение DTD.

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

Пример размеченного текста:

 

<AUTHOR N=1> Жегалкин Иван Владимирович </ AUTHOR >

<AUTHOR N=2> Петров Андрей Владимирович </ AUTHOR >

<TITLE> Введение в языки разметки <TITLE>

<DATE> 1989 год </DATE>

<СОМТЕМТ> Под языками разметки понимается....

 

Объектом является часть размеченного текста, включающая в себя открывающий и закрывающий теги, а также все данные, находящиеся между ними.

Объект может включать в себя другие объекты.