Санкт-Петербургский Государственный Университет
Математико-механический факультет
Кафедра информатики
|
Создание среды разработки документации для семейств программных продуктов
|
Дипломная работа студента 542 группы
Яковлева Константина Сергеевича
|
Научный руководитель …………………………….
старший преподаватель
|
К. Ю. Романовский
/подпись/
|
Рецензент …………………………….
к.ф.-м.н., доцент
|
Д. В. Кознов
/подпись/
|
«Допустить к защите» …………………………….
Зав. кафедрой, д.ф.-м.н., профессор
|
Н. К. Косовский
/подпись/
|
Оглавление
Оглавление 2
Введение 3
1. Постановка задачи 5
2. Обзор литературы 6
2.1 Семейства программных продуктов 6
2.2 Метод DocLine и язык DRL 8
2.2.1 Процесс 8
2.2.2 Обзор графической нотации DRL 8
2.2.3 Обзор текстовой нотации DRL 11
2.3 Технология DocBook 14
2.4 Платформа Eclipse 15
3. Основные результаты 17
3.1 Архитектура 17
3.1.1 Текстовый Редакторредактор 18
3.1.2 Трансляция 20
3.1.3 Валидация 21
3.24 Особенности реализации 24
34.2.1 Агрегация XML-документов в процессе трансляции.Трудности реализации 24
4.2 Механизм привязок, используемый для валидации 24
3.2.24.3 Реестр ресурсов 24
3.2.34.4 Кеширование транформаторов и валидаторов 26
Заключение 27
Приложение 1. Листинг схемы языка DRL 30
Приложение 2. Пример 33
Введение
В любом коммерческом проекте неизбежно возникает необходимость написания значительного объема документации. При этом зачастую перед техническим писателем встают задачи, для эффективного выполнения которых недостаточно имеющихся средств. Спектр таких задач может включать, например, повторное использование готовых частей документации при одновременной разработке схожих программных продуктов или семейств программных продуктов. В такой ситуации, обычно, приходится использовать банальное копирование текста, что может привести к значительным трудностям при исправлении ошибок и дополнении документации. Ведь, как правило, практически любое изменение в коде требует корректировки документации.
Вопрос повторного использования фрагментов документации особенно актуален при разработке семейств программных продуктов. Семейство программных продуктов – это набор программных систем, имеющих общий набор функциональности, удовлетворяющих нуждам конкретного сегмента рынка или конкретной цели и разрабатываемых установленным образом из общего набора повторно используемых активов [10][1]. В роли повторно используемых активов, как правило, выступают программные компоненты, архитектура, тестовые сценарии и т.п. При этом за рамками рассмотрения, обычно, оказывается документация, разработка которой является достаточно трудоемким процессом. Специфика задачи в данном случае состоит в том, что для каждого продукта из семейства имеется свой пакет документации, и все эти пакеты довольно схожи между собой. В такой ситуации, очевидно, использование лишь стандартного текстового редактора становится неэффективным. Возникает потребность в более мощных средствах разработки документации.
На данный момент популярно несколько подходов создания сложной технической документации. Среди них стоит выделить подход, предложенный компанией IBM, под названием DITA (Darwing Information Typing Architecture) [11][2]. Этот подход позволяет достичь повторного использования отдельных блоков текста документации, так называемых «топиков» (от англ. topic). Другой распространенный подход – DocBook [3]. Среди его достоинств стоит выделить поддержку принципа единого исходного представления (Single Sourcing) [6][4], т.е. возможность автоматически создавать документацию в различных форматах из единого набора исходных текстов.
Эти подходы, однако, имеют ряд недостатков. В частности, в контексте разработки документации семейств программных продуктов, они не предоставляют достаточной гибкости. Это связано с тем, что, как отмечалось в [5,6], фактически, единственным средством реализации вариативности в них является условное включение блока текста. Более тонкая, «мелкозернистая» адаптация фрагментов текста не предусматривается.
В работе [6] описан подход к разработке документации DocLine, решающий указанные проблемы. Подход к разработке документации DocLine, решающий указанные проблемы, описан в работе [8]. Данный подход включает в себя процесс разработки документации, язык разметки документации DRL (Document Reuse Language), имеющий текстовую (DRL/PR – DRL/ Phrase Representation) и графическую (DRL/GR – DRL/ Graphic Representation) нотации, а также архитектуру инструментальных средств. В отличие от упомянутых выше подходов, подход DocLine обеспечивает как «крупноблочное» повторное использование текстов, так и «мелкозернистую» адаптацию фрагментов текста. Кроме того, в языке DRL/PR, для разметки документации используются конструкции DocBook, что в итоге позволяет использовать преимущества принципа единого исходного представления для создания пакетов документации в различных форматах.
Данная работа выполнена в рамках исследовательского проекта по созданию метода разработки документации семейств программных продуктов, выполняемого на кафедре системного программирования СПбГУ [8,13][5,6]. В данной работе представлена реализация инструментария для разработки документации семейств программных продуктов, включающая специализированный текстовый редактор для DRL/PR и систему трансляции DRL-документации в форматы HTML и PDF. Также относится к проекту дипломная работа Алексея Семенова [16][8] – в ней представлена реализация средств графического моделирования в нотации DRL/GR с поддержкой прямой и обратной трансляции в DRL/PR.
|
