Интерактивная электронная техническая документация

Преступая к прочтению статьи, посвященной интерактивной электронной технической документации, важно понимать, что не зависимо от формы представления документа первично его содержание. Интерактивные электронные технические документы — это форма представления их бумажных аналогов. Поэтому требования к содержательной составляющей документа для бумажной и интерактивной электронной формы представления идентичны. Требования к содержательной части документа регламентируются различными общемашиностроительными (ГОСТ 2.601, ГОСТ 2.602, ГОСТ 2.610), военными (ГОСТ 002-601-2008, ГОСТ 002-602-2008) стандартами, отраслевыми и другими нормативными документами.

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

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

Помимо вышеназванных, существуют и другие преимущества, которые логично вытекают из требований к интерактивным электронным документам, которые будут рассмотрены ниже.

Требования к интерактивным электронным техническим документам регламентируются рядом нормативных документов (Р50.1.029 – 2001, ГОСТ 54088-2010, Авиационной справочник, S1000D и рядом других).

В соответствии с ГОСТ 54088-2010 выделяются следующие классы требований к интерактивным документам:

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

В соответствии с текстом стандарта при описании требований к виду и комплектности документации, ее содержанию и стилю оформления, а также при формировании требований к электронной системе отображения должны использоваться ГОСТ 2.601, ГОСТ 2.602 и ГОСТ 2.610. При этом требования к функциональности интерактивной электронной документации в тексте стандарта описано достаточно подробно.

В соответствии с текстом стандарта, требования к функционалу интерактивной электронной документации включают следующие группы:

  1. Требования к порядку доступа к документации: описывают функциональные возможности в части разграничения прав доступа к документации.
  2. Требования к функционалу по созданию примечаний: описывают функциональные возможности, которые позволяют пользователю добавлять пометки и примечания к тексту и графике.
  3. Требования к функционалу, определяющему порядок поставки и распространения документа. Данная группа описывает способы передачи информации интерактивной документации от поставщика заказчику и способы передачи информации конечным пользователям.
  4. Требования к функционалу по диагностике и прогнозированию: описывают функциональные возможности интерактивной документации по идентификации неисправностей и прогнозированию вероятности их появления. При этом допускается использование самого широко спектра средств диагностики от одиночных простейших процедур выявления отказа (органолептически, по внешним проявлениям и т.п.) до интеграции документации со встроенными в изделие и внешними средствами объективного контроля и диагностики.
  5. Требования по взаимодействию с внешними процессами. Описывают функциональные возможности по интеграции с внешними системами, например, с системами управления материально-техническим обеспечением или системами управления процессами технического обслуживания и ремонта изделий.
  6. Требования к возможностям использования графических объектов. Описывают функциональные возможности по работе с графическими объектами, например, подсветка по ссылке из текста определенных соединений на электрических схемах, ссылки из графических объектов на текстовую информацию и т.к. Данные требования не стоит путать с требованиями к иллюстративной составляющей технической документации.
  7. Требования по установлению ссылок. Описывают функциональные возможности в части интерактивных переходов от одного элемента к другому по ссылкам, например, от содержания документа к конкретному разделу.
  8. Требования к навигации и отслеживанию. Описывают функциональные возможности в части навигации по содержанию документа примером такой функции может служить функция поиска по различным критериям в тексте документа.
  9. Требования по возможности печати. Описывают функциональные возможности по выводу интерактивного электронного документа на печать в соответствии с требованиями ГОСТ 2.601 и ГОСТ 2.602, предъявляемыми к бумажной форме представления интерактивных электронных документов.
  10. Требования к возможности использования специальных сведений. Описывают функциональные по возможности использования различных типов данных, например, аудио, видео и т.д.
  11. Требования к функционалу внесения изменений. Описывают функциональные возможности по внесению изменений в документацию различными способами в соответствии с требованиями нормативных документов, как на стороне разработчика, так и на стороне пользователя технической документации.
  12. Требования к режимам работы пользователя. Описывают функциональные возможности по вариантам обращения к содержательной части документа, например, по средствам web-браузера, по внутренней сети через программу-клиент и т.д.

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

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

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

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

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

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

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

Статьи по теме:

Об авторе Сергей Полиненко