Семейство продуктов Arbortext. Решение для разработки технической документации в соответствии с требованиями спецификации S1000D

Arbortext является уникальным продуктом позволяющим построить решения для автоматизации процессов разработки структурированной документации и автоматизированных обучающих систем. В настоящее время Arbortext состоит более чем из 16 программных модулей. Различные конфигурации данных модулей позволяют получать достаточно гибкие решения позволяющие разрабатывать практически любую структурированную документацию. Следуют заметить, что в настоящий момент наиболее востребованной и наиболее часто разрабатываемой и используемой структурированной документацией является техническая документация, разрабатываемая, как под требования отечественных стандартов (ГОСТ 2.601, 2.610, 2.611), так и под требования международных стандартов (S1000D), а также научно-техническая документация. На мой взгляд, наибольший интерес представляют решения, предназначенные для автоматизации процесса разработки различных видов технической документации, а также научно-технической документации.

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

Далее данные решения и наиболее интересные программные модули, входящие в состав Arbortext, будут рассмотрены более подробно.

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

Учитывая широкое распространение S1000D в странах НАТО, специалистами компании PTS разработано решение, позволяющее разрабатывать техническую документацию в соответствии с требованиями S1000D (Рисунок 1).

1_arbortext-for-s1000d

Рисунок 1

В общем случае в состав данного решения могут входить следующие программные модули:

  • Arbortext CSDB for S1000D.
  • Arbortext IsoDraw.
  • Arbortext Editor.
  • Arbortext Styler.
  • Arbortext Publishing Engine.
  • Parts Catalog Manager for S1000D.
  • Arbortext Provisioning Manager.
  • Arbortext LSA Interface for S1000D.
  • Arbortext Learning Content Manager for S1000D.

Ядром данного решения является общая база данных Arbortext CSDB for S1000D в которой хранятся все текстовая и графическая информация, а также различные служебные данные, предназначенные для корректного структурирования информации в соответствии с требования S1000D. Для создания и изменения текстовой и графической составляющей технической документации в состав данного решения включен Arbortext Editor и Arbortext IsoDraw соответственно. Конечный продукт или документация соответствующая требованиям S1000D может быть получена за счет использования Arbortext Publishing Engine, Parts Catalog Manager for S1000D и Arbortext Provisioning Manager. Стили отображения технической документации могут редактироваться с использованием Arbortext Styler.

Следует заметить, что в последнее время наметилась явная тенденция к сближению технической документации и задач обучения технической специалистов. Специалисты компании PTC, понимая актуальность данной тенденции, разработали специализированный программный модуль Arbortext Learning Content Manager for S1000D, который позволяет экспортировать разделы технической документации, разработанные в соответствии с требованиями S1000D в модуль данных обучающей системы в формате SCORM.

Кроме того, в состав данного решения входит специализированный программный модуль Arbortext LSA Interface for S1000D, который позволяет импортировать данные из базы данных анализа логистической поддержки в CSDB с целью их использования при разработке Illustrated Parts Catalogs в соответствии с требованиями S2000M.

Ниже данные программные модули будут рассмотрены более подробно.

Arbortext CSDB for S1000D
Arbortext CSDB for S1000D, является техническим решением, обеспечивающим полный цикл управления содержимым технической документацией, разрабатываемой в соответствии с требованиями международной технической спецификации S1000D. Внешний вид пользовательского интерфейса Arbortext CSDB for S1000D представлен на рисунке 2.

2_csdbРисунок 2

Arbortext CSDB for S1000D позволяет:

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

Arbortext Editor
Arbortext Editor – мощный XML редактор, который позволяет разрабатывать текстовую составляющую технической документации. Arbortext Editor интегрируется с Arbortext CSDB for S1000D и позволяет работать с графической и текстовой информацией напрямую из общей базой данных (CSDB). Кроме того, данная интеграция позволяет получать шаблоны разделов технической документации и создавать на их основе отдельные фрагменты технической документации. Внешний вид пользовательского интерфейса Arbortext Editor представлен на рисунке 3.

3_arbortext-editorРисунок 3

