11 - 2002

Электронная эксплуатационная документация: технологии и программные средства разработки и сопровождения

Андрей Петров, Илья Галин

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

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

Для решения этих и других задач разработан ряд технологий и методик, изложенных в международных стандартах и спецификациях. Методически полным примером является спецификация AECMA SPEC 1000D [REF] «Technical Publication based on Common Source Data Base» («Технические публикации на основе общей базы данных эксплуатационной документации»), разработанная Европейской ассоциацией производителей аэрокосмической техники. Универсальность подхода, принятого в AECMA SPEC 1000D, позволяет использовать методические положения спецификации и для других видов сложных изделий, вооружений и военной техники [DEF STAN 0060].

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

В ходе разработки документации создаваемые МД помещаются в общую базу данных (Common Source Data Base). При публикации документа из базы данных извлекается определенный набор МД, составляющих нужный документ в бумажной или электронной форме (Electronic Technical Publication). Электронная форма рассматривается как основная форма поставки и использования документации.

Спецификация AECMA SPEC 1000D оперирует следующими понятиями:

  • электронная техническая публикация (Electronic Technical Publication, ETP) — аналог книги в бумажном комплекте документации. Как правило, в различных отраслях существуют стандарты, регламентирующие перечень публикаций, поставляемых на изделия отрасли;
  • модуль данных (Data Module, DM) — совокупность взаимосвязанных технических сведений, относящихся к определенной тематике и не допускающих дальнейшего их дробления на составные части. Типовыми МД являются, например, технологическая карта, описание узла в изделии, регламент технического обслуживания отдельного агрегата или подсистемы и т.п. Каждый тип МД имеет определенную структуру;
  • общая база данных эксплуатационной документации (Common Source Database, CSDB) — система хранения и управления МД, установленная у разработчика изделия и позволяющая по запросу получить комплект технических публикаций на изделие в электронной или бумажной форме;
  • перечень используемых публикаций (List Of Applicable Publications, LOAP) — перечень электронных публикаций или книг, составляющих комплект документации на изделие;
  • перечень действующих МД (List Of Effective Data Modules, LOEDM) — список МД, составляющих публикацию.

Общая структура электронной эксплуатационной документации представлена на рис. 1.

Как уже было отмечено, МД содержит идентификационно-статусную (атрибутивную) и содержательную (технические сведения) части. МД имеет идентификационный код, содержание которого раскрыто ниже. Логическая структура данных для МД каждого типа задана в виде информационной модели (Document Type Definition) на языке SGML.

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

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

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

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

К служебным МД относятся:

  • титульный лист;
  • перечень действующих МД (таким образом, перечень действующих МД сам тоже является модулем данных);
  • перечень внесенных изменений;
  • перечень сокращений;
  • перечень терминов;
  • перечень символов;
  • нормативные ссылки;
  • содержание.

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

Наиболее важной отличительной особенностью подходов, предложенных в стандартах AECMA 1000D и DEF STAN 00-60, является введение механизмов кодирования МД. Любому МД, входящему в состав технической документации, присваивается уникальный код (рис. 2). В состав кода, как правило, входят следующие поля:

  • Условное обозначение типа изделия. Поле содержит эксплуатационное обозначение изделия или сразу нескольких изделий, принадлежащих к одному типу. В стандарте AECMA 1000D на это поле отводится два знака, и для получения такого идентификатора необходимо обратиться в Европейскую ассоциацию производителей аэрокосмической техники (к примеру, самолету-амфибии Бе-200 присвоено обозначение «BY»);
  • Код конфигурации изделия. В случае когда возможен выпуск изделия в разных конфигурациях, это поле указывает, для какой конфигурации применим указанный МД. Как правило, поле составляет один символ. Основная конфигурация обозначается большой латинской буквой A, дополнительные конфигурации — буквами B, C и т.д.;
  • Код стандартной системы нумерации. Этот код, как правило, представляет собой три поля, идущие через разделитель и обозначающие связку «система — подсистема — агрегат», либо, в другой интерпретации, «глава — раздел — тема». Более подробно стандартная система нумерации описана в ГОСТ 18675-79 для изделий авиационной техники и в ГОСТ 2.601-95 (Приложение Б) для других изделий машиностроения;
  • Информационный код. Код однозначно идентифицирует, к какому типу технических данных относится информация в МД. Функции информационного кода часто реализовывались в разных стандартах при помощи задания диапазона страниц на определенные типы технических сведений (например, в ГОСТ 18675-79 регламентируется: «Страницы с номерами 1-100 — описание и работа; 101-200 — текущий ремонт; 201-400 — обслуживание» и т.п.). Информационный код, как правило, состоит из нескольких сегментов, каждый из которых последовательно детализирует тип сведений в МД. В качестве примера рассмотрим, что обозначает информационный код «254» в стандарте AECMA 1000D:
    • первая цифра: 2 — обслуживание;
    • вторая цифра: 5 — очистка и окраска;
    • третья цифра: 4 — механическая очистка.

Внутри общей БД МД хранятся в нейтральном формате, как правило в формате SGML. Из одних и тех же МД можно скомпоновать электронные публикации различного типа или подготовить документ для печати. Процесс подготовки технических публикаций представлен на рис. 3.

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

  • IETP-L — линейно-структурированные электронные технические публикации. Электронные технические публикации данного типа представляют собой структурированную совокупность линейных документов с возможностями навигации по документам и поиска нужной информации. Под линейными документами понимаются документы без формализованной структуры содержания;
  • IETP-D — электронные технические публикации, основанные на применении баз данных. Электронные технические публикации этого типа предусматривают хранение всех технических сведений в некоторой базе данных нестандартизованной структуры, из которой по запросу пользователя можно сформировать МД для их просмотра на экране системы отображения;
  • IETP-I — интегрированные электронные технические публикации. Этот вид электронных публикаций предусматривает интеграцию с другими прикладными пакетами пользователя. Под XML-документом понимается текст, размеченный в соответствии с правилами языка разметки XML. Язык разметки XML является потомком языка SGML, имеющим усовершенствованный набор правил разметки.

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

Механизм исполнения извещений работает в следующем порядке:

  1. Создается новая версия МД, основанная на текущем содержании или независимая от предыдущей.
  2. Проводится ряд изменений в соответствии с извещениями (эти извещения должны быть указаны как причины изменений в статусной части новой версии МД).

При решении задач проведения изменений и сопровождения возникают следующие требования к программной реализации:

  • в системе подготовки ЭТП должна быть предусмотрена возможность автоматического формирования отчета о проведенных изменениях. В нем должен находиться список МД, в которых были проведены изменения и содержание этих изменений. Данная форма отчета облегчает навигацию по сопровождаемой документации и позволяет легко отслеживать обновления в электронных публикациях;
  • система подготовки ЭТП должна обеспечивать возможность поставки эксплуатанту пакетных изменений документации. Данный вид доставки обновлений подразумевает поставку только измененных МД и автоматизированное проведение изменений в ЭТП на стороне эксплуатанта.

В одном из ближайших номеров журнала в продолжение темы электронных технических публикаций будет рассказано о программном комплексе Technical Guide Builder v2.3. В этом программном продукте реализованы вышеизложенные принципы и технологии. Система подготовки ЭТП TGBuilder позволяет автоматизировать процесс создания публикации на различных стадиях, представляя собой гибкий и эффективный инструмент для коллективной работы.

«САПР и графика» 11'2002