Обзор Technical Guide builder

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

В настоящее время на отечественном рынке программного обеспечения для разработки технической документации можно выделить две специализированные системы, позволяющие в полной мере реализовать требования, предъявляемые к технической документации, как со стороны отечественных, так и со стороны зарубежных нормативных документов. Это Technical Guide Builder (разработчик АНО «НИЦ CALS-технологий «Прикладная логистика») и Arbortext (разработчик компания «PTC»). Если про Arbortext на данном ресурсе уже есть небольшой обзорный материал, то информацию о Technical Guide Builder (сокращенно в тексте будем обозначать данный продукт, как «TG Builder» или просто «система») найти крайне сложно. Попробуем восполнить этот пробел.

Начнем с назначения данной системы. TG Builder — это программный комплекс, предназначенный для разработки, сопровождения, изменения и публикации технической документации. Его функциональные возможности позволяют разрабатывать документацию соответствующую требованиям, как отечественных стандартов в области технической документации (ГОСТ 2.051-2006, ГОСТ 2.601-2006, ГОСТ 2.602-95, ГОСТ 2.610-2006, ГОСТ 2.611-2011), так и требованиям международной спецификации S1000D. Считаю, что описывать данный программный продукт целесообразно с точки зрения разработчика технической документации.

Рассмотрим типовой процесс разработки технической документации с использованием TG Builder (Рисунок 1):

TGB

Рисунок 1 — Типовой процесс разработки технической документации в TG Builder.

1. На первом этапе, после анализа исходных данных, в системе создается новый проект по разработке технической документации, определяется состав команды проекта и сроки его реализации. Создается или импортируется (если он существует) шаблон документа, а также, в случае необходимости, создается список клиентов, которым будет рассылаться техническая документация. Кроме того, формируются различные справочники, используемые при разработке документации (справочники допускается наполнять в ходе работы над проектом).
2. После создания проекта, на основе анализа исходных данных, формируется содержание документа. Т.е. создается «скелет документа» — предварительный перечень модулей данных (МД). Модули могут группироваться в разделы (здесь и далее для простоты мы будем использовать термин «раздел документа», понимая под ним, как группу МД, так и отдельный модуль). В процессе работы над документом данный перечень чаще всего видоизменяется, однако, его создание необходимо для планирования и распределения работ между исполнителями. На данном этапе в терминологии S1000D мы создаем DMRL (Data Module Requirements List). Как правило DMRL является результатом выполнения анлиза логистической поддержки изделия, но это тема отдельной статьи.
3. После того, как сформировано содержание документа, происходит закрепление разделов документа за конкретными исполнителями. При этом определяются сроки, в которые исполнитель должен разработать назначенный ему раздел документа.
4. Далее начинается процесс разработки содержательной части документа. Следует заметить, что в системе реализованы специализированные редакторы для каждого информационного типа разделов документа. Например, для разработки каталога деталей и сборочных единиц — используется редактор МД типа «Каталог», для разработки раздела, посвященного техническому обслуживанию, где необходимо показать последовательность выполнения работ — используется редактор МД типа «Технологическая карта», для разработки раздела, посвященного диагностике — используется редактор МД типа «Поиск и устранение неисправностей (ПИУН)». Для большинства разделов документа может быть использован редактор МД описательного типа.
5. После того, как разработано основное содержание документа, руководитель формирует конечный документ (например, Каталог деталей и сборочных единиц на изделие, Руководство по эксплуатации на изделие, ИЭТР и т.п.) и готовит его к публикации. Следует заметить, что на основе одного «базового» документа могут быть сформированы документы, которые представляют собой логические блоки (подмножества) разделов «базового» документа, сгруппированные по определенному признаку. Например, на базе руководства по эксплуатации могут быть сформированы различные специализированные инструкции. В другом случае, отдельные разделы «базового» документа могут быть заимствованы при создании других видов документации. В обоих случаях при изменении разделов руководства по эксплуатации (так называемого «базового» документа) будут изменены соответствующие разделы других документов.
6. После разработки содержательной части документа, происходит его публикация. TG Builder позволяет публиковать документацию в следующих форматах: PDF, интерактивный документ со встроенным браузером, набор XML файлов, соответствующих требованиям S1000D. Следует заметить, что из интерактивного документа всегда можно получить странично-ориентированный аналог, используя специализированный модуль печати.
7. Поставка документации конечному пользователю может быть осуществлена следующими способами:
1. Документации в бумажной форме (распечатанный PDF — документ);
2. Документация в электронной форме:
— PDF — документ на носителе данных (CD, DVD, Flash-накопитель и т.п.);
— Незащищенный интерактивный документ на носителе данных;
— Интерактивный документ на носителе данных со встроенным модулем защиты от несанкционированного доступа;
3. Доступ к интерактивной документации посредством сети интернет.
8. Как правило по истечение некоторого срока после поставки документации пользователю возникает необходимость во внесении изменений в созданный комплект документации и, соответственно, ее обновления на стороне пользователя. Гибкий механизм версионности и специализированный функционал TG Builder, направленный на регистрацию бюллетеней и проведении изменений по ним, позволяет достаточно просто реализовать процесс внесения изменений у разработчика документации с последующей ее актуализацией у пользователя.
9. Кроме того необходимо упомянуть ряд специализированных функций, существенно упрощающих процесс разработки, комплектования и распространения документации. К ним можно отнести: функции работы с применимостью, которые позволяют упростить разработку документации на семейство изделий, функции управления очередями поставок, которые позволяют эффективно управлять процессом поставки документации каждому потребителю, а также базу вспомогательной информации (единицы измерения, интервалы ТО, категории и уровни квалификации специалистов и т.д.), позволяющую упростить процесс разработки документации и унифицировать представление информации.

