9 - 2018

Качественным изделиям — качественная техническая документация. Обзор программных средств RapidAuthor

Ольга Кузнецова
Ольга Кузнецова, к.э.н., защитила диссертацию в ВАВТ на тему: «Управление отраслевыми рисками в промышленности: методика оценки и пути совершенствования» в 2014 году; ведущий специалист компании Cortona3D

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

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

Необходимость сокращения затрат и повышения конкурентоспособности продукции обусловливает интерес предприятий к современным программам для технических публикаций, которые позволяют быстро создавать интерактивные 3D­ и 2D­каталоги запасных частей, интерактивные электронные технические руководства (ИЭТР) по обслуживанию и ремонту, повторно используя уже имеющиеся на предприятии 3D/CAD­ и PDM­данные (рис. 1).

Рис. 1. Текстовое описание процедуры и 3D-анимация синхронизированы в ИЭТР

Рис. 1. Текстовое описание процедуры и 3D-анимация синхронизированы в ИЭТР

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

Современный подход к созданию технической документации: в 3 раза быстрее, на 60% эффективнее

Стандартный подход, сложившийся за прошедшие десятилетия к созданию технической документации, особенно качественной технической документации на высокотехнологичные изделия, требует много времени и ресурсов предприятия. Основной причиной является то, что документация создается уже по окончании конструкторских работ, то есть при наличии полностью готовой 3D­модели, если используются скриншоты с трехмерных изделий, или после выпуска первого образца продукции, если делаются фотографии. В случае последующих изменений в проекте требуется значительное время на переработку документации, а инженерам приходится выполнять несвойственную им работу — создание скриншотов с трехмерных моделей изделия.

Рис. 2. Каталог запасных частей в iPad

Рис. 2. Каталог запасных частей в iPad

Качественно иной подход к технической документации возможен с использованием современных программных средств, таких как RapidAuthor от компании Cortona3D (www.cortona3d.com). RapidAuthor — это инновационный инструментарий для производителей, позволяющий создавать все элементы интерактивной технической 3D/2D­публикации в одном приложении. Благодаря тому, что программа позволяет работать с 3D­моделью, текстом, создавать 2D­иллюстрации с 3D­модели щелчком мыши, автор может создать одновременно трехмерную публикацию для электронного отображения в формате HTML и двумерную публикацию в PDF в соответствии с ГОСТ. Новый подход к созданию технических публикаций предполагает прежде всего эффективное использование уже существующих CAD­, PDM­ и ERP­данных, что позволяет существенно сократить сроки и расходы на разработку документации. Кроме того, создание текста и иллюстраций в значительной мере автоматизировано — автору не требуется выполнять ручное копирование и вставку.

Одним из самых затратных процессов для производителя оборудования является процесс управления данными о деталях, поэтому приходится соблюдать баланс между необходимостью располагать точными данными о деталях и затратными методами получения и распределения таких данных. В RapidAuthor список деталей будет создан автоматически из существующих PDM­данных, что позволяет легко поддерживать каталоги запасных частей в актуальном состоянии (рис. 3).

Рис. 3. В RapidAuthor автор может одновременно создать трехмерную публикацию для электронного отображения в формате HTML и двумерную публикацию в PDF в соответствии с ГОСТ

Рис. 3. В RapidAuthor автор может одновременно создать трехмерную публикацию для электронного отображения в формате HTML и двумерную публикацию в PDF в соответствии с ГОСТ

Пакет программ RapidAuthor состоит из специализированных модулей RapidWorkInstruction, RapidCatalog, RapidManual, RapidLearning, которые включают функции и шаблоны для эффективного создания документации на всем жизненном цикле изделия: рабочие карты, интерактивные инструкции по сборке, инструкции по обслуживанию, замене и ремонту деталей, интерактивные 2D­ и 3D­каталоги запасных частей, а также обучающие тренинги. RapidAuthor позволяет создавать текст, 3D­анимации с описанием шагов, интерактивными предупреждениями, растровые и векторные изображения с возможностью редактировать выноски, активные зоны, виды и сечения. В программе много автоматизированных функций: анимация создается с использованием библиотеки базовых действий («открутить», «прикрутить» и др.), а также мастера разобранных видов и обратной процедуры сборки­разборки изделия; автоматически генерируются 2D­иллюстрации на конец/начало каждого шага 3D­процедуры; автоматически создается текст (описание шагов с деталями) на основе анимаций, а также выноски в соответствии с ведомостью материалов. Таким образом, автору остается внести только недостающую информацию, при этом исключается вероятность внесения человеком ошибок при переносе номеров и названий деталей (рис. 4).

