Файл: Языки гипертекстовой разметки (Понятие представления данных и обоснование проблемы).pdf

В состав программной документации также входит экранная помощь пользователю отчетов. Подготовка программной документации для подсистемы «Быстрые отчеты» SQL имеет ряд важных особенностей:

- SQL запросы могут достаточно часто меняться во время эксплуатации системы темы, вместе с этим также изменяется внешний вид отчетов, и, следовательно, должна меняться документация;

- Программная документация должна формироваться во всех указанных выше видах - Для конечного пользователя, для программиста, экранная помощь;

- Документация для пользователя должна быть представлена ​​в нескольких форматах - в формате набора HTML-страниц и фор мате PDF-файла;

- Программная документация в виде экранной помощи реализуется с по мощью специальной программной системы и поэтому исходная информация для нее имеет быть представлена ​​в виде XML - файлов специального формата;

- При эксплуатации системы могут появляться новые отчеты SQL и удаляться существующие.

Рис. 1. Диаграмма использования документации подсистемы

Все эти факторы приводят к тому, что система подготовки программной документации, а особенно - система сопровождения программной документации должны быть очень динамичными и должны позволять быструю подготовку различных форматов документации из одного источника.

В качестве основной системы документирования, на основании проведенного анализа, выбранная система документирования DocBook (реализация для Windows).

Для получения необходимой документации экранной помощи в виде XML-файла, структура которого определена внешней системой подготовки экранной помощи, необходимо разработать скрипт конвертации средствами XSLT (речь преобразования XML - документов). Схема подготовки документации для подсистемы «Быстрые отчеты» SQL будет иметь вид, изображенный на рис. 2. Однако, подготовка описаний в формате DocBook для большого числа отчетов будет весьма трудоемкой , по этому проще готовить начальные описания по значительно упрощенному шаблону «XML в специальном формате» (для системы помощи).

Модифицированная схема подготовки документации приведена на рис. 3. Такое изменение направления потока данных в рабочем процессе приведет к экономии многих часов работы операторов по подготовке исходных описаний отчетов.

Рис. 2. Схема подготовки документации (вариант 1)

Такой процесс подготовки документации является эквивалентным хорошо известному в программировании процессу компиляции и сборки большого программного продукта.