Technical Guide Builder
Technical Guide Builder
Программный комплекс для разработки, сопровождения и публикации эксплуатационной документации.
Комплекс имеет модульную структуру, дополнительные модули подключаются к базовому ядру и расширяют набор функций системы.
Функциональные возможности системы позволяют разрабатывать документацию соответствующую требованиям, как отечественных стандартов в области электронной технической документации (ГОСТ 2.051-2006, ГОСТ 2.601-2006, ГОСТ 2.602-95, ГОСТ 2.610-2006, ГОСТ 2.611-2010), так и требованиям международной спецификации S1000D.
Основными требованиями, которыми мы руководствуемся в процессе разработки эксплуатационной и ремонтной документации, являются требования заказчика.
Если такие требования не сформированы, то мы поможем их сформировать, руководствуясь накопленным опытом и основными нормативными документами в данной области:
Основными отличиями системы разработки технической документации, предлагаемой в виде комплексного решения, являются:
Комплексное решение обеспечивает сквозной процесс разработки, управления и публикации документации в различной форме (ИЭТР, печатные документы, WEB-документация).
Комплексный вариант системы разработки технической и нормативно-технической документации, как правило, включает:
Схема комплексного решения системы разработки технической документации.
Technical Guide Builder
Technical Guide Builder 4
Интегрированный комплекс программных средств для разработки, сопровождения, изменений и публикации эксплуатационной и ремонтной документации на сложные изделия.
Идеологической основой Technical Guide Builder является самая современная международная спецификация S1000D©, разработанная Европейской ассоциацией аэрокосмической и оборонной техники (AeroSpace and Defense Industries Associations of Europe — ASD) и регламентирующая все вопросы, связанные с разработкой, сопровождением и передачей эксплуатационной и ремонтной документации (ЭД и РД) в электронной и бумажной форме при решении задач интегрированной логистической поддержки (ИЛП).
Одной из главных идей S1000D является представление документации в виде набора информационных единиц — модулей данных (МД) в формате SGML/XML. Состав и структура данных в МД определена стандартом S1000D, что позволяет рассматривать каждый модуль данных как потенциальный электронный документ.
В состав Technical Guide Builder входит база данных МД, а также средства администрирования, позволяющие формировать из хранимых в базе данных МД требуемые публикации, в т.ч. на разных языках, управлять изменениями МД и публикаций, осуществлять контроль целостности и корректности хранимых данных.
Для подготовки разных видов документации (описательной, процедурно-технологической, каталогов и т.д.) в Technical Guide Builder предусмотрен набор специализированных программных приложений-редакторов. Использование высокоуровневых приложений позволяет инженерному составу разрабатывать документацию, концентрируя свое внимание только на её содержательной части, и не требует от пользователя глубоких знаний языков SGML/XML, что характерно при использовании имеющихся на рынке XML-редакторов.
TG Builder поддерживает разработку различных видов документации, отвечающей требованиям S1000D версии 4.1 и 5.0, и ГОСТ 18675-2012:
В качестве исходных данных могут быть использованы любые данные в цифровом (или даже бумажном!) формате: от цифровых чертежей, электронных таблиц и 3D моделей до данных, представленных в формате базы данных анализа логистической поддержки, соответствующей ASD S3000L.
Для сложных изделий это радикально сокращает время создания документации, так как при использовании БД АЛП часть модулей данных формируется автоматически. Таким образом обеспечивается работа в едином информационном пространстве, с использованием данных из смежных информационных систем (PDM, СAD, MDM и т.д.)
Документация разрабатывается в WYSIWIG-режиме, пользователям достаточно обладать только базовыми знаниями спецификации S1000D и языка XML.
WYSIWIG редакторы модулей данных позволяют включать в документацию векторные и растровые изображения, снабжать модули данных 3D анимацией и видеороликами, иллюстрирующими процедуры обслуживания и ремонта изделия, работать с таблицами, ссылками, символами, применяемостью и многое другое.
Комплекс позволяет разрабатывать документацию на семейство изделий, с учётом всех модификаций изделий и вариантов их эксплуатации у различных заказчиков.
TGBuilder поддерживает модель применяемости из стандарта S1000D версий 4.1 и 5.0, и позволяет формировать справочники правил применяемости, атрибутов, условий и финальных изделий. А также осуществлять их импорт и экспорт из PDM систем. В систему встроен визуальный редактор, позволяющий назначать применяемости для всех элементов модулей данных.
TG Builder позволяет создавать эксплуатационную и ремонтную документацию на разных языках, включая языки с написанием справа налево:
Формы представления документации:
Комплекс позволяет создавать ИЭТР 3 и 4 классов. В том числе руководства, интегрируемые с системой объективного контроля изделия для автоматизации процедур диагностики, поиска и устранения неисправностей.
Разработанные ИЭТР могут быть использованы в составе комплексов дополненной реальности (AR) и поддерживают функции «умного» поиска c использованием оптических меток (QR-коды, Data Matrix-коды, и т.п.).
Широкий набор инструментов, необходимых для разработчиков документации:
Обзор Technical Guide builder
После цикла статей, посвященных формированию тендерных требований на разработку каталогов деталей и сборочных единиц, в продолжение данной темы мы рассмотрим инструменты, позволяющие разрабатывать, как каталоги деталей и сборочных единиц, так и другую техническую документацию.В настоящее время на отечественном рынке программного обеспечения для разработки технической документации можно выделить две специализированные системы, позволяющие в полной мере реализовать требования, предъявляемые к технической документации, как со стороны отечественных, так и со стороны зарубежных нормативных документов. Это Technical Guide Builder (разработчик АНО «НИЦ CALS-технологий «Прикладная логистика») и Arbortext (разработчик компания «PTC»). Если про Arbortext на данном ресурсе уже есть небольшой обзорный материал, то информацию о Technical Guide Builder (сокращенно в тексте будем обозначать данный продукт, как «TG Builder» или просто «система») найти крайне сложно. Попробуем восполнить этот пробел.
Рассмотрим типовой процесс разработки технической документации с использованием TG Builder (Рисунок 1):
Для удобства описания процесса на рисунке 2 представлена структурная схема программных модулей TG Builder.
Рисунок 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.
Техническая документация и немного личного
Основная тематика блога посвящена вопросам разработки и поддержания в актуальном состоянии эксплуатационной и ремонтной документации для изделий различных отраслей промышленности. Кроме того, в блоге будут публиковаться статьи личного характера, посвященные моей жизни.
пятница, 7 сентября 2012 г.
Обзор Technical Guide builder
Оригинал статьи находится здесь.
После цикла статей, посвященных формированию тендерных требований на разработку каталогов деталей и сборочных единиц, в продолжение данной темы мы рассмотрим инструменты, позволяющие разрабатывать, как каталоги деталей и сборочных единиц, так и другую техническую документацию.
В настоящее время на отечественном рынке программного обеспечения для разработки технической документации можно выделить две специализированные системы, позволяющие в полной мере реализовать требования, предъявляемые к технической документации, как со стороны отечественных, так и со стороны зарубежных нормативных документов. Это Technical Guide Builder (разработчик АНО «НИЦ CALS-технологий «Прикладная логистика») и Arbortext (разработчик компания «PTC»). Если про Arbortext на данном ресурсе уже есть небольшой обзорный материал, то информацию о Technical Guide Builder (сокращенно в тексте будем обозначать данный продукт, как «TG Builder» или просто «система») найти крайне сложно. Попробуем восполнить этот пробел.
Рассмотрим типовой процесс разработки технической документации с использованием TG Builder (Рисунок 1):
Далее рассмотрим процесс разработки технической документации с точки зрения использования программных модулей TG Builder на каждом из вышеназванных этапов. На рисунке 1 с каждым из этапов типового процесса разработки технической документации ассоциирован определенный программный модуль TG Builder.
Для удобства описания процесса на рисунке 2 представлена структурная схема программных модулей TG Builder.
Как видно из рисунка 2 наиболее структурно сложным элементом TG Builder является программный модуль Диспетчер проектов, предназначенный для создания, удаления и редактирования проектов по разработке технической документации. Сразу хочу оговориться, что иерархия диспетчера проектов является условной, и предназначена для упрощения восприятия информации о программных модулях системы и порядке их использования при разработке документации.
Кроме того, следует выделить два универсальных модуля, доступ к которым можно получить из различных модулей данных. Так, модуль экспорта/импорта можно запустить из редактора структуры документа и из диспетчера проекта, а доступ к модулю печати можно получить из всех редакторов модулей данных различных типов и редактора структуры документа. Связи этих программных модулей с другими элементами системы на рисунке 2 выделены зеленым.
В заключении хочется отметить, что целью данной статьи является ознакомление со структурой и общим функционалом TG Builder. Представленная система охватывает все этапы жизненного цикла эксплуатационного документа, в том числе такой сложный этап, с точки зрения его реализации, как внесение изменений у пользователя документации. Далее на основе данной статьи планируется написать ряд публикаций, посвященных работе всех программных модулей TG Builder.
Презентация была опубликована 9 лет назад пользователемwww.cals.ru
Похожие презентации
Презентация на тему: » ПРОГРАММНЫЙ КОМПЛЕКС ПОДГОТОВКИ ЭЛЕКТРОННОЙ ЭКСПЛУАТАЦИОННОЙ ДОКУМЕНТАЦИИ TECHNICAL GUIDE BUILDER ОРГАНИЗАЦИЯ ПРОЦЕССОВ ПОДГОТОВКИ И СОПРОВОЖДЕНИЯ ЭКСПЛУАТАЦИОННОЙ.» — Транскрипт:
1 ПРОГРАММНЫЙ КОМПЛЕКС ПОДГОТОВКИ ЭЛЕКТРОННОЙ ЭКСПЛУАТАЦИОННОЙ ДОКУМЕНТАЦИИ TECHNICAL GUIDE BUILDER ОРГАНИЗАЦИЯ ПРОЦЕССОВ ПОДГОТОВКИ И СОПРОВОЖДЕНИЯ ЭКСПЛУАТАЦИОННОЙ ДОКУМЕНТАЦИИ. ОСНОВНЫЕ МЕТОДИЧЕСКИЕ ПРИЕМЫ И РЕКОМЕНДАЦИИ.
2 Technical Guide Builder ® Схема работы интегрированой информационной системы на этапах проектирования, конструирования и создания ЭД PDM система CAD CAM Конструирование\Проектирование Создание ЭЭД ПУБЛИКАЦИИ Глава\Раздел МД Изделия ( структура \ состав )
3 Этапы создания ЭЭД 1.Анализ существующей документации и изделия. 1.Конфигурации, языки, применимости. 2.Типы используемых документов. 2. Создание шаблона ЭЭД. 1.Шаблоны требуемых МД. 2.Кодирование МД. 3.Шаблон структуры ЭЭД. 4.Справочники. 3. Подготовка план-проспекта. 4. Распределение задач по созданию содержания МД. Подготовка исходных матриалов. Наполнение МД. 5. Сопровождение и внесение изменений. 1.Архив ИИ. Проведение изменений. 2.Публикация обновлений.
4 Анализ существующей документации и изделия. Анализ существующих Конфигураций: Языки публикаций: Документация на Базовое изд. Документация на изд. Кофигурации «А» (для Тропиков) Документация на изд. Кофигурации «В» (для холодного климата) «D» Антарктика. «С»Арктика. RU Русский EN Английский …
5 Анализ существующей документации и изделия. МД IC Наименование МД SNS
6 Создание шаблонов Кодирование МД: Идентификатор изделия\системы\ агрегата Инф. Код DMC Шаблоны оформления МД: из стандарта, из анализа документации, из требований заказчика. Справочники сокращений, определений. Шаблон структуры публикации: из анализа документации..
7 Создание шаблонов Кодирование: Стандартная система нумерации Из AECMA: Дополнения От производителя: 30 : Устр «А»; 40 : Устр «B»; 50 : Устр «C»; …
8 Создание план-проспекта Публикация Глава 1 Глава 2 МД
9 Распределение задач по заполнению МД. Руководитель проекта: Шаблоны. План-проспект. Задачи. Требования к исх. материалам Конструкторкие бригады: Иллюстрации.Чертежи. Исходные инструкции. Модели Отдел ЭД: Наполнение МД, верстка. Простановка ссылок. Отчеты. Требования к исх. Материалам. TG Builder
10 Конструкторкие бригады: Иллюстрации.Чертежи. Исходные инструкции. 3D-Модели. Видео. Натурная съемка. По CAD-моделям. Flash-ролики Подготовка исходных материалов для создания МД. Модуль Данных Тех.карта МД. Описание. Устройство и работа. МД. РегламентМД. Каталог ДС
11 Сопровождение ЭЭД. Внесение изменений. Публикация ЭЭД. Распространение Обновлений на CD Печать обновлений. Ведение Архива ИИ. Учет извещений. Анализ текущей документации Распределений задач по внесению изменений Внесение изменений в МД. Создание новых версий МД. Отправка эксплуатанту.