Метод повторного использования документации семейств программных продуктов

• Автор: Романовский, Константин Юрьевич
• Шифр специальности: 05.13.11
• Научная степень: Кандидатская
• Год защиты: 2010
• Место защиты: Санкт-Петербург
• Количество страниц: 110 с. : ил.

Содержание
ВВЕДЕНИЕ.

ГЛАВА 1. ОБЗОР СУЩЕСТВУЮЩИХ ПОДХОДОВ.

1.1 ППвТОРНОЕ ИСПОЛЬЗОВАНИЕ

1.1.1 Метод БассетоЕрзабеко.

1.1.2 Диаграммы возможностей.

1.1.3 Разработка СПП.

1.1.4 Эталонные модели процесса розроботки СПП.

1.2 Разработка технической документации

1.2.1 ОосВоок

1.2.2 ТА.
1.2.3 ЕгатеМокег.
1.3 РЕФАКТОРИНГ
1.4 ПРЕДМЕТНООРИЕНТИРОВАННОЕ МОДЕЛИРОВАНИЕ
1.5 Средства формализации текстовых и графических языков.
1.6 Выводы ОБЗОРА
ГЛАВА 2. ЯЗЫК ОШ.
2.1 ОЯЯ.
2.1.1 Главная диаграмма
2.1.2 Диаграмма вариативности
2.1.3 Диогромма продукта.
2.2 ОШРЯ
2.2.1 Адоптивное крупноблочное повторное использование.
2.2.2 Адоптивное мелкозернистое повторное использование
2.2.3 Условные блоки.
2.3 Интеграция языка от с форматом ОосВоок.
ГЛАВА 3. ПРОЦЕСС РАЗРАБОТКИ ДОКУМЕНТАЦИИ.
3.1 Целесообразность применения 0сс1же.
3.2 Проактивный процесс
3.3 Гибкий процесс.
3.4 Операции рефакторинга
3.4.1 Создание общих активов.
3.4.2 Настройка общих активов
3.4.3 Настройка мелкозернистого повторного использования.
3.4.4 Переименование.
3.4.5 Пример применения рефакторинга.
ГЛАВА 4. ИНСТРУМЕНТАЛЬНЫЙ ПАКЕТ.
4.1 Архитектура инструментального пакета
4.2 Текущий статус разработки.
4.3 Графический редактор и менеджер циклической разработки
4.4 Текстовый редактор
4.5 Рефакторинг.
4.6 Публикация конечных документов и провтрка корректности
ГЛАВА 5. АПРОБАЦИЯ.
5.1 ОБЫ кг АПРОБАЦИИ
5.2 Ход апробации.
5.2.1 Изучение и анализ предметной области.
5.2.2 Планирование повторного использования
5.2.3 Выделение и спецификация переиспользуемых компонент
5.2.4 Задание форматирования документов средствами ОосВоок.
5.3 Особенности использования ОосЬке
5.3.1 8ариотивность продуктов семейства
5.3.2 Схема вариативности документации.
5.3.3 Настройка адаптивности.
5.4 Анализ результатов апробации
ГЛАВА 6. СРАВНЕНИЯ И СООТНЕСЕНИЯ
ЗАКЛЮЧЕНИЕ
СПИСОК ЛИТЕРАТУРЫ


Поэтому одну и ту же функциональность часто описывают разными словами. В результате при разработке документации применяют простейший метод повторного использования - копирование и исправление (сору/рав1е/тосН? Этот метод хорошо подходит для документов, которые создаются «раз и навсегда» и не требуют дальнейшего сопровождения. Однако в случае, когда сопровождение все-таки требуется, любые изменения (расширения, исправление ошибок и т. В случае документации для СПГТ для каждого продукта создается стан-дартный пакет документов и появляется необходимость повторного использования значительных по размерам фрагментов текста между документами для разных продуктов. К сожалению, в рамках существующих подходов к разработке СПП создание и поддержка пользовательской документации ПО не выделяется в отдельную задачу, и подходящие методы и инструментальные средства отсутствуют. В отдельных отчетах об индустриальных внедрениях подхода СПП упоминается о важности повторного использования документации (например, в []), однако не предлагается соответствующих методов и средств. В данной работе предложен новый метод разработки документации семейств программных продуктов DocLinc (основные идеи DocLine изложены в работах [8], [9]). Данный метод восполняет разрыв между методами разработки семейств программных продуктов и подходами разработки технической документации. DocLine охватывает весь жизненный цикл разработки документации от проектирования до публикации итоговых документов и поддерживает плановое адаптивное повторное использование. В DocLine явно выделяется исходное и целевое представление документации. Целевое представление - это документы в привычных для пользователя форматах, таких как PDF для печатных документов, HTML для электронных или HTML Help для справочных систем. Целевое представление может быть в любой момент получено из исходного автоматически - эта операция называется публикацией, подобно компиляции исполняемого кода ПО из его исходных текстов. Для исходного представления документации в DocLine предлагается оригинальный проблемно-ориентированный язык DRL (Documentation Reuse Language) [И]. DRL, подобно другому проблемно-ориентированному языку SDL (Specification and Description Language, []), имеет две нотации - графическую (DRL/GR - Graphic Representation) и текстовую (DRL/PR - Phrase Representation). Текстовое представление позволяет описать варианты конфигурирования повторно используемых компонент и, собственно, сами конкретные конфигурации для порождения конечных документов. Наряду с языком DRL метод DocLine определяет также эталонные модели процесса разработки документации - проактивную и «гибкую». В рамках проактивной модели сначала проводится проектирование схемы повторного использования и разработка адаптивных повторно-используемых компонент, а затем на основе созданной инфраструктуры создаются пакеты документов для конкретных продуктов. В «гибком» процессе сначала создаются требуемые документы, а затем, по мере необходимости, документация подвергается рефакторингу [7J, []. То есть на основе конкретных документов стоится инфраструктура повторного использования и исходное представление документов перестраивается на использование этой инфраструктуры, при этом целевое представление остается неизменным. Для практического применения DocLine предложена архитектура пакета инструментальных средств, на основе которой реализована версия пакета, встроенная в интегрированную среду разработки приложений Eclipse. Также была реализована базовая версия пакета на платформе Microsofl. NET. Для порождения документов в различных целевых форматах (PDF и HTML) DocLine интегрирован с популярной технологией DocBook. Метод DocLine был апробирован на примере пользовательской документации семейства телекоммуникационных систем, разрабатываемого ЗАО «Ланит-Терком». Продукты семейства — цифровые телефонные станции типа «Квант-Е» различного назначения - офисные, сельские, городские, транзитные и др. Объектом апробации стали руководства пользователя для двух разных продуктов семейства (общим объемом около 0 страниц).