Рис. 4. Интерактивный 2D- и 3D-каталог запасных частей

Рис. 4. Интерактивный 2D- и 3D-каталог запасных частей

Для технических авторов наиболее трудоемкими процедурами являются поиск графического материала, а также отслеживание и внесение изменений в уже созданную документацию. В случае применения традиционного подхода к созданию технической документации, включающего поиск и множественные запросы иллюстраций от инженеров, запрос в ERP­системы и сравнение Excel­таблиц, автор тратит на поиск данных более половины всего времени, необходимого на разработку документации. Вторая половина времени тратится на переключение между отдельными программами для создания текста, 2D­иллюстраций и 3D­анимаций, а затем на компиляцию и связывание всех этих элементов на веб­портале. С RapidAuthor не требуется вручную вставлять картинки из инженерных программ ни при создании публикации, ни при ее обновлении. Единая среда RapidAuthor для создания 2D/3D­графики и текстовых описаний, а также многие автоматические функции облегчают работу авторам и существенно сокращают сроки создания документации. Каталог на сложное техническое изделие может быть создан одним автором в короткие сроки, так как процесс создания максимально автоматизирован с использованием существующих на предприятии 3D/CAD­моделей, а также ведомости материалов из PLM/ERP­систем. 3D­геометрия и ведомость материалов (Excel, XML и др.) автоматически связываются, 2D­виды с интерактивными выносками генерируются в RapidAuthor кликом мыши.

Интуитивно понятный русскоязычный или англоязычный интерфейс позволяет создавать публикации независимо от наличия опыта работы в CAD­системах. RapidAuthor поддерживает прямой импорт данных в различных CAD­форматах (CATIA, SOLIDWORKS, NX, JT, Creo и многие другие) с возможностью настройки параметров импорта метаданных. При импорте CAD­данные конвертируются в облегченный открытый формат VRML (стандарт ISO), который не может быть легко реконструирован в инженерные данные, что обеспечивает защиту интеллектуальной собственности разработчика и позволяет свободно распространять технические публикации по дилерской и сервисной сети.

Для публикаций предусмотрена возможность создания стилей, обеспечивающих единообразное оформление всей документации, а также поддержка отраслевых стандартов S1000D, ATA 2200, DITA. Пакет программ RapidAuthor включает готовые шаблоны для ускорения процесса разработки документов и возможность проверить, соответствует ли структура и компоненты документа требованиям стандарта к техническим публикациям. Поддерживается создание публикаций в форматах 2D/3D PDF, HTML и HTML5­публикаций, которые не требуют для просмотра установки плагинов для web­браузеров, а также сохранение публикации как видео, iOS­публикации и AR­публикации. 2D­иллюстрации могут быть сохранены отдельно в форматах SVG, JPEG, PNG, TIFF и GIF.

Решения Cortona3D ориентированы на компании, которые производят много вариантов изделий или получают от сервиса — обслуживания изделий, замены и предоставления запасных частей — более 20% оборота, так как в RapidAuthor создаются лучшие интерактивные каталоги запасных деталей как в 2D, так и в 3D, как в PDF, так и в HTML/HTML5. Кроме того, RapidAuthor активно используется в отраслях, производящих сложные изделия с большим количеством деталей и с длительным циклом производства, в течение которого вносятся изменения. К таким отраслям относятся авиационная, космическая, оборонная, судостроительная промышленность. При традиционном подходе нецелесообразно начинать создание документации одновременно с разработкой изделия, так как внесение изменений на последнем этапе только удвоит затраты. При этом если начать создание документации в последний момент, то сроки выпуска изделия заметно удлинятся. RapidAuthor позволяет эффективно управлять изменениями в технической документации, поэтому разработка документации может осуществляться одновременно с конструированием изделия.

Управление изменениями в технической документации

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

Вышедшая в сентябре 2018 года версия RapidAuthor (11.0) включает интеллектуальное автоматическое обновление данных — Smart Automatic Update, которое позволяет синхронизировать изменения в инженерных данных с технической документацией. Процесс обновления и поддержания документации в актуальном состоянии, а также создание документации под модифицированный продукт теперь не зависит от множества запросов иллюстраций и других исходных данных — достаточно импортировать файл с модифицированной сборкой (рис. 5).

