Разработка версионированного комплекса технической документации для информационной системы "Отель"

Размещено на http://www.allbest.ru/

ОГЛАВЛЕНИЕ

ВВЕДЕНИЕ

1. ПРЕДМЕТНАЯ ОБЛАСТЬ

2. АУДИТОРИЯ

3. ФРАГМЕНТЫ

4. СОЗДАНИЕ ХРАНИЛИЩА ДЛЯ XML-ФРАГМЕНТОВ

5. СОЗДАНИЕ ШАБЛОНОВ ДЛЯ ТЕХНИЧЕСКОЙ ДОКУМЕНТАЦИИ

6. ВЫБОР СТИЛЯ ДЛЯ ОПИСАНИЯ ДОКУМЕНТАЦИИ

7. СОЗДАНИЕ ФРАГМЕНТОВ

8. ФОРМИРОВАНИЕ ВЫХОДНЫХ ДОКУМЕНТОВ

ЗАКЛЮЧЕНИЕ

СПИСОК ИСПОЛЬЗОВАННЫХ ИСТОЧНИКОВ

ПРИЛОЖЕНИЯ

ВВЕДЕНИЕ

Проектирование технической документации это очень обширная тема. Существует множество инструментов, которые облегчают процесс разработки документации. Например, система контроля версий Subversion, которая позволяет «откатывать» проект при возникновении каких-либо ошибок. В данной работе Subversion применяется достаточно активно. Также стоит отметить, что в данной работе документация проектируется с использованием DocBook - набора тегов XML, с помощью которых можно создавать структурированные документы.

1. ПРЕДМЕТНАЯ ОБЛАСТЬ

Предметная область данного курсового проекта - «Отель».

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

Отель - не исключение. Информационная система «Отель» должна систематизировать и упростить процесс бронирования клиентами номеров и визуализировать список услуг предоставляемых отелем.

В данном курсовом проекте разрабатывается документация к описанной информационной системе.

2. Аудитория

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

Пользователь такой информационной системы должен иметь возможность просмотреть список доступных номеров и их характеристики. Администратор может просматривать список клиентов отеля и осуществлять процесс бронирования номеров.

3. Фрагменты

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

В соответствии с предметной областью, описанной в разделе 1 и аудиторией, описанной в разделе 2 можно выделить следующие фрагменты:

1) Общие сведения;

2) Руководство пользователя;

· Вход в систему;

· Номера;

· Бронирование номера;

· Услуги;

3) Руководство администратора;

· Вход в систему;

· Номера;

· Клиенты;

4) Авторы.

4. Создание хранилища для XML-фрагментов

Для эффективной разработки документации в данном курсовом проекте используется система контроля версий Subversion. Для удобства работы с системой используется графическая оболочка TortoiseSVN. SVN позволяет отменять все ненужные изменения во фрагментах документации. Создадим хранилище для проекта разрабатываемой документации (рис. 1)

Рисунок 1 - Создание хранилища SVN

5. Создание шаблонов для технической документации

Файл manual.xml

<?xml version='1.0' encoding='UTF-8'?>

<!-- This document was created with Syntext Serna Free. -->

<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "docbookV4.4/docbookx.dtd" []>

<book lang="ru">

<title>Эксплуатационные документы по информационной системе &quot;Отель&quot;</title>

<bookinfo>

<author>

<surname>Засовин</surname>

<firstname>Вадим</firstname>

<address>г.Рязань</address>

</author>

</bookinfo>

<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="overview.xml" encoding="UTF-8"/>

<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="user.xml" encoding="UTF-8"/>

<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="autors.xml" encoding="UTF-8"/>

</book>

Файл user.xml

<?xml version='1.0' encoding='UTF-8'?>

<!-- This document was created with Syntext Serna Free. -->

<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "docbookV4.4/docbookx.dtd" []>

<chapter lang="ru">

<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href= "user_enter.xml" encoding="UTF-8"/>

<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href= "user_numbers.xml" encoding="UTF-8"/>

<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href= "user_reservation.xml" encoding="UTF-8"/>

<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href= "user_services.xml" encoding="UTF-8"/>

<title>Руководство пользователя</title>

</chapter>

Файл admin.xml

<?xml version='1.0' encoding='UTF-8'?>

<!-- This document was created with Syntext Serna Free. -->

