Skip to content

Commit

Permalink
Merge pull request f-ogoog#5 from f-ogoog/tsuria-oleh
Browse files Browse the repository at this point in the history
Update config.js
  • Loading branch information
f-ogoog authored Apr 26, 2024
2 parents 418bc42 + 9fd816f commit a471354
Showing 1 changed file with 152 additions and 113 deletions.
265 changes: 152 additions & 113 deletions docs/use cases/README.md
Original file line number Diff line number Diff line change
@@ -1,149 +1,188 @@
# Модель прецедентів

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

<center style="
border-radius:4px;
border: 1px solid #cfd7e6;
box-shadow: 0 1px 3px 0 rgba(89,105,129,.05), 0 1px 1px 0 rgba(0,0,0,.025);
padding: 1em;"
>
@startuml

skinparam noteFontColor white

actor "Користувач" as User

*Модель прецедентів повинна містити загальні оглядові діаграми та специфікації прецедентів.*

usecase "<b>UserSignUp</b>\nЗареєструватися" as UserSignUp
usecase "<b>UserSignIn</b>\nУвійти в систему" as UserSignIn
usecase "<b>UserUpdate</b>\nРедагувати дані користувача" as UserUpdate
usecase "<b>Support</b>\nЗв'язок з службою підтримки" as Support