Рис. 5. Изменения в инженерных данных точно отражаются в технических публикациях — в 3D-графике, в ведомости материалов, в 2D-графике, выносках, анимациях и разобранных видах

Рис. 5. Изменения в инженерных данных точно отражаются в технических публикациях — в 3D-графике, в ведомости материалов, в 2D-графике, выносках, анимациях и разобранных видах

О компании Cortona3D

Cortona3D (www.cortona3d.com) является мировым лидером в области разработки 3D­решений для создания интерактивной эксплуатационной документации — руководств по обслуживанию и ремонту, каталогов деталей, обучающих курсов, технологических карт. Документация создается в соответствии с международными стандартами S1000D, ATA, DITA, SCORM.

Решения Cortona3D ориентированы на отрасли, производящие сложную технику: авиационную, аэрокосмическую, оборонную, автопромышленную, и позволяют сократить сроки создания документации более чем в три раза, а расходы на ее создание — более чем на 60%. В числе клиентов компании — Боинг, Аэробус, Европейское космическое агентство, ПАО «КАМАЗ».

Процесс обновления данных в RapidAuthor не требует соблюдения единого наименования и хранения в одной и той же папке первоначального и обновленного файла, в отличие от аналоговых редакторов на рынке. Чтобы использовать процедуру обновления в RapidAuthor, автор импортирует новую версию всего исходного пакета данных, как правило, с указанием последующего номера сборки. Алгоритм интеллектуального обновления сравнивает и автоматически определяет расхождения между начальной и обновленной версией сборки. Мастер обновлений в RapidAuthor уведомляет автора об изменениях и позволяет просматривать, принимать или отклонять их. Изменения в инженерных данных точно отражаются в технических публикациях — в 3D­графике, в ведомости материалов, в 2D­графике, выносках, анимациях и разобранных видах, при этом ранее внесенные коррективы технического автора сохраняются. Smart Automatic Update позволяет компаниям обеспечить актуальность каталогов, эксплуатационных инструкций и технологических карт, а также быстро и эффективно создавать документацию под новую конфигурацию изделия с меньшими трудозатратами (рис. 6).

Рис. 6. Smart Automatic Update автоматически проверяет полноту и актуальность каталога запасных частей. Мастер обновлений проинформирует автора о расхождениях в обновленном и исходном файле и спросит, использовать ли обновленную деталь в каталоге или игнорировать изменения

Рис. 6. Smart Automatic Update автоматически проверяет полноту и актуальность каталога запасных частей. Мастер обновлений проинформирует автора о расхождениях в обновленном и исходном файле и спросит, использовать ли обновленную деталь в каталоге или игнорировать изменения

Преимущества RapidAuthor по сравнению с аналоговыми редакторскими программами:

  • интеллектуальный алгоритм обновления обеспечивает корректность расположения обновленных данных в дереве сборки, списке деталей;
  • файл новой версии сборки может иметь отличающееся от первоначально импортируемого файла имя и храниться в другой папке;
  • мастер обновления в RapidAuthor облегчит автору просмотр, принятие или отклонение изменений. Изменения могут быть подтверждены один за другим или приняты все;
  • геометрия, детали, узлы сборки могут быть перегруппированы в новой версии исходных данных и в проекте. При этом обновленные детали корректно отобразятся в дереве сборки, даже если они были перегруппированы автором;
  • широкий спектр исходных 3D­/CAD­форматов может быть импортирован и обновлен в проекте RapidAuthor;
  • при изменении исходных 3D­данных, списка деталей или метаданных в проекте будут автоматически изменены 3D­графика, DPL­таблица, выноски, дерево элементов и номера деталей; 2D­илюстрации и разобранные 3D­виды обновляются с помощью щелчка мыши;
  • все ранее внесенные коррективы технического автора сохранятся в проекте.

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

Эффективное повторное использование контента

