АППЗ_ЛР

61

12.4 Зміст звіту

12.4.1Тема та мета роботи.

12.4.2Тема, обрана для проектування.

12.4.3Загальна схема роботи системи.

12.4.4Вимоги до функціональності.

12.4.5Архітектура веб-додатку після використання модулів.

12.4.6Структура веб-додатку після використання модулів.

12.4.7Висновки, що містять відповіді на контрольні запитання,

атакож відображають результати виконання роботи та їх критичний аналіз.

12.5 Контрольні запитання

12.5.1Що таке модуль?

12.5.2Які модулі включає стандартний набір модулів обраної

CMS?

12.5.3З яких файлів складається модуль розширення функціо-

нальності?

12.5.4Як інсталювати модуль розширення функціональності в обрану CMS?

62

13 ЛАБОРАТОРНА РОБОТА № 13 РОБОТА З СИСТЕМОЮ КОНТРОЛЮ ВЕРСІЙ.

ВЕРСІЙНІСТЬ ЗАСТОСУВАНЬ

13.1 Мета роботи

Вивчити основні можливості систем контролю версій на прикладі системи Subversion, навчитися підтримувати версійність вебдодатків.

13.2 Короткі теоретичні відомості

Система керування версіями (від англ. системи контролю версій, VCS або Revision Control System) – ПЗ для полегшення роботи зі змінною інформацією. Система керування версіями дозволяє зберігати декілька версій одного і того ж документа, при необхідності повертатися до більш ранніх версій, визначати, хто і коли зробив ту або іншу зміну, і багато іншого. Такі системи найбільш широко використовуються при розробленні ПЗ для зберігання вихідних кодів програми.

Репозиторій (сховище) – місце, де зберігаються та підтримуються будь-які дані. Найчастіше дані в репозиторії зберігаються у вигляді файлів. Репозиторії використовуються в системах управління версіями, в них зберігаються всі документи разом з історією їх зміни та іншою службовою інформацією.

Subversion (Apache Subversion) – вільна система управління версіями.

Subversion – централізована система. Дані зберігаються в єдиному сховищі. При збереженні нових версій використовується дельтакомпресія, тобто система знаходить відмінності нової версії від попередньої і записує тільки їх, уникаючи непотрібного дублювання даних.

Особливості Subversion:

–Subversion відстежує версії як файлів, так і каталогів;

–якщо зміни зроблені в декількох файлах і каталогах, вони публікуються як одна транзакція;

–при будь-яких оновленнях версій між клієнтом і сервером передаються тільки відмінності між файлами;

63

–Subversion підтримує копіювання, переміщення і перейменування файлів із збереженням історії змін;

–Subversion однаково ефективно працює як з текстовими, так і з бінарними файлами;

–для зберігання версій використовується ієрархія каталогів – для кожної гілки або мітки створюється окремий каталог.

З кожним файлом і каталогом може бути зв'язаний довільний набір властивостей, що складаються з назви і значення. Властивості теж знаходяться під управлінням версіями.

Такий набір властивостей зазвичай використовують для документування процесу розроблення – докладного опису внесених змін.

Деякі команди Subversion, що можуть бути використані розроб-

никами:

− svn update – оновлює зміст локальної копії до останньої версії

зрепозиторію;

− svn commit – відправляє всі зміни локальної копії до репозито-

рію;

−svn add <файл/папка> – включити файл/папку в локальну копію проекту;

−svn move <файл/папка1> <папка2> – перемістити файл/папку1 до папки2;

−svn copy <файл/папка> <папка> – скопіювати файл/папку1 до папки2;

−svn delete <файл/папка> – вилучити файл/папку з локальної копії проекту;

−svn list <URL> – перегляд каталогу репозиторію;

−svn log <файл> --verbose – історія зміни файлу за ревізіями;

−svn cat --revision <номер_ревізії> <файл> – відбиття вмісту файлу з даної ревізії;

−svn diff --revision <номер_ревізії1:номер_ревізії2> <файл> —

відображення змін файлу між двома ревізіями;

−svn status – відображення змін в локальній копії відносно репозиторію.

Subversion не визначає обмежень на файлову структуру проекту.

Унайпростішому випадку у кореневій директорії сховища рекомендується створювати щонайменше три піддиректорії:

−trunk включає файлову структуру основної лінії розробки про-

