Презентация - DH Custom Solution!

Хранение и публикация
документов
Технология единого источника
DITA
Что такое единый источник?
Единый источник (single source publishing) - это концепция публикации документов, согласно которой
один и тот же контент может быть использован в различных выпускаемых документах или в различных
форматах.
Все фрагменты, из которых состоят выходные документы, находятся в некотором общем фонде, едином
источнике, представляющем собой (в зависимости от конкретной реализации) набор отдельных файлов
в файловой системе или некую базу данных.
Каждый выходной документ представляет собой упорядоченную выборку из единого источника,
который, в принципе, может иметь некоторую структуру, удобную для составителей, однако, напрямую в
структуру какого-либо документа она не трансформируется. Иначе говоря, соотношение между единым
источником и документом примерно такое же, как между базой данных и отчетом. Создать документ в
такой системе – значит описать его структуру и правила формирования из фрагментов единого
источника. Фрагментами могут являться шаблоны страниц, графические элементы, абзацы текста и др.
При этом трудозатратная и дорогая работа по созданию системы документирования основанной на
принципе единого источника проводится единовременно. Дальнейшая работа по созданию и
редактированию новых документов ведется путем использования специального программного
обеспечения. Выходные документы публикуются в автоматическом режиме в требуемой конфигурации.
В каких случаях целесообразно
использовать принцип единого источника?
Разработка документации ведется командой специалистов
Один и тот же документ или фрагмент документа редактируется
несколькими специалистами одновременно
Необходимо публиковать выходные документы в различных
форматах: PDF, HTML, RTF и т.п.
Каждый комплект выходных документы должны выглядеть в
собственном стиле
Документация поддерживается на нескольких языках
Этапы внедрения процесса документирования
1. Постановка задачи. Разработка и утверждение требований к результату
(формату, внешнему виду, комплектности, количеству языков, системе
хранения исходных файлов, инструментарию, который будет
использоваться для редактирования и публикации и т.п.).
2. Внедрение системы документирования (закупка при необходимости
лицензий на ПО, установка и отладка ПО, настройка кастомизации (XSLT
стилей) и т.п.)
3. Конвертация имеющегося контента (из формата Word, FrameMaker) в
формат DITA
4. Отладка контента, настройка публикации выходных документов
5. Обучение персонала и/или создание технической спецификации по
использованию новой системой хранения и публикации контента.
6. Осуществление поддержки процесса документирования
Схема организации процесса документирования
Авторы документов
Контент
Настройка
кастомизации
XSLT-Стиль
Хранилище
контента
(CMS)
Выходные документы
Хранение исходного контента
Технология
единого
источника
подразумевает, что исходные файлы
документа
(создаваемые
техническими писателями) и готовые
документы (создаваемые программой
для сборки документа) — это разные
файлы.
Преимущества DITA
Выпуск документов в разных форматах (PDF, HTML5 и XHTML,
Eclipse Help, TocJS, HTML Help, Java Help, ODЕ, RTF, troff)
Жесткое структурирование разделов за счет типизированных
«топиков» (concept, task, reference и др.)
Возможность одновременной работы над документом
нескольких разработчиков текста
Возможность выпускать документы в едином стиле
Возможность кастомизировать выходные стили документов под
требования различных проектов
Дизайн
 Технология DITA предоставляет возможность использования
отдельного набора рисунков для pdf и отдельный набор картинок
для xhtml-справки
 Использование собственного стилевого оформления, например,
если для публикации различных комплектов документов
используется различные логотипы и цветовая гамма
Хранение
Технология единого источника подразумевает,
что исходные файлы документа (создаваемые
техническими писателями) и готовые документы
(создаваемые
программой
для
сборки
документа) — это разные файлы.
Инструментарий
DITA Open Toolkit http://www.dita-ot.org/ инструмент для
преобразования контента DITA в различные форматы
DATA Too http://intuillion.com/products/ditatoo/ система
управления контентом решает следующие задачи:
хранения контента
поддержки версионности файлов проекта
многопользовательского редактирования контента
Oxygen http://www.oxygenxml.com/ редактор исходных файлов