ЗМІСТ
ВСТУП
. ПРЕДМЕТНА ОБЛАСТЬ
. АУДИТОРІЯ
. ФРАГМЕНТИ
. СТВОРЕННЯ СХОВИЩА ДЛЯ XML-ФРАГМЕНТІВ
. СТВОРЕННЯ ШАБЛОНІВ ДЛЯ ДОКУМЕНТАЦІЇ
. ВИБІР СТИЛЮ ДЛЯ ОПИСУ ДОКУМЕНТАЦІЇ
. СТВОРЕННЯ ФРАГМЕНТІВ
. ФОРМУВАННЯ ВИХІДНИХ ДОКУМЕНТІВ
ВИСНОВОК
СПИСОК ВИКОРИСТАНИХ ДЖЕРЕЛ
ДОДАТКИ
ВСТУП
Проектування технічної документації це дуже велика тема. Існує безліч інструментів, які полегшують процес розробки документації. Наприклад, система контролю версій Subversion, яка дозволяє «відкочувати» проект при виникненні будь-яких помилок. У даній роботі Subversion застосовується досить активно. Також варто відзначити, що в даній роботі документація проектується з використанням DocBook - набору тегів XML, за допомогою яких можна створювати структуровані документи.
1. ПРЕДМЕТНА ОБЛАСТЬ
Предметна область даного курсового проекту - «Готель».
У кожного підприємства і кожної організації, що надає різні послуги і працюючої з безліччю клієнтів повинна матися своя інформаційна система. Вона покликана здійснювати такі найважливіші функції як збір, зберігання, актуалізація, надання користувачам інформаційних ресурсів.
Готель - не виняток. Інформаційна система «Готель» повинна систематизувати і спростити процес бронювання клієнтами номерів і візуалізувати список послуг надаються готелем.
В даному курсовому проекті розробляється документація до описаної інформаційній системі.
2. Аудиторія
При розробці клієнтського додатку було виділено два рівня доступу до інформаційної системи: користувач та адміністратор. Таке розмежування цілком зрозуміло: користувач - клієнт, який бажає забронювати номер, адміністратор - працівник готелю, який здійснює процес бронювання.
Користувач такої інформаційної системи повинен мати можливість переглянути список доступних номерів та їх характеристики. Адміністратор може переглядати список клієнтів готелю і здійснювати процес бронювання номерів.
3. Фрагменти
Фрагменти - окремі xml-файли, відповідні якої частини документації, з яких створюється єдиний xml-файл. Поділ документації на окремі фрагменти спрощує процес її редагування.
Відповідно до предметної областю, описаної в розділі 1 і аудиторією, описаної в розділі 2 можна виділити наступні фрагменти:
1) Загальні відомості;
2) Керівництво користувача;
· Вхід в систему;
· Номери;
· Бронювання номера;
· Послуги;
3) Керівництво адміністратора;
· Вхід в систему;
· Номери;
· Клієнти;
4) Автори.
4. Створення сховища для XML-фрагментів
Для ефективної розробки документації в даному курсовому проекті використовується система контролю версій Subversion. Д...