екту;

64

−branches містить гілки проекту;

−tags містить мітки проекту.

Гілка – напрямок розробки, який існує незалежно від іншого напрямку, але має з ним загальну історію. Для роботи з гілками використовуються наступні команди:

−svn copy <trunk> <нова гілка> – створює гілку зі вказаною назвою з головної лінії розробки;

−svn merge -r <номер_ревізії1:номер_ревізії2> <trunk> – синх-

ронізує гілку з урахуванням ревізій з головною гілкою розробки: <номер_ревізії1> – номер ревізії, коли гілка була «відкрита», <номер_ревізії2> – версія головної гілки розробки, з якою виконується злиття;

−svn switch <гілка> – переключитися на зазначену гілку.

13.3Завдання на лабораторну роботу

13.3.1Ознайомитися з теоретичними відомостями, необхідними для виконання роботи.

13.3.2Ознайомитися з основними можливостями системи конт-

ролю версій Subversion.

13.3.3Створити каталог проекту та базову структуру репозито-

рію.

13.3.4Перенести файли проекту у створений каталог.

13.3.5Відредагувати файли проекту і зберегти версії.

13.3.6Створити нову гілку та переключити робочу копію на неї.

13.3.7Відредагувати файли проекту.

13.3.8Переключити робочу копію на піддиректорію trunk.

13.3.9Злити зміни між гілками.

13.3.10Вилучити гілку.

13.3.11Оформити звіт з роботи.

13.3.12Відповісти на контрольні питання.

13.4 Зміст звіту

13.4.1Тема та мета роботи.

13.4.2Тема, обрана для проектування.

13.4.3Загальна схема роботи системи.

13.4.4Історія зміни файлів проекту за ревізіями.

65

13.4.5Висновки, що містять відповіді на контрольні запитання,

атакож відображають результати виконання роботи та їх критичний аналіз.

13.5 Контрольні запитання

13.5.1Які дії включає звичайний цикл роботи розробника з системою контролю версій?

13.5.2Для збереження яких змін передбачається створення гі-

лок?

13.5.3Яким чином система контролю версій Subversion зберігає

нові версії?

13.5.4Скільки сховищ може використовувати система Subversion для збереження даних?

13.5.5Які можливі варіанти організації репозиторіїв пропонує система Subversion?

13.5.6Що представляє собою сховище системи Subversion?

13.5.7Який принцип називається атомарністю фіксацій?

13.5.8Які операції роботи з гілками надає система Subversion?

66

14 ЛАБОРАТОРНА РОБОТА № 14 ОФОРМЛЕННЯ ПРОЕКТНОЇ ДОКУМЕНТАЦІЇ

14.1 Мета роботи

Навчитися оформляти проектну документацію на ПЗ.

14.2 Короткі теоретичні відомості

14.2.1 Специфікація

Специфікація повинна містити такі розділи:

–документація;

–комплекси;

–компоненти.

Найменування кожного розділу вказують у вигляді заголовку в графі “ Найменування”. Для документів, виконаних друкованим способом, заголовок підкреслюють.

У розділ “ Документація” вносять програмні документи на дану програму, крім специфікації та ТЗ, у порядку зростання коду виду документа, що входить у позначення.

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

Після кожного розділу специфікації необхідно залишати декілька вільних рядків для додаткових записів.

Графи специфікацій заповнюють у такий спосіб:

67

йменування програми, найменування та вид документа для запозичених документів;

2) в розділах “ Комплекси” й “ Компоненти” – повне найменування програми, найменування та вид документа;

– у графі “ Примітка” вказують додаткові дані про програми, що записані в специфікації.

14.2.2 Опис програми

Опис програми повинен містити такі розділи:

Урозділі “ Функціональне призначення” повинні бути зазначені класи розв'язуваних задач і (або) призначення програми та відомості про функціональні обмеження на застосування.

Урозділі “ Опис логічної структури” повинні бути зазначені: алгоритм програми, використані методи, структура програми з описом функції складових частин і зв'язку між ними, зв'язку програми з іншими програмами.

Урозділі “ Використані технічні засоби” повинні бути зазначені типи електронних обчислювальних машин і пристроїв, які використовуються при роботі програми

Урозділі “ Виклик і завантаження” повинні бути зазначені спосіб виклику програми з відповідного носія даних, вхідні точки до програми.

