Создание среды разработки документации семейств программных продуктов

Создание среды разработки
документации семейств
программных продуктов
Яковлев Константин Сергеевич
542 группа
Научный руководитель:
старший преподаватель К. Ю. Романовский
Рецензент: к.ф.-м.н., доцент Д. В. Кознов
2007 год
Контекст работы
• Семейства программных продуктов
• Проблема разработки документации
• Существующие решения
– DITA
– DocBook
• Подход DocLine
– Язык DRL/PR
Постановка задачи
• Разработка текстового редактора для
языка DRL/PR
• Разработка модуля трансляции в
форматы HTML и PDF
• Разработка системы валидации
DRL/PR-текстов
Архитектура
• Платформа Eclipse
• Взаимодействие текстового и
визуального редакторов
Графическое
представление
документации
(DRL/GR)
Текстовое
представление
документации
(DRL/PR)
Формат для
публикации
(HTML/PDF)
Текстовый редактор
•
•
•
•
•
Eclipse Text Editor Framework
Подсветка синтаксиса
Подсказки
Подсветка ошибок
Авто-редактирование
Трансляция
Адаптация ИП
ИП
СИП
Ссылка на
ИЭ #1
Адаптер #1
...
...
Ссылка на
ИЭ #N
Адаптер #N
Файл в
формате
DocBook
HTML/PDF
Валидация
0: Начало
DRL-текст
2: Трансляция
3: Обработка привязок
4: Валидация по
схеме DocBook с
учетом привязок
1: Валидация по
схеме DRL
Ошибки DRL
DocBook с
привязками
к исходным
текстам DRL
Ошибки
трансляции
Ошибки
DocBook
«Чистый»
DocBook
5: Экспорт
PDF/HTML
Заключение
• Реализован текстовый редактор с
заявленной функциональностью
• Реализована трансляция DRL/PR в
форматы HTML и PDF
• Реализована валидация DRL/PR кода
на трех уровнях
• Разработан сквозной пример