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

Оглавление
Введение
1. Постановка задачи
2. Обзор литературы
2.1 Семейства программных продуктов
2.2 Метод DocLine и язык DRL
2.2.1 Процесс
2.2.2 Обзор графической нотации DRL
2.2.3 Обзор текстовой нотации DRL
2.3 Технология DocBook
2.4 Платформа Eclipse
3 Архитектура
3.1 Текстовый редактор
3.2 Трансляция
3.3 Валидация
4 Особенности реализации
4.1 Агрегация XML-документов в процессе трансляции.
4.2 Механизм привязок, используемый для валидации
4.3 Реестр ресурсов
4.4 Кеширование транформаторов и валидаторов
5 Пример
Заключение
Ссылки
Приложение 1. Листинг схемы языка DRL
Приложение 2. Пример
Приложение 3. Использованные сокращения

Введение

В любом коммерческом проекте неизбежно возникает необходимость написания значительного объема документации. При этом зачастую перед техническим писателем встают задачи, для эффективного выполнения которых недостаточно имеющихся средств. Спектр таких задач может включать, например, повторное использование готовых частей документации при одновременной разработке схожих программных продуктов или семейств программных продуктов. В такой ситуации, обычно, приходится использовать банальное копирование текста, что может привести к значительным трудностям при исправлении ошибок и дополнении документации. Ведь, как правило, практически любое изменение в коде требует корректировки документации.
Вопрос повторного использования фрагментов документации особенно актуален при разработке семейств программных продуктов. Семейство программных продуктов – это набор программных систем, имеющих общий набор функциональности, удовлетворяющих нуждам конкретного сегмента рынка или конкретной цели и разрабатываемых установленным образом из общего набора повторно используемых активов [1]. В роли повторно используемых активов, как правило, выступают программные компоненты, архитектура, тестовые сценарии и т.п. При этом за рамками рассмотрения, обычно, оказывается документация, разработка которой является достаточно трудоемким процессом. Специфика задачи в данном случае состоит в том, что для каждого продукта из семейства имеется свой пакет документации, и все эти пакеты довольно схожи между собой. В такой ситуации, очевидно, использование лишь стандартного текстового редактора становится неэффективным. Возникает потребность в более мощных средствах разработки документации.
На данный момент популярно несколько подходов создания сложной технической документации. Среди них стоит выделить подход, предложенный компанией IBM, под названием DITA (Darwing Information Typing Architecture) [2]. Этот подход позволяет достичь повторного использования отдельных блоков текста документации, так называемых «топиков» (от англ. topic). Другой распространенный подход – DocBook [3]. Среди его достоинств стоит выделить поддержку принципа единого исходного представления (Single Sourcing) [4], т.е. возможность автоматически создавать документацию в различных форматах из единого