Arbortext Editor позволяет:

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

Arbortext IsoDraw
Arbortext IsoDraw – графический редактор, предназначенный для создания и просмотра технических иллюстраций. Arbortext IsoDraw позволяет разрабатывать качественные технические иллюстрации, как на основе бумажной документации, так и на основе 3D моделей изделия. Узкая направленность Arbortext IsoDraw, а также наличие механизма автоматического обновления технических иллюстраций, позволяет сократить сроки их разработки, получая в результате иллюстрации отвечающие требованиям мировых стандартов. Arbortext IsoDraw является незаменимым инструментом технического иллюстратора, художника-конструктора и любого другого специалиста разрабатывающего технические иллюстрации. Внешний вид пользовательского интерфейса Arbortext IsoDraw представлен на рисунке 4.

4_iso-drawРисунок 4

Arbortext IsoDraw позволяет:

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

Arbortext Styler
Arbortext Styler – редактор таблиц стилей, предназначенный для создания и редактирования таблиц стилей, использование которых позволяет за счет структурирования графической и текстовой информации, содержащейся в Arbortext CSDB for S1000D, получить техническую документацию пригодную для использования конечным пользователем. Данный редактор позволяет создавать и редактировать следующие таблицы стилей: XSL (XSL-FO and XSLT), XML Schema. Внешний вид пользовательского интерфейса Arbortext Styler представлен на рисунке 5.

5_stylerРисунок 5

Arbortext Styler позволяет:

  • за счет однократного создания стилевого оформления технической документации и его повторного использования сократить затраты на создания конечного технического документа, пригодного для использования конченым пользователем;
  • избавить технического писателя от необходимости подбирать стилевое оформление конечного документа;
  • подготавливать таблице стилей для публикации технической документации в различные форматы (HTML, PDF, MS Word и др.).

Arbortext Publishing Engine
Arbortext Publishing Engine – программный модуль, предназначенный для преобразования на основе таблиц стилей, разработанных с использованием Arbortext Styler, текстовых и графических данных, содержащихся CSDB, в форму пригодную для использования конечным пользователем документации и соответствующую требованиям нормативной документации. Внешний вид пользовательского интерфейса Arbortext Publishing Engine представлен на рисунке 6.

Рисунок 6

Arbortext Publishing Engine позволяет генерировать как бумажно-ориентированную документацию, так и техническую документацию в виде интерактивных документов (в терминологии S1000D Interactive Electronic Technical Publication (IETP)). Под бумажно-ориентированными документами можно понимать документы в формате PDF и MS Word.

Arbortext Publishing Engine позволяет поставлять пользователям интерактивную техническую документацию в трех различных форматах:

  • CD Installer.
  • CD Runtime.
  • Web-Server build.

Формат «CD Installer» представляет собой набор файлов, составляющих содержимое технической документации и установочный файл SETUP.EXE. Данный формат служит для распространения технической документации на CD – дисках или иных носителях данных.

Формат «CD Runtime» представляет собой набор файлов структурированных в виде интерактивного технического документа. Формат может быть использован для распространения технической документации на CD – диска, других носителях данных или для использования публикации прямо с локального диска компьютера. При этом непосредственная установка комплекта технической документации на компьютере пользователя не требуется.

Формат «Web-Server build» представляет собой архив в формате ZIP, предназначенный для загрузки на сетевой Web — сервер. При этом Web – сервер может предоставлять доступ к различным электронным техническим документам посредствам интернета с использованием стандартного браузера Internet Explorer. Следует заметить, что для реализации функции доступа к технической документации через интернет необходимо установить и подготовить к работе сетевой сервер.

Arbortext Parts Catalog Manager for S1000D и Arbortext Provisioning Manager
Arbortext Parts Catalog Manager for S1000D и Arbortext Provisioning Manager – программные модули предназначенные для разработки, просмотра и актуализации, как отдельных разделов электронного каталога изделий, так и всего каталога в целом. К основным функциям электронного каталога следует относить возможность идентификации необходимых запасных частей, получение информации о взаимосвязи между составными частями изделия, а также предоставление пользователю возможности получить дополнительные сведения о заказе и поставке запасных частей.

