14 Commits

Author SHA1 Message Date
hasslesstech 47f3cbc26c Merge pull request 'utils/table-generator: додав автоматичну генерацію суцільного файлу з таблицями' (#32) from shmuliar-use-case into master
Reviewed-on: #32
2024-04-21 18:33:07 +03:00
hasslesstech 21beb456e0 Оновлення гілки 2024-04-21 18:32:24 +03:00
hasslesstech 1ec1bbbfed Merge pull request 'Лаб №2: переніс use-case-таблиці в основний файл' (#31) from shmuliar into master
Reviewed-on: #31
2024-04-21 18:31:38 +03:00
hasslesstech 02394beba0 utils/table-generator: додав суцільний файл з таблицями до .gitignore 2024-04-21 16:34:40 +03:00
hasslesstech b253eb8f0f utils/table-generator: додав автоматичну генерацію суцільного файлу з таблицями 2024-04-21 16:01:34 +03:00
hasslesstech 68500e9451 лаб2: переніс use-case-таблиці в основний файл 2024-04-21 15:55:17 +03:00
hasslesstech 3bdaf3674f Незначні виправлення 2024-04-21 15:37:40 +03:00
hasslesstech 1c31f64954 Merge pull request 'лаб2: заповнив незроблені частини' (#30) from shmuliar-short-desc into master
Reviewed-on: #30
Reviewed-by: IO-23 Andrii Bodnar <bodnarandrew123@gmail.com>
2024-04-21 15:24:54 +03:00
hasslesstech e9ea10d36e Оновлення гілки 2024-04-21 15:24:21 +03:00
hasslesstech fbbaeb9c3f Merge pull request 'лаб2: додав решту характеристик FURPS' (#29) from shmuliar into master
Reviewed-on: #29
Reviewed-by: IO-23 Andrii Bodnar <bodnarandrew123@gmail.com>
2024-04-21 15:22:54 +03:00
hasslesstech a912a73926 лаб2: додав короткий опис продукту та логотип 2024-04-20 12:51:59 +03:00
hasslesstech 5aaf3ce928 Оновлення гілки 2024-04-20 11:42:56 +03:00
hasslesstech c00659062c Merge pull request 'Лаб №2: вступ' (#28) from bodnar into master
Reviewed-on: #28
Reviewed-by: hasslesstech <user1@109.86.70.81>
2024-04-20 11:41:49 +03:00
hasslesstech 1600aa6653 лаб2: додав решту характеристик FURPS 2024-04-20 11:27:28 +03:00
3 changed files with 139 additions and 39 deletions
+2 -1
View File
@@ -103,5 +103,6 @@ dist
# TernJS port file
.tern-port
# Generated tables for use-cases
# utils/table-generator generated files
utils/table-generator/tables/
utils/table-generator/tables.md
+125 -35
View File
@@ -2,16 +2,7 @@
## Вступ
У даному розділі розкриваються ключові терміни та процеси, пов'язані з розробкою високоякісного програмного забезпечення. Ці матеріали надаються для зацікавлених користувачів, які прагнуть отримати глибше розуміння суті проекту та його основних завдань. Представлені такі категорії:
- [Короткий зміст](#короткии-зміст)
- [Характеристика ділових процесів](#характеристика-ділових-процесів)
- [Короткий огляд продукту](#короткии-огляд-продукту)
- [Функціональність](#функціональність)
- [Практичність](#практичність)
- [Надійність](#надіиність)
- [Продуктивність](#продуктивність)
- [Експлуатаційна придатність](#експлуатаціина-придатність)
У даному розділі розкриваються ключові терміни та процеси, пов'язані з розробкою високоякісного програмного забезпечення. Ці матеріали надаються для зацікавлених користувачів, які прагнуть отримати глибше розуміння суті проекту та його основних завдань.
### Мета
@@ -24,7 +15,7 @@
### Основні визначення та скорочення
[Зацікавлені сторони(особи)](https://uk.wikipedia.org/wiki/Зацікавлені_сторони) - фізичні та юридичні особи, які мають легітимний інтерес у діяльності організації, тобто певною мірою залежать від неї або можуть впливати на її діяльність.
[Зацікавлені сторони (особи)](https://uk.wikipedia.org/wiki/Зацікавлені_сторони) - фізичні та юридичні особи, які мають легітимний інтерес у діяльності організації, тобто певною мірою залежать від неї або можуть впливати на її діяльність.
[FURPS](https://en.wikipedia.org/wiki/FURPS) - абревіатура, що репрезентує модель класифікації якостей програмного забезпечення (функціональні і нефункціональні вимоги):
- *Functionality* (Функціональність) - можливості (розмір та загальний набір функцій), повторне використання (сумісність, інтероперабельність, портативність), безпека (безпека та можливість експлуатації);
@@ -65,43 +56,133 @@
## Короткий зміст
*[Розділ містить опис того, про що йдеться в еій частині цього документу, що залишилася.
Також тут описана структура документу.]*
- [Характеристика ділових процесів](#характеристика-ділових-процесів)
- [Короткий огляд продукту](#короткии-огляд-продукту)
- [Функціональність](#функціональність)
- [Практичність](#практичність)
- [Надійність](#надіиність)
- [Продуктивність](#продуктивність)
- [Експлуатаційна придатність](#експлуатаціина-придатність)
## Характеристика ділових процесів
*[В цьому розділі визначаються зовнішні фактори, що впливають на бізнес (бізнес-актори),
та внутрішні фактори (робітники), дається загальна характеристика діяльності бізнес-акторів
та робітників, яка здійснюється за допомогою бізнесу.*
| ID | ACCOUNT.CREATE |
|:-----------------:|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
| Назва | Створити обліковий запис |
| Учасники | Користувач, система |
| Передумови | Відсутні |
| Результат | Обліковий запис користувача |
| Виключні ситуації | 001.001 Користувач ввів заборонені символи в поле псевдоніму<br>001.002 Ідентичний псевдонім вже існує |
| Основний сценарій | 1. Користувач вводить бажаний псевдонім у поле вводу псевдоніму<br>2. Користувач вводить пароль у поле вводу паролю<br>3. Користувач натискає на кнопку створення облікового запису<br>4. Система створює обліковий запис користувача (можливі 001.001, 001.002) |
*Дається опис бізнес-сценаріїв взаємодії бізнес-акторів, робітників і, можливо, інформаційної системи за допомогою наступної
специфікації:*
| ID | ACCOUNT.DELETE |
|:-----------------:|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
| Назва | Видалити обліковий запис |
| Учасники | Користувач, система |
| Передумови | Користувач ідентифікований в системі |
| Результат | Відсутність облікового запису користувача |
| Виключні ситуації | 001.005 Користувач не ідентифікований |
| Основний сценарій | 1. Користувач натискає на кнопку видалення облікового запису<br>2. Система виводить кнопку-запит на підтвердження видалення облікового запису<br>3. Користувач натискає на кнопку підтвердження видалення облікового запису<br>4. Система видаляє обліковий запис (можлива 001.005) |
| ID | ACCOUNT.MODIFY |
|:-----------------:|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
| Назва | Змінити властивості облікового запису |
| Учасники | Користувач, система |
| Передумови | Користувач ідентифікований в системі |
| Результат | Зміна властивостей облікового запису |
| Виключні ситуації | 001.005 Користувач не ідентифікований |
| Основний сценарій | 1. Користувач натискає на кнопку редагування облікового запису<br>2. Система виводить інтерфейс для редагування облікового запису (можлива 001.005)<br>3. Користувач вказує бажані зміни властивостей облікового запису<br>4. Користувач натискає на кнопку внесення змін до властивостей облікового запису<br>5. Система змінює властивості облікового запису |
***ID:***
| ID | USER.CREATE_SURVEY |
|:-----------------:|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
| Назва | Створити опитування |
| Учасники | Користувач, система |
| Передумови | Користувач ідентифікований в системі |
| Результат | Створене опитування |
| Виключні ситуації | 001.005 Користувач не ідентифікований<br>001.007 Користувач ввів неприпустимі символи в назві опитування |
| Основний сценарій | 1. Користувач переходить на сторінку створення опитування (можлива 001.005)<br>2. Система виводить інтерфейс створення опитування<br>3. Користувач задає інформацію про запитання та тип опитування<br>4. Користувач натискає кнопку збереження опитування<br>5. Система створює опитування (можлива 001.007)<br>6. Система виводить посилання на проходження опитування |
***НАЗВА:***
| ID | USER.DELETE_SURVEY |
|:-----------------:|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
| Назва | Видалити опитування |
| Учасники | Користувач, система |
| Передумови | Користувач ідентифікований в системі, користувач є власником опитування |
| Результат | Відсутність опитування |
| Виключні ситуації | 001.005 Користувач не ідентифікований<br>001.006 Запитане опитування не існує<br>001.008 Користувач не є власником опитування |
| Основний сценарій | 1. Користувач натискає на кнопку видалення опитування<br>2. Система виводить запит на підтвердження видалення опитування<br>3. Користувач натискає на кнопку підтвердження видалення опитування<br>4. Система видаляє опитування (можливі 001.005, 001.006, 001.008) |
***УЧАСНИКИ:***
| ID | USER.GET_SURVEY_RESULT |
|:-----------------:|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
| Назва | Переглянути відповіді на опитування |
| Учасники | Користувач, система |
| Передумови | Користувач ідентифікований в системі, користувач є власником опитування |
| Результат | Інформація про відповіді на опитування |
| Виключні ситуації | 001.005 Користувач не ідентифікований<br>001.006 Запитане опитування не існує<br>001.008 Користувач не є власником опитування |
| Основний сценарій | 1. Користувач натискає на кнопку перегляду відповідей на опитування<br>2. Система виводить інформацію про відповіді на опитування (можливі 001.005, 001.006, 001.008) |
***ПЕРЕДУМОВИ:***
| ID | USER.LOGIN |
|:-----------------:|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
| Назва | Пройти ідентифікацію в системі |
| Учасники | Користувач, система |
| Передумови | Користувач має обліковий запис |
| Результат | Користувач ідентифікований в системі |
| Виключні ситуації | 001.001 Користувач ввів заборонені символи в поле псевдоніму<br>001.003 Користувач ввів псевдонім, якого не існує в системі<br>001.004 Користувач ввів неправильний пароль до облікового запису |
| Основний сценарій | 1. Користувач вводить псевдонім у поле вводу псевдоніму<br>2. Користувач вводить пароль у поле вводу паролю<br>3. Користувач натискає кнопку ідентифікації<br>4. Система ідентифікує користувача (можливі 001.001, 001.003, 001.004) |
***РЕЗУЛЬТАТ:***
| ID | USER.LOGOUT |
|:-----------------:|:-------------------------------------------------------------------------------------------------------------------------------------------:|
| Назва | Скинути дані про ідентифікацію в системі |
| Учасники | Користувач, система |
| Передумови | Користувач ідентифікований в системі |
| Результат | Користувач не ідентифікований в системі |
| Виключні ситуації | 001.005 Користувач не ідентифікований |
| Основний сценарій | 1. Користувач натискає на кнопку виходу з облікового запису<br>2. Система скидає інформацію про ідентифікацію користувача (можлива 001.005) |
***ВИКЛЮЧНІ СИТУАЦІЇ:***
| ID | USER.MODIFY_SURVEY |
|:-----------------:|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
| Назва | Редагувати опитування |
| Учасники | Користувач, система |
| Передумови | Користувач ідентифікований в системі, користувач є власником опитування |
| Результат | Змінене опитування |
| Виключні ситуації | 001.005 Користувач не ідентифікований<br>001.006 Запитане опитування не існує<br>001.008 Користувач не є власником опитування |
| Основний сценарій | 1. Користувач переходить на сторінку редагування опитування<br>2. Система виводить інтерфейс редагування опитування (можливі 001.005, 001.006, 001.008)<br>3. Користувач задає інформацію про зміни в опитуванні<br>4. Користувач натискає кнопку збереження змін в опитуванні<br>5. Система змінює опитування |
***ОСНОВНИЙ СЦЕНАРІЙ:***
| ID | USER.STAT_SURVEY |
|:-----------------:|:---------------------------------------------------------------------------------------------------------------------------------------------------------:|
| Назва | Переглянути властивості опитування |
| Учасники | Користувач, система |
| Передумови | Користувач ідентифікований в системі, користувач є власником опитування |
| Результат | Інформація про властивості опитування |
| Виключні ситуації | 001.005 Користувач не ідентифікований<br>001.006 Запитане опитування не існує<br>001.008 Користувач не є власником опитування |
| Основний сценарій | 1. Користувач натискає на кнопку перегляду інформації про опитування<br>2. Система виводить інформацію про опитування (можливі 001.005, 001.006, 001.008) |
*Кількість сценаріїв визначається у відповідності до специфіки завдання та необхідного
рівня деталізації (зазвичай, 5-6 сценаріїв).*
| ID | USER.TAKE_ANON_SURVEY |
|:-----------------:|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
| Назва | Пройти анонімне опитування |
| Учасники | Користувач, система |
| Передумови | Відсутні |
| Результат | Запис відповідей на опитування |
| Виключні ситуації | 001.006 Запитане опитування не існує |
| Основний сценарій | 1. Користувач переходить на сторінку проходження опитування<br>2. Система виводить перелік запитань опитування (можлива 001.006)<br>3. Користувач вводить відповіді на запитання<br>4. Користувач натискає кнопку надсилання відповідей<br>5. Система записує відповіді на опитування (можлива 001.006)<br>6. Система виводить прощальне повідомлення |
| ID | USER.TAKE_NAMED_SURVEY |
|:-----------------:|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
| Назва | Пройти поіменне опитування |
| Учасники | Користувач, система |
| Передумови | Користувач ідентифікований в системі |
| Результат | Запис відповідей на опитування та відомості про користувача |
| Виключні ситуації | 001.005 Користувач не ідентифікований<br>001.006 Запитане опитування не існує |
| Основний сценарій | 1. Користувач переходить на сторінку проходження опитування<br>2. Система виводить перелік запитань опитування (можливі 001.005, 001.006)<br>3. Користувач вводить відповіді на запитання<br>4. Користувач натискає кнопку надсилання відповідей<br>5. Система записує відповіді на опитування та відомості про користувача (можлива 001.006)<br>6. Система виводить прощальне повідомлення |
## Короткий огляд продукту
*[Визначається границя системи та категорії її користувачів. Дається загальна характеристика категорій користувачів
системи]*
*[Нижче йде опис FURPS:]*
<center>
<img width=60% src="http://139.162.162.130:16660/img/logo2-web.svg">
</center>
Xpertise - це система для проведення будь-яких опитувань.
Вона дозволяє користувачам створювати опитування, збирати відповіді на них та переглядати докладну й узагальнену статистику.
У користувачів є можливість створювати не лише анонімні, але й поіменні опитування, тому платформа також задовольнить потреби в проведенні голосувань для прийняття спільних рішень у командах.
## Функціональність
@@ -146,16 +227,25 @@ Cистема розділяє користувачів на дві катего
## Практичність
*[Usability (вимоги до зручності роботи)]*
- Наявність зручного інструменту для побудови опитувань
- Можливість легко замінити брендинг та кольорову палітру
- Перегляд аналітики в реальному часі
- Формування статистики відповідей у зручному інтерфейсі
- Можливість експорту результатів опитування через API
- Підтримка програмування реакцій на події (hooks)
## Надійність
*[Reliability (вимоги до надійності)]*
- Шифрування з'єднань (TLS)
- Автоматичне резервне копіювання
- Автоматичне відновлення з резервних копій
## Продуктивність
*[Performance (вимоги до продуктивності)]*
- Низьке використання мережі базовим протоколом
- Незалежність від сторонніх веб-хостингів
## Експлуатаційна придатність
*[Supportability (вимоги до підтримки)]*
- Наявність докладної документації для користувачів, адміністраторів та розробників
- Доступність онлайн-підтримки
+9
View File
@@ -2,3 +2,12 @@
mkdir -p tables/
./convert.py use-cases/* -nv -d tables/
if [ -f tables.md ]; then
rm tables.md
fi
for i in tables/*; do
cat $i >> tables.md
echo "" >> tables.md
done