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

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

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

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

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

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

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

Требования к ИЭТР

Требования к ИЭТР регламентируются ГОСТ Р 54088-2017 , Авиационным справочником, международной спецификацией S1000D и другими документами. Если взять за основу ГОСТ 54088, можно выделить следующие классы требований:

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

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

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

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

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

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

У специалистов «Иторум» обширный опыт разработки ИЭТР различной сложности, а профессионализм и инициативность обеспечивают качественный результат в сжатые сроки. Оставьте заявку в форме обратной связи или позвоните по тел. 8495-120-80-55 и мы проконсультируем вас по всем вопросам разработки и использования ИЭТР.

Цель нашей работы — повысить эффективность вашего бизнеса!

За счет креативных решений, инноваций и целеустремленности.