Руководства, Инструкции, Бланки

интерактивные электронные технические руководства img-1

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

Категория: Руководства

Описание

Электронная документация - Си Проект

Электронная документация

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

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

ИЭТР может содержать: текстовую информацию, рисунки, интерактивные схемы, чертежи, трехмерные модели и видеоролики.

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

На нашем предприятии создана и отработана технология разработки ИЭТР .

При создании ИЭТР необходимо учитывать требования различных стандартов (рекомендации Госстандарта Р 50.1, международный S1000D и т.д.). Для просмотра наших ИЭТР не требуется специального программного обеспечения.

Мы разработали более 5000 ИЭТР, среди наших Заказчиков крупнейшие отечественные предприятия (конструкторские бюро, заводы, институты).

ЗАО "Си Проект" выполняет полный цикл работ в рамках разработки ИЭТР:

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

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

Другие статьи

Вопросы разработки эксплуатационной документации в виде интерактивных электронных документов

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

В рамках военно-технического сотрудничества нашей страны с иностранными государствами многие зарубежные заказчики в контрактах на поставку оборонной продукции требуют, чтобы эксплуатационные документы (ЭД) поставлялись в электронной форме, а содержащаяся в них информация была доступна эксплуатирующему персоналу в интерактивном режиме. Реализация этих требований для многих российских организаций, особенно оборонно-промышленного комплекса, оказывается затруднительной. На то есть целый ряд причин. Одна из них — отсутствие четких и однозначных рекомендаций в стандартах Единой системы конструкторской документации (ЕСКД).

В статье «Электронный документооборот: достоинства и недостатки. Требования стандартов ЕСКД версии 2006 года к разработке и обращению документов в электронной форме» авторы рассмотрели трудности выполнения требований стандартов ЕСКД. При этом авторами только вскользь был затронут такой важный вопрос электронного документооборота, как выполнение ЭД в виде ИЭД. Вместе с тем многие отечественные организации при поставках за рубеж высокотехнологичной наукоемкой продукции, в частности оборонной, вынуждены оформлять поставляемые с продукцией ЭД в виде ИЭД.

Что такое ИЭД, ИЭТР, ИЭТП И ЭТД?

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

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

В ГОСТ 2.601-2006 термин ИЭТР определен как обобщенное название для взаимосвязанной совокупности ЭД, выполненных в форме ИЭД по ГОСТ 2.051 и, как правило, содержащихся в одной общей БД ЭД. Последняя определена как автоматизированная система хранения и управления модулями данных, входящими в состав ЭД на изделие, позволяющая по запросу получить в электронной или бумажной форме конкретный ЭД. ГОСТ 2.601 рекомендует выполнять эту БД с учетом требований АЕСМА 1000D «Международная спецификация требований к техническим руководствам, выполняемым с использованием общей базы данных». К сожалению, официальный перевод этого документа на русский язык в настоящее время отсутствует.

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

