Курсовая работа: Расширение метода рефакторинга документации семейств программных продуктов

Содержание












2

• Введение

Любой программный продукт обычно сопровождается технической документацией. Такая документация бывает разной: общие описания программных систем, различные руководства (пользователей, администраторов, операторов), справочные системы и др. Чем сложнее программный продукт, тем сложнее его техническая документация, и разработка документации оказывается трудоѐмким процессом.

Зачастую программные продукты удобно разрабатывать семействами. Разработка семейств программных продуктов (СПП) является одним из подходов к промышленной разработке программного обеспечения и использует единый процесс разработки на основе повторно используемых активов [5]. Документация к таким продуктам имеет широкие возможности для переиспользования: она может разрабатываться в контексте целого семейства и уточняться для каждого конкретного продукта.

Существуют разные XML-подходы к разработке технической документации, в некоторой степени поддерживающие повторное использование. Среди них выделяются DITA [13] и DocBook [16]. Основной постулат технологии DITA состоит в том, что текст технической документации состоит из типизированных фрагментов (т.н. топиков), которые и переиспользуются. DocBook — это технология разработки документации, позволяющая из единого представления документа автоматически получать разные выходные форматы (наиболее распространенные — HTML, PDF), с разными вариантами компоновки и оформления. Несмотря на широкое распространение, оба подхода не поддерживают независимую настройку общих активов в документации каждого из продуктов семейства: либо общие фрагменты текста используются без адаптации под конкретный продукт, либо они копируются, и изменяются уже их копии.

На кафедре системного программирования математико-механического факультета СПбГУ выполняется исследовательский проект DocLine, посвященный созданию метода разработки документации на основе повторного