ВКР: Система визуального проектирования документации семейств программных продуктов

Оглавление

1. Введение.................................................................................................................................... 3
2. Постановка задачи.................................................................................................................... 5
3. Обзор литературы..................................................................................................................... 6
3.1. Семейства программных продуктов................................................................................ 6
3.2. Диаграммы возможностей................................................................................................ 7
3.3. Предметно-ориентированное моделирование................................................................ 8
3.4. Платформа Eclipse GMF................................................................................................... 9
3.5. Метод DocLine и язык DRL............................................................................................ 12
3.5.1. Процесс разработки документации........................................................................ 13
3.5.2. Обзор графической нотации DRL.......................................................................... 13
3.5.3. Обзор текстовой нотации DRL............................................................................... 15
3.6. Выводы............................................................................................................................. 17
4. Архитектура визуальных средств......................................................................................... 18
4.1. Модель EMF..................................................................................................................... 19
4.1.2. Структура модели.................................................................................................... 20
4.1.3. Сохранение и загрузка в формате DRL/PR........................................................... 21
4.2. Сохранение разметки и текста документа.................................................................... 22
4.3. Интеграция....................................................................................................................... 23
5. Особенности реализации....................................................................................................... 25
5.1. Дерево документа DRL................................................................................................... 25
5.2. Главная диаграмма...................................................................................................... 27
5.3. Диаграмма вариативности......................................................................................... 28
5.4. Синхронизация визуального представления и текста документации.................... 30
6. Пример..................................................................................................................................... 31
7. Заключение............................................................................................................................. 34
8. Литература.............................................................................................................................. 35
Приложение 1. Преобразование из DRL в XMI..................................................................... 36
Приложение 1. Преобразование из DRL в XMI..................................................................... 36
Приложение 2. Преобразование из XMI в DRL...................................................................... 38
Приложение 2. Преобразование из XMI в DRL...................................................................... 38
Приложение 3. Пример файла с общими элементами DRL................................................... 39
Приложение 3. Пример файла с общими элементами DRL................................................... 39

1. Введение

Разработка семейств программных продуктов – популярный и потенциально чрезвычайно эффективный метод разработки ПО, позволяющий повторно использовать различные активы разработки, такие как модели, программные компоненты, требования [1, 2].
Техническая документация продуктов, составляющих семейство, может иметь значительный объём, при этом требования к качеству документации нередко бывают весьма высокими. В таких случаях и разработка, и поддержка этой документации в актуальном состоянии являются чрезвычайно трудоёмкими процессами.
Известно несколько популярных подходов к разработке сложной технической документации. Например, подход единого исходного представления (Single Sourcing) обеспечивает разделение содержания и форматирования [3]. При его использовании возможно на основе единого исходного представления получить комплект документов, таких как руководство пользователя, справочная система и т.п. Другой распространённый подход – DITA (Darwin Information Typing Architecture), предложенный компанией IBM [4]. В рамках этого подхода предлагается строить документацию как набор отдельных блоков текста, так называемых «топиков», каждый из которых может быть использован в любом контексте в произвольном документе.
Документация семейств программных продуктов предоставляет особенно широкие возможности для переиспользования, причём не только на уровне крупных блоков текста – глав или параграфов, но также и на уровне названий, обозначений и т.п. Связано это в том числе и с тем, что документация обычно имеет структурные элементы, соответствующие программным компонентам, комбинируемым при построении продуктов в семействе. При этом переиспользуемые элементы в каждом конкретном случае нуждаются в адаптации к контексту использования и поэтому должны быть в определённой степени изменчивы, это свойство компонент называется «вариативностью».
Однако рассмотренные подходы не учитывают особенностей разработки документации в рамках семейств программных продуктов – средства переиспользования в них не предоставляют достаточной гибкости. Фактически основным способом реализации вариативности в них является условное включение блока текста, а более тонкая адаптация фрагмента к контексту невозможна.
В работе [2] представлен метод разработки документации семейств программных продуктов DocLine. Он включает модельно-ориентированный процесс разработки, согласованный с процессом разработки семейств программных продуктов, язык разметки документации DRL/PR (Documentation Reuse Language/Phrase Representation, дальше в тексте мы будем называть его просто DRL) и визуальную нотацию для проектирования документации DRL/GR (Documentation Reuse Language/Graphical Representation). Визуальная модель основана на нотации диаграмм возможностей, широко применяемой при разработке семейств программных продуктов [5], и включает диаграммы трёх видов:

• главная диаграмма – диаграмма верхнего уровня, она содержит список продуктов семейства и список шаблонов документов («информационных продуктов») из документации семейства,
• диаграмма вариативности – отображает структуру информационного продукта: входящие в него информационные элементы и связи между ними,

диаграмма продукта – показывает структуру документа