<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "docbookV4.4/docbookx.dtd" []>

<chapter lang="ru">

<title>Руководство администратора</title>

<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href= "admin_enter.xml" encoding="UTF-8"/>

<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href= "admin_numbers.xml" encoding="UTF-8"/>

<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href= "admin_clients.xml" encoding="UTF-8"/>

</chapter>

Файл autors.xml

<?xml version='1.0' encoding='UTF-8'?>

<!-- This document was created with Syntext Serna Free. -->

<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "docbookV4.4/docbookx.dtd" []>

<chapter lang="ru">

<title>Авторы</title>

</chapter>

Ниже для примера также приведен шаблон, соответствующий одному из разделов главы «Руководство пользователя» :

Файл user_numbers.xml

<?xml version='1.0' encoding='UTF-8'?>

<!-- This document was created with Syntext Serna Free. -->

<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "docbookV4.4/docbookx.dtd" []>

<section lang="ru">

<title>Номера</title>

</section>

6. ВЫБОР СТИЛЯ ДЛЯ ОПИСАНИЯ ДОКУМЕНТАЦИИ

XSL (eXtensible Stylesheet Language) - семейство рекомендаций консорциума W3C, описывающее языки преобразования и визуализации XML-документов. XSL Состоит из трех частей:

- XSL Transformation (XSLT) - язык преобразования XML-документов;

- XSL Formatting Objects (XSL-FO) - язык разметки типографских макетов и иных предпечатных материалов;

- XPath - язык путей и выражений, используемый в XSLT для доступа к отдельным частям XML-документа.

С помощью XSL можно трансформировать XML-документ в любой вид (HTML, WML, RTF, PDF, SQL и т. д.). XSL несёт в себе информацию о том, как будет оформлен документ, где и как будут располагаться данные.

Для создания документации в данном проекте используются официальные таблицы стилей для DocBook v4.4.

7. Создание фрагментов

Как уже говорилось выше, для обеспечения контроля версий разрабатываемой документации используется система Subversion и ее графическая оболочка TortoiseSVN. Для начала работы создадим рабочую копию (рисунок 2, рисунок 3).

Далее необходимо добавить в рабочую копию заготовки технической документации, описанные в разделе 5. Воспользуемся TortoiseSVN (рисунок 4, рисунок 5).

Рисунок 2 - Создание рабочей копии



Рисунок 3 - Результат создания рабочей копии

Рисунок 4 - Добавление заготовок фрагментов в рабочую копию

Рисунок 5 - Результат добавления файлов в рабочую копию

Теперь необходимо зафиксировать изменения (рисунок 6, рисунок 7).



Рисунок 6 - Фиксация изменений, сделанных в рабочей копии

Рисунок 7 - Результат выполнения фиксации изменений

При создании документации используются также графические файлы, например картинки, которые также необходимо добавить в рабочую копию (рисунки 8,9).



Рисунок 8 - Фиксация изменений в рабочей копии

Рисунок 9 - Результат добавления картинки и фиксации изменений

Далее необходимо приступить к редактированию подготовленных заготовок фрагментов.

Рассмотрим редактирование фрагмента на примере редактирования файла overview.xml (общие сведения).

Для создания и редактирования XML-файлов используется простой текстовый редактор, способный отображать синтаксис XML-документа, и визуальный редактор XML Syntext Serna. Другое название визуальных редакторов - WYSIWYG (What You See Is What You Get) редакторы. Это означает, что содержимое отображается в процессе редактирования и выглядит максимально близко похожим на конечную продукцию, которая может быть печатным документом или веб-страницей. В Syntext Serna внешний вид документа контролируется с помощью стилей XSLT/XSL-FO.

Рисунок 10 - Результат фиксации изменений, сделанных в файле overview.xml

Добавим в главу «Общие сведения» информацию о рассматриваемой информационной системе. После добавления текста необходимо зафиксировать изменения (рисунок 10).

Аналогичным образом редактируются оставшиеся фрагменты.

После редактирования всех фрагментов также необходимо выполнить фиксацию (рисунок 11).

Рисунок 11 - Результат фиксации всех выполненных изменений



8. Формирование выходных документов

В курсовом проекте предусмотрено четыре выходных документа: для пользователя и администратора в двух форматах. Итого четыре документа. Рассмотрим процесс формирования выходных документов для пользователя.