В соответствии с положениями S1000D электронные каталоги изделий могут быть подготовлены на основе:

  • базы данных S2000M;
  • технических данных (для проектов, в которых S2000M не используется).

Программные модули Arbortext Provisioning Manager и Arbortext Parts Catalog Manager for S1000D предназначены для разработки каталогов на основе базы данных S2000M и на основе технических данных соответственно. Порядок разработки модулей данных электронного каталога изделий представлен на рисунке 7.

7_arbortext-ipdРисунок 7

Arbortext Parts Catalog Manager for S1000D – программный модуль, предназначенный для разработки, изменения и просмотра модулей данных электронных каталогов изделий. Данный программный продукт позволяет на основе информации из систем управления данными об изделии и других источников технических данных разрабатывать спецификации каталога и ассоциировать их с иллюстрациями, разработанными с использованием Arbortext IsoDraw.

За счет интеграции с Arbortext Common Source Database (CSDB) Arbortext Parts Catalog Manager for S1000D является одним наиболее эффективных средства разработки электронных каталогов изделий соответствующих требованиям S1000D. Arbortext Parts Catalog Manager for S1000D позволяет разрабатывать отдельные разделы каталогов (в терминологии S1000D модули данных электронного каталога (IPD)), иллюстративная часть которых может состоять, как из двух, так и из трехмерных иллюстраций с выносками. При этом для каждой позиции электронного каталога могут быть указанны место расположения элемента в изделии, сведения о порядке поставки данного элемента и другие данные, используемые при заказе запасных частей.

Arbortext Provisioning Manager – программный модуль, предназначенный для формирования перечня начальной поставки (IPL – Initial Provision List), а также разработки, просмотра и актуализации модулей данных иллюстрированного каталога деталей IPC (Illustrated Part Catalog) в соответствии с требованиями S2000M. Внешний вид пользовательского интерфейса Arbortext Provisioning Manager представлен на рисунке 8.

8_provisionРисунок 8

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

В качестве исходных данных для разработки перечня начальной поставки и электронного каталога деталей в Arbortext Provisioning Manager могут служить:

  • данные из системы управления жизненным циклом изделия;
  • геометрия элементов входящих в перечень начальных поставки, разработанная в САПР;
  • данные из базы данных анализа логистической поддержки;
  • иллюстрации, созданные в Arbortext IsoDraw.

Arbortext LSA Interface for S1000D
Arbortext LSA Interface for S1000D – программный модуль, предназначенный для импорта данных из базы данных анализа логистической поддержки (БД АЛП) в CSDB с целью обеспечения разработки перечня начальной поставки и электронного каталога изделий в соответствии с требованиями S2000M. Arbortext LSA Interface for S1000D позволяет частично автоматизировать процедуры анализа данных при их передаче из БД АЛП, что позволяет минимизировать трудоемкость выполнения данного процесса.

Arbortext Learning Content Manager for S1000D
Arbortext Learning Content Manager for S1000D (LCMS) – программный модуль, предназначенный для создания учебного материала, на основе модулей данный технической документации. Данный модуль обеспечивает создание пакет данных отвечающего требованиям международного стандарта в области дистанционного обучения SCORM. Пакеты данных, созданные с использованием LCMS, воспринимаются основными мировыми и отечественными системы дистанционного обучения. Примерами таких систем является система обучения, оценки, развития и подбора персонала WebTutor. Внешний вид пользовательского интерфейса Arbortext Learning Content Manager for S1000D представлен на рисунке 9.

9_learning Рисунок 9

Arbortext Learning Content Manager for S1000D объединяет принципы управления содержимым технической документации, описанные в S1000D, с возможностью многократного использования учебного контента в формате SCORM, что позволяет существенно повысить эффективность обучения технических специалистов и сократить сроки освоения новых изделий.

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

Отдельные слова благодарности хотелось бы сказать сотрудникам компании ПТС (Продуктивные технологические системы) Александру Недр и Олегу Волкову за предоставленную информацию  по системе Arbortext.

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

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