Программное обеспечение для создания технической документации
Одной из программ для создания систем ИЭТР является ПО TG Builder. В данной курсовой работе будет использована именно эта систем, так как TG Builder является одной из самых распространённых систем, и данная система была подробна, рассмотрена на лабораторных работах.
Программный комплекс Technical Guide Builder автоматизирует задачи создания, контроля, учета, выпуска и сопровождения различных видов электронной и бумажной технической документации на сложные изделия.
Комплекс предоставляет автоматизированные рабочие места для различных участников процессов.
Также предоставляется специализированная утилита просмотра электронных публикаций.
Комплекс работает в соответствии с современными стандартами на технические публикации, такими как ASD S1000D, AC 1.1.S1000DR-2007. Основной концепцией используемых стандартов является модульность документации. Универсальность используемого подхода позволяет применять Technical Guide Builder для создания документации на различные виды техники.
Существуют как типовые решения по отраслям, так и возможность гибкой адаптации для конкретного проекта.
Комплекс подходит как для больших головных предприятий, так и для поставщиков комплектующих. Комплекс предоставит все требуемые механизмы формирования, транспортировки и интеграции пришедших данных.
Функциональные возможности TG Builder
· Совместная работа по подготовке и сопровождению сложной документации, с использованием специальных средств распределения, планирования и контроля выполнения работ.
· Управление конфигурациями, версиями и изменениями в документации.
· Выпуск документации на различных языках (русский, английский, испанский, французский, арабский).
· Анализ базы данных электронной документации. Автоматическая подготовка отчетов и перечней (таблицы ссылок, перечня действующих страниц, содержания и др.) в соответствии с требованиями стандарта ASD S1000D.
· Контроль целостности и корректности базы данных электронной документации.
· Формирование и передача заказчику электронных технических публикаций в интерактивном виде (вместе с бесплатным средством просмотра и работы с такими публикациями - TG Browser), а также в открытых форматах SGML\XML, и в виде готовых оригинал-макетов в формате PDF.
· Поддержка работы с текстовой, графической, мультимедийной информацией (видео, аудио, 3D).
Создание ИЭТР в TG Builder
Для создания проекта необходимо запустить программу TG Builder . В главном окне выбрать «Диспетчер проектов», как показано на рисунке 1
Рисунок 1
В открывшемся окне диспетчера проектов, можно редактировать уже существующие проекты или создать новый проект при помощи кнопок, расположенных справа (рисунок 2). Для создания нового проекта необходимо нажать кнопку «Создать проект».
Рисунок 2
После выбора создания нового проекта требуется заполнить спецификацию проекта (свойства проекта), где требуется указать название проекта, обозначение изделия, наименование изделия и что будет, является основой DTD проектов, как показано на рисунке 3. В свойствах задачи следует указать сроки начала и окончания выполнения задачи, а так же статус, в котором находиться проект (индикатор выполнения).
Далее требуется выбрать исполнителей проекта. Их можно создать в программе TG Admin, добавить новых пользователей в соответствующую группу или же создать новую группу с новым руководителем и исполнителями, после их моно будет выбрать в программе TG Builder, как показано на рисунке 4.
После того как все действия со свойствами проекта выполнены можно переходить к созданию проекта. С помощью панелей редактирования создаем иерархическую структуру руководства. «Руководство пользователя» самый верхний уровень иерархии. Создаём разделы технического руководства, отражающие его общие положения, и страницы руководства, как показано на рисунке 3.
Рисунок 3
Все подразделы необходимо наполнить соответствующей технической информацией с помощью панели редактирования. Главная страница руководства («Введение») представляет собой схему системы управления двигателем со статическими и динамическими ссылками.
После создания технического руководство его следует экспортировать. Нажмите соответствующую кнопку в окне диспетчера проектов ,и экспортируйте проект, как показано на рисунке 7. После экспорта электронное руководство будет готово к использованию.
Рисунок 7
Полное техническое руководство размещается по адресу, куда оно было экспортировано, в папку с названием соответствующим названию технического руководства. В папке, помимо файла технического руководства, размещены все внешние объекты (экспортированные рисунки, таблицы и др.) Экспортированную ИЭТР можно открыть с помощью программы TG Browser.