Технология разработки и сопровождения крупных комплектов технической документации DITA: внедряем и применяем!

Предмет

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

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

Курс предусматривает:

• лекции;
• практическую работу в компьютерном классе.

Краткий видеокурс 'Введение в DITA'

Для просмотра видеокурса требуются:

• звуковая карта и колонки либо наушники;
• Adobe FlashPlayer версии не ниже 9.

Организаторы и докладчики

• Алекс Масычев, Senior XML Project Manager, WritePoint (Israel) Member, OASIS DITA Adoption Technical Committee.
• Михаил Острогорский, 'Философт'.

Аудитория

Технические писатели, руководители отделов документирования, руководители проектов.

Содержание

I день. Основы технологии DITA

Занятие 1. Введение в DITA

1. Зачем нам DITA? Практическая отдача от использования технологии DITA при разработке технической документации.

2. Основные концепции технологии DITA:

   • Архитектура, основанная на топиках.
   • Типы информации: концепция, задача, справка.
   • Техника многократного использования материала.
   • Специализация модели DITA.
   • Формирование выходных документов в разных форматах.
   • Обзор пакета программ DITA Open Toolkit.
3. DITA как средство повышения продуктивности авторских коллективов. Пример оценки экономического эффекта от внедрения технологии DITA.

4. Осваиваем инструментарий DITA:

   • Редакторы для работы с DITA.
   • Средства для формирования выходных документов.
   • Системы управления контентом.

Занятие 2. Работа над текстом в DITA

1. Разбираемся в пользовательском интерфейсе XML-редактора.
2. Учимся создавать топики DITA: Concept, Task, and Reference.
3. Собираем топики в документ с помощью карты (map).
4. Учимся применять шаблоны DITA.
5. Проектирование 'сверху вниз' и 'снизу вверх' применительно к DITA.
6. Что мы имеем с DITA?

Занятие 3. Формирование документов

1. Установка и настройка DITA OT.
2. Осваиваем компоненты DITA OT.
3. Настройка работы с кириллицей.
4. Получаем выходные документы в разных форматах (PDF, HTML, CHM и др.) с помощью DITA OT.
5. Что мы имеем с DITA?

Занятие 4. Итоги дня

II день. Принцип единого источника и другие передовые идеи в DITA.

Занятие 1. Реализация принципа единого источника в DITA.

1. Принцип единого источника.
2. Условный текст внутри топика.
3. Многократное использование топика в разных картах документов.
4. Многократное использование карты документа.
5. Фильтрация условного текста и формирование документов для разных заказчиков.
6. Что мы имеем с DITA?

Занятие 2. Ссылки в DITA

1. Способы делать ссылки.
2. Использование переменных в DITA.
3. Использование перекрестных ссылок в DITA и работа с перекрестными ссылками между топиками.
4. Что мы имеем с DITA?

Занятие 3. Индексирование в DITA

1. Стратегии индексирования.
2. Индексирование текста в DITA.
3. Формирование выходных документов с индексами (PDF, CHM, HTML).
4. Поддержка кириллицы в индексах.
5. Что мы имеем с DITA?

Занятие 4. Итоги дня

III день. Модификация структуры DITA и оформления выходных документов

Занятие 1. Специализация DITA

1. Понятие о специализации DITA.
2. Когда полезна специализация.
3. Правила специализации.
4. Направления специализации: структура, домены, атрибуты.
5. Техника специализации: планирование, проектирование, реализация.

Занятие 2. Формирование выходных документов в формате PDF

1. Разбираемся в особенностях формирования PDF.
2. Модификация оформления выходного документа посредством XSL-FO.
3. Формирование качественных PDF-документов с помощью Adobe FrameMaker и DITA-FMx plugin.
4. Поддержка специализации DITA.

Занятие 3. Формирование выходных документов в форматах HTML и HTML Help

1. Разбираемся в особенностях форматов HTML и HTML Help.
2. Модификация выходных документов посредством XSLT и CSS.
3. Поддержка специализации DITA.

Занятие 4. Преобразование накопленного материала в формат DITA

1. Разбираемся в процессах конвертации.
2. Как сделать конвертацию 'безболезненной'?
3. Миграция от MS Word и Help&Manual к DITA.

Занятие 5. Итоги дня

О компании WritePoint

Компания WritePoint Ltd. была основана в 1995 году. Благодаря команде высококвалифицированных специалистов компания стала лидером на израильском рынке в области разработки технической документации, решений в области контент менеджмента и обучения. WritePoint предлагает разнообразные решения, которые позволяют компаниям значительно повысить эффективность работы отделов документации и снизить затраты на создание и поддержку документации. WritePoint имеет богатый опыт внедрения DITA в компаниях Израиля и США как для отделов документации насчитывающих десятки технических писателей, так и организаций, имеющих всего лишь одного технического писателя.

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