Skip to content

Commit

Permalink
Merge pull request #131 from Arquisoft/pablo
Browse files Browse the repository at this point in the history
[DOC] Actualizar diagrama apartado 8 de la documentación Arquisoft/wi…
  • Loading branch information
uo264915 authored Apr 14, 2024
2 parents eb4f9ab + cb9e6a1 commit 25d7b0e
Show file tree
Hide file tree
Showing 8 changed files with 41 additions and 30 deletions.
Binary file added docs/images/DOCsection5_2.drawio.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/images/DOCsection5_2.png
Binary file not shown.
Binary file added docs/images/DOCsection5_3.drawio.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/images/DOCsection5_3.png
Binary file not shown.
Binary file added docs/images/DOCsection8_1.drawio.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/images/DOCsection8_1.png
Binary file not shown.
69 changes: 40 additions & 29 deletions docs/src/05_building_block_view.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ WIQ is the general structure of the system, where the users are going to registe
|===
| Name | Description

| *_Actor_*
| *_User_*
| Client/User of the application which will interact with it.

| *_WIQ application_*
Expand All @@ -31,7 +31,7 @@ WIQ is the general structure of the system, where the users are going to registe

=== Level 2

image::DOCsection5_2.png["Level 2"]
image::DOCsection5_2.drawio.png["Level 2"]

.Motivation
Shows how is the system internally in general terms.
Expand All @@ -42,22 +42,27 @@ Shows how is the system internally in general terms.
|===
| Name | Description

| *_User_*
| Client/User of the application which will interact with it.

| *_Webapp_*
| It contains the user interface (frontend) and the development branch (backend).

| *_Users API_*
| API to manage all the functionalities related to users.
| *_Microservices_*
| Part that takes care of the functionalities.

| *_Questions API_*
| API to manage all the functionalities related to questions/answers.
| *_WIQ_*
| Main component that manages all the system.

| *_MongoDB_*
| Database where user data is recorded and stored.
|===
| *_Wikidata_*
| Website where to get information for questions.

| *_Database_*
| Component that manages the authentification of users.

=== Level 3

image::DOCsection5_3.png["Level 3"]
image::DOCsection5_3.drawio.png["Level 3"]

.Motivation
Detailed structure of the system. Focused on the components of the Webapp, Users API and Questions API.
Expand All @@ -68,6 +73,9 @@ Detailed structure of the system. Focused on the components of the Webapp, Users
|===
| Name | Description

| *_User_*
| Client/User of the application which will interact with it.

| *_Games History_*
| Component to store games played by each user and where user can watch their previous games.

Expand All @@ -77,33 +85,36 @@ Detailed structure of the system. Focused on the components of the Webapp, Users
| *_Questions History_*
| Component to store previous questions and where user can watch them.

| *_Home_*
| Initial screen of the application.
| *_Main Page_*
| Component that shows the main functionalities of the system.

| *_Register Users_*
| Component to see what users are registered on the system.

| *_Login_*
| Component to access the system by the user.

| *_Menu_*
| Component to navigate through the system.

| *_Help_*
| Offers help to the user.
| *_Users Service_*
| Component that manages the creation of new users.

| *_About_*
| Adds info about the development of the project.
| *_Questions Service_*
| Component that manages the creation of the questions.

| *_AddUser_*
| Component to create a new user.

| *_Login_*
| Component to access the system by the user.
| *_Historial Service_*
| Component that manages the history of users.

| *_Profile_*
| Component to store and manage the user data.
| *_Authentification Service_*
| Component that manages the authentification of users.

| *_Game_*
| Component to create a new game.
| *_WIQ_*
| Main component that manages all the system.

| *_NewQuestion_*
| Component to create new questions for the games.
| *_Wikidata_*
| Website where to get information for questions.

| *_UsedQuestions_*
| Component to store and manage the used questions.
| *_Database_*
| Component that manages the authentification of users.
|===
2 changes: 1 addition & 1 deletion docs/src/08_concepts.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ ifndef::imagesdir[:imagesdir: ../images]

=== Domain model

image::DOCsection8_1.png["Domain model"]
image::DOCsection8_1.drawio.png["Domain model"]

=== Performance
A system that performs well provides a positive user experience. Users expect applications and services to respond promptly to their requests. A higher performance leads to increased user satisfaction and engagement. Also, a good performance help to get a better efficiency.
Expand Down

0 comments on commit 25d7b0e

Please sign in to comment.