Подякувати Студентському архіву довільною сумою
Admin
26.02.2023 12:38
Дякуємо, що користуєтесь нашим архівом!
Розробка документації на програмне забезпечення
Інформація про навчальний заклад
ВУЗ:
Національний університет Львівська політехніка
Інститут:
Не вказано
Факультет:
КН
Кафедра:
Кафедра автоматизованих систем управління
Інформація про роботу
Рік:
2011
Тип роботи:
Лабораторна робота
Предмет:
Розробка програмного продукту
Частина тексту файла (без зображень, графіків і формул):
Міністерство освіти України
Національний університет «Львівська політехніка»
Кафедра автоматизованих систем управління
/
Звіт
до лабораторної роботи №6
на тему:
Розробка документації на програмне забезпечення
Лабораторна робота №6
Тема: Розробка документації на програмне забезпечення
Мета: Ознайомитись з етапом виготовлення документації на програмний продукт.
Теоретичні відомості:
Документування - це важлива частина розробки програмного забезпечення, але часто їй приділяють недостатньо уваги.
Документація на програмне забезпечення - це документи, що супроводжують деяке програмне забезпечення (ПЗ) - програму чи програмний продукт. Ці документи описують те, як працює програма або те, як її використовувати.
Документація проекту
Протягом роботи над проектом створюють велику кількість документів, наприклад: документація виробничого процесу ПЗ, керівництво, яке описує завершений проект. Документація проекту містить:
Плани, оцінки, графіки роботи - документи, розроблені менеджерами.
Схвалені документи - це інструкції для виробників.
Звіти - документи, підготовлені супервізорами. Ці документи описують роботу і її результати.
Стандарти - документи, що описують необхідні стандарти.
Робочі документи - різноманітні документи з ідеями рішень. Автори можуть бути членами команди. Якщо їх схвалять, ці документи можуть стати стандартами.
Повідомлення - примітки, коментарі, які використовуються для комунікації між членами команди.
Стандарти документації повинні стосуватися всіх аспектів проекту. Підготовка документації ділиться на стадії: попередня документація, редагування, друк, компонування копій, внесення змін у документи. Форма і зміст повинні бути ретельно підібрані відповідальними особами. Обкладинка, зміст, структура тіла документа, індекс, словник і т.п. повинні бути встановлені згідно стандарту. Потрібно визначити механізм доступу до документації, тобто слід створити бібліотеку для документів. З удосконаленням програми буде удосконалюватися і документація. Проте старі версії документів все одно залишаться. Прикладом таких документів є:
інформація про всі версії,
інформація про клієнтів і версії, які вони придбали,
ПЗ і апаратні вимоги до версії,
інформація про компоненти (класи, об'єкти, модулі), потрібні для версії,
інформація про можливі зміни версії,
інформація про виявлені помилки.
Документація повинна супроводжуватися відповідною інфраструктурою, в межах якої ця документація створюється. Під інфраструктурою ми розуміємо межі, формат і управління документацією. Загублені документи, записи, коментарі і додаткові зауваження можуть стати загрозою для проекту. Крім того, управління інфраструктурою під час проекту є дуже витратним у фінансовому і часовому плані. Тому відповідна інфраструктура повинна бути схвалена на початку проекту.
До уваги повинні бути взяті наступні пункти:
унікальна ідентифікаційна структура із заголовком, автором і номером документа;
номери послідовності і опис повинні містити:
тип документа,
номер документа,
номер версії,
дата версії,
стан;
призначення відповідальності по виробництву документа, його схваленню, редагуванню і реєстрації;
процедури введення змін; призначення відповідальних;
гарантія якості документа і особа, відповідальна за процес.
Додаткові елементи можуть бути введені в інфраструктуру, наприклад, рівень конфіденційності документів.
Виконання роботи:
Користувацька документація
Зміст
Інсталяція системи.
А. Інсталяція серверної частини.
Б. Інсталяція клієнтської частини.
В. Налаштування клієнтської частини.
Інструкція для користувачів:
А. Режим адміністратора.
Б. Режим директора.
В. Режим оператора-консультанта.
Г. Режим інтернет-клієнта.
1. Інсталяція системи.
1А. Інсталяція серверної частини.
Так як наша система «LeoTyr» працює за принципом клієнт-сервер, то сервер – це має бути окремий комп’ютер з виходом в Інтернет. Для того щоб сервер нормально функціонував потрібно виконати такі дії:
Встановити MS SQL Server;
Зупинити SQL Server використавши додаток Configuration Manager;
Скопіювати всі файли бази даних з каталогу DataBase (знаходиться у корінному каталогу «LeoTur») у каталог C:\Program Files\Microsoft SQL Server\MSSQL.1\MSSQL\Data;
Запустити SQL Server використавши додаток Configuration Manager.
Після виконання вище наведених дій SQL-сервер автоматично розпочне обслуговувати базу даних системи.
1Б. Інсталяція клієнтської частини.
Процес інсталяції для всіх класів користувачів є однаковим. Клієнтська програма встановлюється на окремий комп’ютер з виходом в Інтернет. Програма «LeoTyr» не потребує особливої інсталяції на комп’ютер. Для роботи з нею достатньо скопіювати каталог «LeoTyr» на довільний фізичний диск комп’тера. Вміст даного каталогу зображений на Рис. 1.
/
Рис. 1.
Він включає с себе 3 підкаталоги: DataBase (база даних), Logo (каталог з текстурами програми), System (системний каталог де міститься сама система)
Щоб активізувати програму необхідно зайти у каталог «LeoTyr» і відкрити exe-файл McPay.exe (Рис. 2).
/
Рис. 2.
1В. Налаштування клієнтської частини.
Клієнтска частина не потребує ніяких додаткових налаштувань вона автоматично ініціалізується та з’єднується із сервером.
2. Інструкція для користувачів.
Головне вікно програми (Рис. 3) призначене для ознайомлення користувача з програмою та його реєстрації та авторизації. Вікно складається з:
Меню «перегляд екскурсій».
Кнопка для виведення інформації про ціну активної екскурсії.
Кнопка для виведення опису активної екскурсії.
Кнопка для виведення маршруту активної екскурсії.
Кнопка для реєстрації.
Кнопка для входу в систему зареєстрованих користувачів.
Поля для введення логіну та паролю.
Збільшення карти.
Вихід з системи.
Примітка: для роботи з інструкцією користувач повинен переглядати рис.3
Інструкція:
Для реєстрації потрібно зробити наступне:
Натиснути кнопку «5» після чого з’являється таблиця яку необхідно заповнити даними про себе і натиснути кнопку «ок»
Для входу в систему потрібно зробити наступне:
У поля «7» ввести логін та пароль після чого натиснути кнопку «6»
Перегляд інформації про екскурсії:
Що б перегляднути інформацію про екскурсії користувачу потрібно вибрати закладку з назвою яка їх цікавить «1» Після чого у полі «2» відорбразиться ціна екскурсії, у полі «3» її опис, а у формі «4» - зображення з її маршрутом.
Щоб збільшити зображення потрібно натиснути на кнопку збільшити «8».
Для виходу з системи користувач має натиснути кнопку «11» після чого утвориться вікно про згоду на вихід з системи
/
Рис. 3
Опис:
Пункт меню «1» виводить в елементи «2» «3» «4» інформацію про Екскурсію(короткий опис екскурсії, які які доступні або скоро такими будуть)
Натиснувши пункт меню «1» у полі «2» відображається ціна екскурсії, у полі «2» відображається її опис а у зображенні «4» - зображення з її маршрутом.
При натиснені на кнопку «5» в новому вікні вводяться особисті дані для реєстрації інтернет користувачів.
При натисканні на кнопку «6» користувач входить в систему попередньо ввівши логін і пароль в поля «7».
При натиснені на кнопку «9» завершується робота системи.
2А. Режим адміністратора.
Режим адміністратора являє собою окреме вікно і включає в себе:
Індикатори Протоколів системи;
Профіль користувача;
Індикатори стану системи;
Закладка зі списоком користувачів;
Закладка зі списком персоналу
Закладка з меню редагування інтерфейсу.
Панель управління БД
Вихід з системи (повернення до попереднього вікна).
Примітка: для роботи з інструкцією користувач повинен переглядати рис.4
Інструкція:
Для редагування БД необхідно виконати наступне:
Активувати курсором закладку «4» або «5» залежно від потрібної БД після чого з’явиться таблиця з необхідними даними.
Для редагування БД оберіть потрібну закладку та за допомогою панелі «7» виз можете відредагувати БД.
Для перегляду стану системи подивіться на форму «3»
Для перегляду протоколів:
Подивіться на підформу «1» - зелений колір – вкл., червоний – викл.;
Для редагування інтерфейсу користувача необхідно виконати наступне:
Активувати закладку «6» і в меню нижче обрати один з 4 варіантів редагування інтерфейсу(по типам клієнту);
Вихід або перелогін:
Для виходу з системи або релогіну треба натиснути кнопку «8»
/
Рис.4
Опис:
У підформі «1» відображається стан протоколів HTTP; UDP; TCP\IP за допомогою лампочок;
У підформі «3» відображається стан системи (увімкнена чи вимкнена) та скільки працює сервер від моменту останнього ввімкнення;
У підформі «2» відображається профіль користувача;
Натиснувши закладку «4» користувач зможе редагувати БД користувачів;
Натиснувши закладку «5» користувач зможе редагувати БД персоналу;
Натиснувши закладку «6» користувач зможе редагувати інтерфейси програми.
2Б. Режим оператора-консультанта.
Режим оператора включає в себе окреме вікно в якому можна: переглядати список клієнтів, переглядати доступні екскурсії, там обслуговувати клієнтів у режимі онлайн.
Зараз детальніше розглянемо функції меню оператора(Рис.5):
Закладка «Екскурсії»(аналогічна як на головній сторінці).
Кнопка для перегляду списку клієнтів.
Закладка для відкриття Терміналу тех.-підтримки;
Профіль користувача;
Відображення даних про заявку;
Навігація між заяками.
Відправлення листа клієнту.
Дзвінок у режимі онлайн до користувача.
Вихід з системи (повернення до попереднього вікна).
Примітка: для роботи з інструкцією користувач повинен переглядати рис.5
Інструкція:
Закладна «1» надає перегляд екскурсій аналогічний тому що в головному меню;
Закладка Список клієнтів «2» Виводить таблицю з анкетними даними клієнтів;
Закладка термінал тех.-підтримки«3» Містить у собі функції для контакту з клієнтами;
Для перегляду заявок та відповіді на них використовуйте кнопки «6» «7» а для зв'язку з клієнтом у режимі онлайн натисніть кнопку «8»;
Для виходу або перелогіну треба натиснути кнопку «9»;
/
Рис.5
Опис:
Пункт меню «1» відповідає за перегляд меню екскурсій;
Пункт меню «2» відповідає за перегляд списку клієнтів;
Пункт меню «3» відповідає за редагування інтерфейсу;
У підформі «4» відображається профіль користувача;
При натиснені на кнопки «6» ви зможете переглядати почергово заявки котрі зберігаються на сервері;
При натисненні кнопки «7» появляється вікно відправки повідомлення на емейл клієнта;
При натисненні кнопки «8» ви увійдете в розмову з клієнтом напряму.
Касир може перелогінитись або вийти з системи натиснушви кнопку «9»
2В. Режим директора.
Режим директора містить наступні пункти меню (Рис.6)
Розглянем детальніше дане меню та його функціонал:
Закладка зі списоком користувачів;
Закладка зі списком персоналу
Закладка «Екскурсії»(аналогічна як на головній сторінці). Але вона має деяку відмінність – збоку у нас є доступним редактор екскурсій.
Профіль користувача;
– 11. Опції редактора екскурсій;
12.Вихід з системи (повернення до попереднього вікна).
Примітка: для роботи з інструкцією користувач повинен переглядати рис.6
Інструкція:
Створення аккаунта нового працівника:
При виборі пункта меню «2» з’являється таблиця яку директор повинен заповнити інформацією про нового працівника, після того натиснувши кнопку зареєструвати яка також з’явиться при виборі даного пункта меню.
Перегляд інформації про працюючий персонал:
Навести та натиснути курсор на «2» і у полі з’явиться таблиця з базою даних працюючого персоналу і інф про працівників.
Перегляд списку користувачів:
Навести курсор та натиснути на «1» і у полі виводиться таблиця з даними про усіх зареєстрованих клієнтів фірми.
Для того щоб користуватись редактором екскурсій потрібно активувати закладку екскурсії «3» та користуючись кнопками «4»- «11» можна створювати видаляти, редагувати доступні екскурсії;
Для виходу або перелогіну треба натиснути кнопку «12»
/
Рис.6
Опис:
Натиснувши закладку «1» користувач зможе редагувати БД користувачів;
Натиснувши закладку «2» користувач зможе редагувати БД персоналу;
Пункт меню «3» відповідає за перегляд меню екскурсій;
У підформі «4» відображається профіль користувача;
При виборі пункта меню «3» користувач може окрім перегляду також створювати та змінювати маршрути опис, ціни, вводити нові та видаляти старі екскурсії, одразу їх тестувати і зберігати зміни за допомогою кнопок 5-11;
Директор може вийти з системи або перелогінитись натиснувши кнопку «12»
2Г. Режим інтернет-клієнт.
Режим інтернет користувача складається з деяких елементів головного меню програми плюс додаткові функції для зареєстрованих користувачів (Рис.7 і Рис.8):
Закладка «Екскурсії»(аналогічна як на головній сторінці).
Заклада «Зв’язок з оператором»
Заклада «ваші замовлення» для замовлення та оплати;
Поле в якому відображається введений вами запит для перевірки перед відправкою;
Профіль користувача;
Поле для введення запиту;
Кнопка для відправлення запиту до оператора-консультанта;
Вихід з системи (повернення до попереднього вікна).
1. Список доступник екскурсій;
2. Випадний список вибору к-сті необхідних білетів;
3. Кнопка оплати замовлення;
4. Кнопка редагування замовлення;
5. Кнопкавідміни замовлення;
Примітка: для роботи з інструкцією користувач повинен переглядати рис.7 і рис.8
Інструкція:
Закладна «1» надає перегляд екскурсій аналогічний тому що в головному меню;
Закладка «2» містить у собі функції для контакту з оператором(див. рис. 8) Користувач може вибрати в таблиці «1» необхідну екскурсію та за допомогою випадного спику «2» вибрати кількість білетів які він хоче замовити. Вкінці для підтвердження потрібно натиснути кнопку «3» щоб оплатити замовлення. Кнопка «4» дозволяє змінити замовлення, кнопка «5» дозволяє його відмінити.
Повернемось до рис.7:
Щоб переглянути свій профіль ви можете подивитись на підформу 5;
Для створення запиту до оператора:
Введіть запит в поле «6» та натисніть кнопку «7», і вас автоматично переведе в режим очікування вільного оператора для зв’язку з вами;
Для виходу або перелогіну треба натиснути кнопку «8»
/
Рис.7
/
Рис.8
Опис:
Пункт меню «1» відповідає за перегляд меню екскурсій;
Пункт меню «2» відповідає зв’язок з оператором;
Пункт меню «3» за меню замовлення екскурсії;
У підформі «5» відображається профіль користувача;
При натисненні кнопки «7» відбувається відправка запиту;
При натисненні кнопок «1» - «5» з меню замовлень ви можете самостійно зробити замовлення та оплатити його%
Користувач може перелогінитись або вийти з системи натиснушви кнопку «8»
Висновок:
На цій лабораторній роботі я освоїв основні методики створення документації. На цьому етапі, я склав документ який дозволяє детально ознайомитись з програмою, принципом її дії та всіма перевагами системи «LeoTyr».
08.02.2013 17:02-
Ділись своїми роботами та отримуй миттєві бонуси!
0%
Оголошення від адміністратора