1) HTML - стандартный язык разметки документов при создании веб-страниц.

Для преобразования в HTML используется XSLT processor xlstproc. Существуют альтернативные версии XSLT-процессоров, например, Xalan или Saxon. Однако xsltproc считается самым быстрым из них (он написан на C), является проектом с открытым исходным кодом и включён в комплект Syntext Serna - визуального редактора XML, используемого при разработке документации.

Рисунок 12 - Формирование выходного документа в формате HTML

2) Для получения документации в формате PDF будем использовать консольную утилиту wkhtmltopdf, которая конвертирует HTML- файл в PDF.



Рисунок 13 - Процесс конвертирования HTML в PDF

В приложении Б представлены фрагменты выходных документов в обоих форматах.



ЗАКЛЮЧЕНИЕ

информационный отель технический документация

В рамках данного курсового проекта были рассмотрены действия по созданию и обслуживанию технической документации (эксплуатационных документов по информационной системе «Отель»). Для обеспечения надлежащего контроля над разработкой проекта была использована система контроля версий Subversion.

СПИСОК ИСПОЛЬЗОВАННЫХ ИСТОЧНИКОВ

1. Бабаев С.И. Офисные системы и утилиты разработки приложений [Текст]: методические указания к лабораторным работам / C.И. Бабаев, А.И. Баранчиков - Рязань: РГРТУ, 2010. - 32 с.

2. Генерация HTML в PDF через wkhtmltopdf [Электронный ресурс] // habrahabr.ru: [сайт]. URL: http://habrahabr.ru/sandbox/23506/ (дата обращения: 14.12.2013).

3. Version Control with Subversion [Электронный ресурс] // Управление версиями в Subversion: [сайт]. URL: http://svnbook.red-bean.com/en/1.8/ (дата обращения: 14.12.2013).

ПРИЛОЖЕНИЕ А

Файл overview.xml

<?xml version='1.0' encoding='UTF-8'?>

<!-- This document was created with Syntext Serna Free. -->

<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "docbookV4.4/docbookx.dtd" []>

<chapter lang="ru">

<title>Общие сведения</title>

<para> У каждого предприятия и каждой организации, предоставляющей различные услуги и работающей с множеством клиентов должна иметься своя информационная система. Она призвана осуществлять такие важнейшие функции как сбор, хранение, актуализация, предоставление пользователям информационных ресурсов.

Отель - не исключение. Информационная система «Отель» должна систематизировать и упростить процесс бронирования клиентами номеров и визуализировать список услуг предоставляемых отелем.

</para>

<para>Пользователь такой информационной системы должен иметь возможность просмотреть список доступных номеров и их характеристики. Администратор может просматривать список клиентов отеля и осуществлять процесс бронирования номеров.</para>

</chapter>

Файл user.xml

<?xml version='1.0' encoding='UTF-8'?>

<!-- This document was created with Syntext Serna Free. -->

<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "docbookV4.4/docbookx.dtd" []>

<chapter lang="ru">

<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href= "user_enter.xml" encoding="UTF-8"/>

<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href= "user_numbers.xml" encoding="UTF-8"/>

<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href= "user_reservation.xml" encoding="UTF-8"/>

<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href= "user_services.xml" encoding="UTF-8"/>

<title>Руководство пользователя</title>

</chapter>

Файл admin.xml

<?xml version='1.0' encoding='UTF-8'?>

<!-- This document was created with Syntext Serna Free. -->

<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "docbookV4.4/docbookx.dtd" []>

<chapter lang="ru">

<title>Руководство администратора</title>

<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href= "admin_enter.xml" encoding="UTF-8"/>

<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href= "admin_numbers.xml" encoding="UTF-8"/>

<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href= "admin_clients.xml" encoding="UTF-8"/>

</chapter>

Файл autors.xml

<?xml version='1.0' encoding='UTF-8'?>

<!-- This document was created with Syntext Serna Free. --><!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "docbookV4.4/docbookx.dtd" []>

<chapter lang="ru">

<title>Авторы</title>

<para>Студент группы 041 Засовин В.А.</para>

</chapter>



ПРИЛОЖЕНИЕ Б

Рисунок 14 - Выходной документ в формате HTML

Рисунок 15 - Выходной документ в формате PDF

Размещено на Allbest.ru