В проекте стандарта ГОСТ Р 5ХХХХ-2009 «Интегрированная логистическая поддержка. Требования к электронной эксплуатационной и ремонтной документации. Основные положения» появились новые термины: ЭТД — электронная техническая документация, ИЭТП — интерактивные электронные технические публикации (как дословный перевод аббревиатуры IETP (Interactive Electronic Technical Publication). Кроме того, в тексте проекта этого стандарта повсеместно используется словосочетание «электронные интерактивные эксплуатационные и ремонтные документы». Здесь уместно отметить, что термины ИЭТР и ИЭТП перекочевали в отечественные нормативные документы из различных источников: из американских стандартов MIL-M-87268, MIL-D-87269 и из спецификации АЕСМА 1000D соответственно.

По нашему мнению, количество терминов, применяемых в отечественных нормативных документах для обозначения электронных интерактивных ЭД, превышает разумные пределы. Это, безусловно, вызывает разночтения и затрудняет разработку электронных интерактивных ЭД в соответствии с требованиями стандартов ЕСКД. Вводя в действие стандарты, Росстандарт не отменил рекомендации. Поэтому нет полной ясности по следующим вопросам.

  1. Какими нормативными документами руководствоваться при выполнении электронной ЭД в виде ИЭТР?
  2. Какой термин (ИЭД, ИЭТР или ИЭТП) употреблять в отношении электронных ЭД, выполненных в форме, обеспечивающей доступ к информации в интерактивном режиме?
Классификация ИЭД

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

  1. структурированные;
  2. модульные;
  3. интегрированные;
  4. интернет-ориентированные.

В свою очередь, как следует из приложения Е к ГОСТ 2.601, приведенные выше типы ИЭД по функциональным возможностям подразделяются на четыре вида ИЭД, которые, по нашему мнению, практически совпадают с четырьмя классами ИЭТР, приведенными в рекомендациях Р 50.1.030, а именно:

  • класс 1 — индексированные цифровые изображения страниц;
  • класс 2 — линейно структурированные электронные документы;
  • класс 3 — иерархически структурированные электронные документы;
  • класс 4 — интегрированные ИЭТР.

Отметим, что в тексте приведенного в рекомендациях определения ИЭТР класса 2 имеется ссылка на термин «техническое руководство». Однако среди приведенных в ГОСТ 2.601 двенадцати видов ЭД такого документа нет.

Еще больше вопросов возникает, если проанализировать американскую систему IETM, предусматривающую разделение IETM на пять классов. Таким образом, в действующей отечественной нормативной документации отсутствует четкая, однозначная и понятная пользователям классификация ИЭД и ИЭТР.

Назначение и принципы разработки ИЭТР

Задачи, для решения которых предназначены ИЭД и ИЭТР, определены в стандарте ГОСТ 2.610 и в рекомендациях Р 50.1.029 и Р 50.1.030 соответственно. Некоторые из задач, на наш взгляд, довольно спорны. Это касается, например, «обучения персонала правилам эксплуатации, обслуживания и ремонта изделия». Вряд ли целесообразно перегружать ИЭТР несвойственными для него функциями обучения.

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

Задача «планирования и учета проведения регламентных работ» вызывает вопросы: как будет проводиться учет, необходимо ли разрабатывать специальное ПО для него, где будут храниться его результаты? Целый ряд вопросов порождает и задача «обмена данными между потребителем и поставщиком и др.»: например, какими данными, в каком формате? Может быть, подразумевается встраивание функции электронной почты? Можно предположить, что речь идет об информировании разработчиков о замеченных неточностях, недостатках и т.д.

Таким образом, в договорах на разработку ИЭТР необходимо уточнять все задачи, которые будет решать ИЭТР, а не ограничиваться формулировкой «ИЭТР должно обеспечивать решение задач, приведенных в разделе 16 ГОСТ 2.610».

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

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

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

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

Существуют два принципиальных подхода к созданию ИЭТР. Первый представляет собой неавтоматизированную сборку (например, методом copy-and-paste) с помощью различных программных средств и неструктурированных данных. Второй же предполагает высокую степень автоматизации операций за счет CALS-технологий, при этом необходимые структурированные данные об изделии выбираются из БД. Этот подход подразумевает использование PDM-системы и необходимую интеграцию с различными автоматизированными решениями, применяемыми в организации, в числе которых могут быть:

  • система управления данными об изделии;
  • система управления потоками работ и документов;
  • электронные архивы;
  • офисные системы и др.

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

В заключение отметим, что своевременное проведение с учетом затронутых выше вопросов корректировки стандартов ЕСКД позволит отечественным организациям успешно создавать электронные интерактивные ЭД на высокотехнологичную наукоемкую продукцию.

Жулинский Сергей Федорович

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

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

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

Особенности КА ДЗЗ как объекта для создания ИЭТР

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

  • КА ДЗЗ представляют сложную систему с большим количеством взаимосвязанных подсистем различного типа;
  • Потребителем ИЭТР может являться большое количество организаций с различной структурой и размерами;
  • Большая кооперация разработчиков, соответственно большой объем исходных данных разного типа, представленных различными способами в разных форматах;
  • Наличие на самых ранних стадиях проектирования постоянно наращиваемой трехмерной модели КА;
  • Большое количество систем в составе КА, нуждающихся в различных способах отображения в ИЭТР;
  • Большое количество подвижных элементов в конструкции КА.

Последние три пункта определяют требование к обязательному использованию в работе над изделием PDM-системы, централизованного хранения данных и высококачественной работы с трехмерной моделью. При этом моделирование должно осуществляться в соответствии с единой нормативной и руководящей документацией, в частности ГОСТ 2.052-2006 [5].

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

Наиболее распространенным способом представления информации об изделии ее потребителям в нашей стране является бумажный носитель и бумажно-ориентированные электронные документы.

Примером такого ИЭТР может служить документ, фрагмент которого представлен на рис.2.

Рис. 2. Фрагмент бумажно-ориентированного технического руководства.

В данном документе описывается технология работ с КА ДЗЗ начиная с момента доставки на космодром. В нем приведен перечень монтажно-сборочных операций с КА, дано их текстовое описание, а также иллюстрации, разъясняющие суть этих операций. Документ представлен в бумажном и электронном виде (сканированные копии и файлы в формате программы разработки) и предназначен для широкого круга специалистов. Таким способом описываются практически все операции с КА на различных стадиях жизненного цикла. Фактически этот и подобные документы являются ИЭТР класса 1. Как правило такой документ создается на начальном этапе создания изделия и в дальнейшем многократно корректируется. Соответственно, трудоемкость создания подобных документов ракетно-космической техники составляет 50-100 человекодней на одну операцию. Количество производимых операций с изделием зависит от его сложности.

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

Технологии и программное обеспечение для ИЭТР

Большинство разработчиков программного обеспечения в области САПР предлагают набор решений для создания ИЭТР. Кроме того есть и отдельные разработчики специализирующиеся только на ИЭТР. Например российская фирма Cortona, являющаяся одним из мировых лидеров в области ПО для ИЭТР [6].

Лидеры в области «тяжелых» САПР Dassault Systemes, Parametric Technology Corp и Siemens PLM Software имеют целый набор программ и технологий для создания ИЭТР.

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

Методика создания интерактивной анимации монтажно-сборочных операций с КА ДЗЗ

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

Процесс создания такой анимации, как правило, наиболее трудоемкая часть работы с трехмерной моделью. Обычно она составляет около 20-25 процентов времени от создания самой модели. При этом следует учитывать, что фотореалистичная анимация требует еще и существенного машинного времени на рендеринг - процесс получения изображения по модели с учетом положения точки наблюдателя, информации об освещении, физических свойств материалов. Создание такой анимации ведется с помощью специализированного ПО и требует значительных временных и материальных затрат. Необходимость таких работ обусловлена маркетинговыми целями и в основном ведется для демонстрации заказчику возможностей изделия до его создания. Для обеспечения процесса разработки изделия требуется инженерная анимация, целью создания которой является всестороннее понимание сложной технической системы, которой является КА.

Рассмотрим вариант методики создания интерактивной анимации монтажно-сборочных операций на примере КА ДЗЗ, разрабатываемого в настоящий момент. Данная методика позволяет создавать интерактивную анимацию как один из составляющих элементов ИЭТР класса - 4. При этом важно отметить, что при разработке интерактивной анимации по данной методике не требуется привлечения специализированного ПО: для создания трехмерной модели используется Компас-3D с подключенной библиотекой анимации, для хранения составляющих модели, данных об изделии и файла сценария используется система Лоцман.

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

Все движения элементов модели, а также исключения и включения, задаются с помощью переменных с использованием таблицы.

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

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

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

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

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

Предлагаемая методика ориентирована на использование связки Компас-Лоцман, однако подход является универсальным и может быть распространен и на другие CAD и PDM-системы с учетом особенностей применяемых программ.

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

  • Задание всех подвижных, включаемых или исключаемых элементов с помощью таблицы переменных;
  • Использование библиотеки анимации для осуществления операций внутри сборки (движение, перемещение, вращение и др.);
  • Создание файла сценария формате XML. Если требуется повторить все операции с другой аналогичной сборкой, достаточно аналогичным параметрам задать переменные используемые в сценарии и откорректировать граничные значения переменных.

На рис. 3. показаны такелажные работы с КА. Движение крюков крана по сооружению задано с помощью переменных. Используется библиотека анимации.

Рис. 3 Моделирование такелажных работ с КА

Заключение

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

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

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

Описанная методика позволяет перевести описание работ с изделием, сформированное в виде ИЭТР класса 1, в ИЭТР класса 4. При этом использование интерактивной анимации и формализованного файла сценария позволяет уменьшить время создания и поддержания в актуальном состоянии ИЭТР в 2-3 раза.

Выполнено с поддержкой по ФЦП «Научные и научно-педагогические кадры инновационной России на 2009-2013 годы».

Список литературы
  1. http://katalit.ru/ietr.html
  2. А.Ф. Колчин, Интерактивные электронные технические руководства, Pcweek (317)47`2001.
  3. Р 50.1.030-2001. ИНТЕРАКТИВНЫЕ ЭЛЕКТРОННЫЕ ТЕХНИЧЕСКИЕ РУКОВОДСТВА. Требования к логической структуре базы данных
  4. http://www.calscenter.com/calstech/techguid.htm
  5. ГОСТ 2.052-2006 Электронная модель изделия.
  6. http://www.cortona3d.com
Ключевые слова