Далее рассмотрим процесс разработки технической документации с точки зрения использования программных модулей TG Builder на каждом из вышеназванных этапов. На рисунке 1 с каждым из этапов типового процесса разработки технической документации ассоциирован определенный программный модуль TG Builder.

Для удобства описания процесса на рисунке 2 представлена структурная схема программных модулей TG Builder.

Структура TGB

Рисунок 2 — Структурная схема TG Builder

Итак, структурно TG Builder состоит из 4 основных программных модулей — это Диспетчер проектов, TG Designer, TG Browser и TG Admin. Утилита TG Update входит в стандартный комплект поставки TG Builder, однако оно поставляется как отдельное приложения и к нему нельзя получить доступ из основного меню TG Builder. Это связано с тем, что данная утилита используется только для обновления документации у пользователя документации. Т.е. она может быть передана пользователю документации при поставке документа, чтобы пользователь мог самостоятельно актуализировать документ.. TG WebServer является отдельным приложением и не входит в стандартный комплект поставки TG Builder. Данное приложение предназначено для предоставления удаленного доступа к интерактивной технической документации через интернет. TG WebServer будет посвящена отдельная статья.

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

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

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

Как видно из рисунка 2 наиболее структурно сложным элементом TG Builder является программный модуль Диспетчер проектов, предназначенный для создания, удаления и редактирования проектов по разработке технической документации. Сразу хочу оговориться, что иерархия диспетчера проектов является условной, и предназначена для упрощения восприятия информации о программных модулях системы и порядке их использования при разработке документации.

Редактор справочников — предназначен для создания, редактирования, удаления, импорта и экспорта различных специализированных справочников, используемых при разработке технической документации. В редакторе реализована работа с четырьмя группами справочников: 1) Единицы измерения; 2) Применимость; 3) Предварительные требования; 4) Регламент.

Редактор списка клиентов — предназначен для создания, удаления и редактирования информации о заказчиках (пользователях), которым планируется поставка документации.

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

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

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

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

Модуль отслеживания работ — предназначен для контроля хода выполнения работ по проекту.

Модуль управления версиями модулей данных — предназначен для создания, удаления и редактирования свойств версий разделов документа. Кроме того, данный модуль предоставляет доступ к редакторам модулей данных различных типов.

Редактор модуля данных типа каталог — предназначен для разработки каталогов деталей и сборочных единиц. При этом в качестве иллюстративной части каталога могут использоваться не только растровые или векторные 2D иллюстрации, но и 3D модели.

Редактор модуля данных типа технологическая карта — предназначен для создания пошаговых инструкций, выполнения различных технологических операций при эксплуатации, ремонте или производстве изделия.

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

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

Кроме того, следует выделить два универсальных модуля, доступ к которым можно получить из различных модулей данных. Так, модуль экспорта/импорта можно запустить из редактора структуры документа и из диспетчера проекта, а доступ к модулю печати можно получить из всех редакторов модулей данных различных типов и редактора структуры документа. Связи этих программных модулей с другими элементами системы на рисунке 2 выделены зеленым.

Модуль экспорта/импорта — предназначен для импорта и экспорта проекта в целом, отдельных разделов документа и публикаций в форме интерактивного документа или набора XML файлов соответствующего требованиям S1000D.

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

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

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

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