Вбудовування зображень діаграм здійснюється з використанням сервісу [plantuml.com](https://plantuml.com/).
User -r-> UserSignUp
User -u-> UserSignIn
User -u-> UserUpdate
User -u-> Support

В markdown-файлі використовується опис діаграми

```md
actor "Менеджер" as Manager

usecase "<b>ProjectManage</b>\nКерувати проектом" as ProjectManage
usecase "<b>TaskManage</b>\nКерувати задачами" as TaskManage
usecase "<b>TeamManage</b>\nКерувати командою" as TeamManage
usecase "<b>TemplateManage</b>\nКерувати шаблонами" as TemplateManage


Manager -> ProjectManage
Manager -d-> TaskManage
Manager -l-> TeamManage
Manager -l-> TemplateManage
Manager -u-|> User

@enduml

</center>

## Користувач

<center style="
border-radius:4px;
border: 1px solid #cfd7e6;
box-shadow: 0 1px 3px 0 rgba(89,105,129,.05), 0 1px 1px 0 rgba(0,0,0,.025);
padding: 1em;"
border-radius:4px;
border: 1px solid #cfd7e6;
box-shadow: 0 1px 3px 0 rgba(89,105,129,.05), 0 1px 1px 0 rgba(0,0,0,.025);
padding: 1em;"
>

@startuml

right header
<font size=24 color=black>Package: <b>UCD_3.0
end header
skinparam noteFontColor white

title
<font size=18 color=black>UC_8. Редагувати конфігурацію порталу
<font size=16 color=black>Діаграма прецедентів
end title
actor "Користувач" as User

usecase "<b>UserSignUp</b>\nЗареєструватися" as UserSignUp
usecase "<b>UserSignIn</b>\nУвійти в систему" as UserSignIn
usecase "<b>UserUpdate</b>\nРедагувати дані користувача" as UserUpdate
usecase "<b>UserDelete</b>\nВидалити користувача" as UserDelete
usecase "<b>Support</b>\nЗв'язок з службою підтримки" as Support

User -l-> UserSignUp
User -r-> UserSignIn
User --d-> UserUpdate
User --d-> UserDelete
User -u-> Support

actor "Користувач" as User #eeeeaa

package UCD_1{
usecase "<b>UC_1</b>\nПереглянути список \nзвітів" as UC_1 #aaeeaa
}

usecase "<b>UC_1.1</b>\nЗастосувати фільтр" as UC_1.1
usecase "<b>UC_1.2</b>\nПереглянути метадані \nзвіту" as UC_1.2
usecase "<b>UC_1.2.1</b>\nДати оцінку звіту" as UC_1.2.1
usecase "<b>UC_1.2.2</b>\nПереглянути інформацію \nпро авторів звіту" as UC_1.2.2

package UCD_1 {
usecase "<b>UC_4</b>\nВикликати звіт" as UC_4 #aaeeaa
}

usecase "<b>UC_1.1.1</b>\n Використати \nпошукові теги" as UC_1.1.1
usecase "<b>UC_1.1.2</b>\n Використати \nрядок пошуку" as UC_1.1.2
usecase "<b>UC_1.1.3</b>\n Використати \nавторів" as UC_1.1.3



User -> UC_1
UC_1.1 .u.> UC_1 :extends
UC_1.2 .u.> UC_1 :extends
UC_4 .d.> UC_1.2 :extends
UC_1.2 .> UC_1.2 :extends
UC_1.2.1 .u.> UC_1.2 :extends
UC_1.2.2 .u.> UC_1.2 :extends
UC_1 ..> UC_1.2.2 :extends


UC_1.1.1 -u-|> UC_1.1
UC_1.1.2 -u-|> UC_1.1
UC_1.1.3 -u-|> UC_1.1

right footer
Аналітичний портал. Модель прецедентів.
НТУУ КПІ ім.І.Сікорського
Киів-2020
end footer

@enduml

**Діаграма прецедентів**

</center>
```

яка буде відображена наступним чином

## Менеджер

<center style="
border-radius:4px;
border: 1px solid #cfd7e6;
box-shadow: 0 1px 3px 0 rgba(89,105,129,.05), 0 1px 1px 0 rgba(0,0,0,.025);
padding: 1em;"
border-radius:4px;
border: 1px solid #cfd7e6;
box-shadow: 0 1px 3px 0 rgba(89,105,129,.05), 0 1px 1px 0 rgba(0,0,0,.025);
padding: 1em;"
>

@startuml

right header
<font size=24 color=black>Package: <b>UCD_3.0
end header
skinparam noteFontColor white

actor "Менеджер" as Manager

usecase "<b>UserSignUp</b>\nРеєстрація" as UserSignUp
usecase "<b>UserSignIn</b>\nЛогін" as UserSignIn
usecase "<b>UserUpdate</b>\nРедагувати дані користувача" as UserUpdate
usecase "<b>UserDelete</b>\nВидалити користувача" as UserDelete
usecase "<b>Support</b>\nЗвернутись до служби підтримки" as Support
usecase "<b>ProjectManage</b>\nКерувати проєктами" as ProjectManage
usecase "<b>ProjectCreate</b>\nСтворити проєкт" as ProjectCreate
usecase "<b>ProjectUpdate</b>\nРедагувати проєкт" as ProjectUpdate
usecase "<b>ProjectDelete</b>\nВидалити проєкту" as ProjectDelete
usecase "<b>TeamManage</b>\nКерувати командою" as TeamManage
usecase "<b>UserAdd</b>\nДодати користувача до команди" as UserAdd
usecase "<b>DeleteUser</b>\nВидалення користувача з проєкту" as DeleteUser
usecase "<b>TaskManage</b>\nКерувати задачами" as TaskManage
usecase "<b>TaskAdd</b>\nДодавання задачі в проєкт" as TaskAdd
usecase "<b>TaskUpdate</b>\nРедагування задачі в проєкті" as TaskUpdate
usecase "<b>TaskDelete</b>\nВидалення задачі з проєкту" as TaskDelete
usecase "<b>TemplateManage</b>\nКерувати шаблонами" as TemplateManage
usecase "<b>TemplateAdd</b>\nСтворення шаблону проєкту" as TemplateAdd
usecase "<b>TemplateUpdate</b>\nРедагування шаблону проєкту" as TemplateUpdate
usecase "<b>TemplateApply</b>\nЗастосування шаблону до проєкту" as TemplateApply
usecase "<b>TemplateDelete</b>\nВидалення шаблону" as TemplateDelete

Manager -l-> UserSignUp
Manager -r-> UserSignIn
Manager --d-> UserUpdate
Manager --d-> UserDelete
Manager --d-> Support
Manager -r-> ProjectManage
Manager -d-> TeamManage
Manager -l-> TaskManage
Manager -u-> TemplateManage
ProjectManage <.u. ProjectCreate:extends
ProjectManage <.u. ProjectUpdate:extends
ProjectManage <.u. ProjectDelete:extends
TeamManage <.u. UserAdd:extends
TeamManage <.u. DeleteUser:extends
TaskManage <.u. TaskAdd:extends
TaskManage <.u. TaskUpdate:extends
TaskManage <.u. TaskDelete:extends
TemplateManage <.u. TemplateAdd:extends
TemplateManage <.u. TemplateUpdate:extends
TemplateManage <.u. TemplateApply:extends
TemplateManage <.u. TemplateDelete:extends

title
<font size=18 color=black>UC_8. Редагувати конфігурацію порталу
<font size=16 color=black>Діаграма прецедентів
end title
@enduml


actor "Користувач" as User #eeeeaa

package UCD_1{
usecase "<b>UC_1</b>\nПереглянути список \nзвітів" as UC_1 #aaeeaa
}

usecase "<b>UC_1.1</b>\nЗастосувати фільтр" as UC_1.1
usecase "<b>UC_1.2</b>\nПереглянути метадані \nзвіту" as UC_1.2
usecase "<b>UC_1.2.1</b>\nДати оцінку звіту" as UC_1.2.1
usecase "<b>UC_1.2.2</b>\nПереглянути інформацію \nпро авторів звіту" as UC_1.2.2

package UCD_1 {
usecase "<b>UC_4</b>\nВикликати звіт" as UC_4 #aaeeaa
}

usecase "<b>UC_1.1.1</b>\n Використати \nпошукові теги" as UC_1.1.1
usecase "<b>UC_1.1.2</b>\n Використати \nрядок пошуку" as UC_1.1.2
usecase "<b>UC_1.1.3</b>\n Використати \nавторів" as UC_1.1.3



User -> UC_1
UC_1.1 .u.> UC_1 :extends
UC_1.2 .u.> UC_1 :extends
UC_4 .d.> UC_1.2 :extends
UC_1.2 .> UC_1.2 :extends
UC_1.2.1 .u.> UC_1.2 :extends
UC_1.2.2 .u.> UC_1.2 :extends
UC_1 ..> UC_1.2.2 :extends


UC_1.1.1 -u-|> UC_1.1
UC_1.1.2 -u-|> UC_1.1
UC_1.1.3 -u-|> UC_1.1

right footer
Аналітичний портал. Модель прецедентів.
НТУУ КПІ ім.І.Сікорського
Киів-2020
end footer
</center>

@enduml

**Діаграма прецедентів**
## Сценарії використання

</center>


| ID | <span id=UserSignIn>`UserUpdate`</span> |
| :----------------- |:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Назва: | Редагування існуючого облікового запису |
| Учасники: | Менеджер/користувач, система |
| Передумови: | Менеджер/користувач автентифікований у системі |
| Результат: | Дані облікового запису менеджера/користувача змінені |
| Виключні ситуації: | Введені менеджером/користувачем дані не коректні <font color="red">UserUpdateException_InvalidData</font><br> менеджер/користувач не авторизований <font color="red">UserUpdateException_Unauthorized</font><br> |

@startuml

|Користувач|
start;
: Натискає кнопку "Редагувати обліковий запис";

|Система|
: Відкриває вікно редагування облікового запису;

|Користувач|
: Змінює дані та натискає кнопку "Зберегти";

|Система|
: Перевіряє введені дані;
note right #ffaaaa
<b> Можливі помилки:
<b> UserUpdateException_InvalidData
<b> UserUpdateException_Unauthorized
end note

: Система зберігає зміни в обліковому записі;

|Користувач|
: Отримує оновленні дані;
stop;

@enduml

0 comments on commit a471354

Please sign in to comment.