КомпанияОбучениеСтатьиСервисы

Внедрение DITA

Версия для печати

Содержание

Подходы к внедрению DITA

Мы выполняем как отдельные работы (преобразование документов в формат DITA, настройка DITA Open Toolkit), так и комплексные проекты по внедрению DITA.

Технология DITA

Общие сведения

Darwin Information Type Architecture (DITA) — популярная технология документирования, основанная на XML. Эта технология позволяет автоматизировать разработку и в особенности сопровождение сложных комплектов технической документации. Поддержка технологии DITA реализована во многих программных продуктах, предназначенных для работы с технической информацией.

История и современное состояние

Технология DITA появилась на свет благодаря усилиям специалистов корпорации IBM, которые нуждались в эффективном инструменте для документирования собственных разработок. Удачное решение быстро переросло уровень внутреннего проекта и сделалось популярным среди разработчиков технической документации во всем мире. Сегодня технологию DITA используют как небольшие, так и крупные организации. Развитием стандарта DITA в  настоящее время занимается консорциум OASIS. Первая официальная версия спецификации DITA была опубликована в 2005 году. Поддержка технологии DITA реализована во многих программных продуктах: редакторах, интегрированных средах и т.п.

Сфера применения

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

Несколько типичных ситуаций использования технологии DITA:

  • Документация на техническое средство или машину. Модели технических средств и машин редко бывают уникальными. Как правило, на основе одной платформы выпускают несколько разных модификаций одного и того же изделия. Между этими модификациями есть много общего, но они отличаются друг от друга отдельными функциональными или техническими характеристиками, важными для потребителя. Например, на базе одного и того же мотоблока могут быть выпущены разные специализированные машины для уборки улиц. Технология DITA позволяет быстро выпустить комплект документации на очередную модификацию изделия, дописав к общему объему только необходимый минимум специфичного для нее текста.
  • Технологические инструкции для разных пользователей одной системы. Одна и та же система (компьютерная, промышленная или иная) может предоставлять разным пользователям доступ к разным функциям в зависимости от их ролей. При этом понятийный аппарат системы, ее пользовательский интерфейс и базовый набор функций остаются неизменными для любой роли. Например, в автоматизированной системе управления предприятием менеджер по продажам, кладовщик и бухгалтер могут решать разные задачи, пользуясь одними и теми же справочниками, функциями обработки документов и т.п. Технология DITA позволяет написать одну «сверхинструкцию» и делать из нее необходимые «срезы» по конкретным ролям. Кроме того, существует возможность автоматически сформировать графическое представление для бизнес-процессов.

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

Технологическая база

Основу технологии DITA составляет одноименное приложение XML, иначе говоря, язык разметки, спецификацию которого разрабатывает и публикует профильный технический комитет консорциума OASIS. Для набора текста с использованием языка разметки DITA пригоден любой текстовый или XML-редактор. Поддержка DITA реализована во многих современных XML-редакторах, а также интегрированных средах разработки технической документации. Преобразование документов, отвечающих стандарту DITA, в выходные форматы, PDF, HTML и др., как правило, выполняют с помощью комплекта программ DITA Open Toolkit. Этот программный продукт распространяется бесплатно в соответствии с Apache License 2.0. Архитектура DITA OT допускает расширение и кастомизацию. Обладая достаточной квалификацией, каждый может адаптировать его для собственных нужд. Возможны и другие решения для получения выходных документов из исходных файлов в формате DITA. Например, в качестве средства для преобразования DITA в PDF можно использовать программу Adobe FrameMaker.

Основные возможности

  • Структурированное представление текста, возможность программно извлекать из него данные.
  • Возможность эффективно использовать системы управления версиями и управления контентом.
  • Унификация ряда важных особенностей стиля изложения материала в технической документации.
  • Фильтрация публикуемого текста по аудитории, теме, важности, секретности и прочим условиям.
  • Многократное использование одного и того же текста в разных документах (вместо его копирования).
  • Оформление (автоматическое) одних и тех же документов в соответствии с разными стандартами.
  • Преобразование документов в разные выходные форматы: PDF, HTML, JavaHelp, WebHelp и др.

Выполнение отдельных видов работ

Мы выполняем следующие виды работ:

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

Комплексные проекты по внедрению DITA

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

Этап Результаты
1 Вводная консультация (семинар) Заказчик получает представление о способах автоматизации документирования, совместно с нашими специалистами определяет наиболее перспективные направления автоматизации документирования на своем предприятии, прорисовываются контуры будущей системы. По результатам семинара заказчику предоставляется отчет
2 Предпроектное обследование

Отчет, в котором приводится следующая информация:

  • рецензия на существующую техническую документацию;
  • оценка объема существующей технической документации;
  • оценка объема многократно повторяемого текста;
  • анализ выявленных содержательных и организационных проблем;
  • обоснованные предложения по автоматизации документирования
3 Создание, демонстрация и обсуждение прототипа системы Прототип системы с частично загруженным в него материалом технической документации. Прототип демонстрирует основную функциональность будущей системы и позволяет всем заинтересованным лицам наилучшим образом представить себе будущую систему автоматизации документирования и  сформулировать требования к ней
4 Разработка требований и утверждение технического задания на систему Техническое задание на систему. Вместе с техническим заданием заказчик получает точную смету и детализированный план-график работ
5 Реализация системы и ее развертывание у заказчика Программное обеспечение системы, развернутое на его оборудовании
6 Преобразование имеющейся документации в формат DITA Полностью готовая к работе система автоматизации документирования
7 Обучение специалистов заказчика Заказчик получает возможность эффективного использования системы автоматизации документирования

Подробности

Более подробное описание технологии DITA.

© «Философт», 2008–2017

+7 (499) 500-44-77

mail@philosoft.ru

SpyLOG