Допускається вказувати адреси завантаження, відомості про використання оперативної пам'яті, обсяг програми.

Урозділі “ Початкові дані” повинні бути зазначені:

68

–характер, організація та попередня підготовка даних,

–формат, опис і спосіб кодування даних.

У розділі "Вихідні дані" повинні бути зазначені:

–характер і організація вихідних даних,

–формат, опис і спосіб кодування вихідних даних.

14.2.3 Керівництво програміста

Керівництво програміста повинне містити наступні розділи:

–призначення та умови застосування програми;

–характеристики програми;

–звертання до програми;

–вхідні та вихідні дані;

–повідомлення.

Узалежності від особливостей документа допускається поєднувати окремі розділи чи вводити нові.

Урозділі “ Призначення й умови застосування програми” повинні бути зазначені призначення та функції, що виконуються програмою, умови, необхідні для виконання програми (обсяг оперативної пам'яті, вимоги до складу та параметрів периферійних пристроїв, вимоги до ПЗ тощо)

Урозділі “ Характеристика програми” має бути наведений опис основних характеристик і особливостей програми (часові характеристики, режим роботи, засоби контролю правильності виконання та самовідновлення програми тощо).

Урозділі “ Звертання до програми” повинен бути приведений опис процедур виклику програми (способи передачі керування та параметрів даних тощо).

Урозділі “ Початкові та вихідні дані” повинен бути приведений опис організацій початкової та вихідної інформації, що використовується, за необхідності, її кодування.

Урозділі “ Повідомлення” повинні бути зазначені тексти повідомлень, які видаються програмісту чи користувачу в ході виконання програми, опис їхнього змісту та дії за цими повідомленнями.

69

14.2.4 Керівництво користувача

Керівництво користувача повинне містити такі розділи:

–призначення програми;

–умови виконання програми;

–виконання програми;

–повідомлення користувачу.

У залежності від особливостей документа допускається об’єднувати окремі розділи чи вводити нові.

Урозділі “ Призначення програми” повинні бути зазначені відомості про призначення програми та інформація, достатня для розуміння функцій програми та її експлуатації.

Урозділі “ Умови виконання програми” повинні бути вказані умови, необхідні для виконання програми (мінімальний і (чи) максимальний склад апаратних і програмних засобів тощо).

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

Урозділі “ Повідомлення користувачу” повинні бути приведені тексти повідомлень, що видавались у ході виконання програми, опис їхнього змісту та відповідні дії користувача (дії користувача у випадку збою, можливості повторного запуску програми тощо).

Допускається зміст розділів ілюструвати пояснюючими прикладами, таблицями, схемами, графіками.

14.3 Завдання на лабораторну роботу

14.3.1Ознайомитися з теоретичними відомостями, необхідними для виконання роботи.

14.3.2Розробити специфікацію на ПЗ.

14.3.3Розробити опис програми.

14.3.4Розробити керівництво програміста.

14.3.5Розробити керівництво користувача.

14.3.6Оформити звіт з роботи.

14.3.7Відповісти на контрольні питання.

70

14.4 Зміст звіту

14.4.1Тема та мета роботи.

14.4.2Тема, обрана для проектування.

14.4.3Загальна схема роботи системи.

14.4.4Специфікація на ПЗ:

–документація;

–комплекси;

–компоненти.

14.4.5Опис програми:

– загальні відомості;

– функціональне призначення;

– опис логічної структури;

– використані технічні засоби;

– виклик та завантаження;

– вхідні та вихідні дані.

14.4.6Керівництво програміста:

–призначення й умови використання ПЗ;

–характеристика ПЗ;

–звернення до ПЗ;

–вхідні та вихідні дані;

–повідомлення та обробка помилкових ситуацій. 14.4.7 Керівництво користувача:

–анотація;

–вступ;

–опис використання найважливіших функцій системи;

–можливі проблеми та шляхи їх розв’язання;

–глосарій.

14.4.8Висновки, що містять відповіді на контрольні запитання,

атакож відображають результати виконання роботи та їх критичний аналіз.

14.5 Контрольні запитання

14.5.1На якому етапі розроблення ПЗ відбувається оформлення проектної документації?

14.5.2Який документ на програмний продукт містить перелік програмних документів?