Изделия могут поставляться в индивидуальных комплектациях под заказ, и техническая документация должна отражать все изменения. Очевидно, что многие процессы и конструкции повторяются, поэтому авторы стараются максимально использовать уже созданный контент. Для удобства технические авторы «разбивают» оборудование на более мелкие части — установочные единицы, которые могут быть повторно использованы в другой модификации продукта с некоторыми корректировками. Для каждой такой единицы создается модуль данных технической публикации. Корректно собрать модули данных в общий документ помогают международные XML­стандарты — S1000D и DITA. Стандарт DITA позволяет повторно использовать блоки информации в формате XML между документами, сохраняя при этом гибкость специализации этого контента для разных типов документов. В аэрокосмической и оборонной промышленности используют стандарт S1000D для обеспечения обмена модулями данных и ICN1 с партнерами и поставщиками.

RapidAuthor поддерживает разработку XML­контента в стандартах S1000D и DITA, совместимую с правилами и рабочими бизнес­процессами обмена данными. RapidAuthor предоставляет таблицы стилей DITA и S1000D для автоматического форматирования контента для вывода в HTML и PDF. Автор может создать дополнительные таблицы стилей, редактировать и управлять ими, а затем применять их к своему контенту на основе типов клиентов или документов. Также доступен предварительный просмотр PDF и HTML, что позволяет легко увидеть влияние изменений до окончательной публикации.

В сентябрьском релизе RapidAuthor 11.0 реализована возможность повторно использовать и создавать ссылки на иллюстрации и фрагменты документов из других модулей данных S1000D с предварительным просмотром ссылочного контента. Новая функциональность RapidAuthor позволяет в рамках одной программы управлять S1000D­контентом и эффективно повторно использовать фрагменты одного модуля данных в другом модуле данных. Изменения в одном модуле данных могут быть каскадированы в другие, связанные с ним, что облегчит процесс внесения изменений, снизит количество несоответствий в документации и повысит качество и своевременность разработки технической документации (рис. 7).

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

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

В пакет программ RapidAuthor 11.0 добавлена функциональность RapidPublisher, что позволит S1000D­авторам составлять и публиковать пакет учебных курсов, основываясь на иерархической структуре уроков, в соответствии со стандартом SCORM для использования в системе управления обучением (LMS).

При создании тренингов для обучения новоиспеченных специалистов могут использоваться уже существующие интерактивные трехмерные рабочие инструкции. Сценарии вопросов в RapidAuthor позволяют создать вопросы с несколькими вариантами выбора или вопросы с коротким ответом. Авторы могут применять условное ветвление, создавая разные пути обучения для слушателей, исходя из уровня ошибки. Обучающие курсы имеют три типа режима просмотра: демонстрацию, обучение, которое включает взаимодействие с 3D­моделью, и экзамен.

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

Рис. 8. Интерактивные 3D-тренинги создаются на основе уже имеющихся пошаговых процедур для рабочих карт, инструкций по обслуживанию, замене и ремонту деталей

Рис. 8. Интерактивные 3D-тренинги создаются на основе уже имеющихся пошаговых процедур для рабочих карт, инструкций по обслуживанию, замене и ремонту деталей

Создание документации в едином рабочем пространстве системы управления жизненным циклом продукта (PLM)

Публикация RapidAuthor идеально подходит для создания отдельных модулей данных, которые могут управляться в существующих у клиента PLM­ и CMS­системах. RapidAuthor может быть интегрирован со многими PLM­системами на основе разработанного API для интеграции с различными системами управления контентом или бесшовной интеграции в случае с версией продукта RapidAuthor for Teamcenter. Интегрированное решение позволяет внедрить процессы создания эксплуатационной документации в PLM­среду, где происходит разработка изделия. Благодаря синхронизации этих систем создание эксплуатационной документации начинается на этапе конструирования изделия, и в ней оперативно отражаются все инженерные изменения. В результате существенно сокращаются сроки подготовки документации, так как разработка документации начинается на этапе проектирования изделия; повышается ее качество, уменьшается риск использования устаревшей или противоречивой информации (рис. 9). 

Рис. 9. Преимущества единой информационной системы в процессе разработки и поддержания в актуальном состоянии эксплуатационно-технической документации

Рис. 9. Преимущества единой информационной системы в процессе разработки и поддержания в актуальном состоянии эксплуатационно-технической документации

1 ICN (Информационный контрольный номер) является уникальным идентификатором листа иллюстрации, мультимедийного объекта или прикрепленных данных и используется для задания взаимосвязей с одним или более модулями данных. ICN назначается разработчиком документации. Источник: Авиационный справочник. Международная спецификация на технические публикации, выполняемые на основе общей базы данных. ФГУП «НИИСУ» — 2013. Глава 4.4. С. 2060.