Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CAmbios visualizacion de la documentacion #43

Merged
merged 2 commits into from
Feb 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
6 changes: 3 additions & 3 deletions docs/src/05_building_block_view.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ ifndef::imagesdir[:imagesdir: ../images]

=== Whitebox Overall System

image::DOCsection5-1.png[Level 1]
image:DOCsection5_1.png["Level 1"]

.Motivation
WIQ is the general structure of the system, where the users are going to register in the database, play answering the questions generated with Wikidata or view their previous games among other functionalities.
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.png["Level 2"]

.Motivation
Shows how is the system internally in general terms.
Expand All @@ -57,7 +57,7 @@ Shows how is the system internally in general terms.

=== Level 3

image::DOCsection5-3.png[Level 3]
image:DOCsection5_3.png["Level 3"]

.Motivation
Detailed structure of the system. Focused on the components of the Webapp, Users API and Questions API.
Expand Down
4 changes: 2 additions & 2 deletions docs/src/08_concepts.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ ifndef::imagesdir[:imagesdir: ../images]

=== Domain model

image::DOCsection8-1.png[Domain model]
image:DOCsection8-1.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.

We are going to look for a good performance with the code optimization, wihout overloading the system and memory and doing some performance test.
We are going to look for a good performance with the code optimization, without overloading the system and memory and doing some performance test.

=== Usability
Usability is a fundamental aspect of any application, as it determines the ease and efficiency with which users can interact with it. To ensure the usability of our application, we have followed a series of specific practices and techniques.
Expand Down
7 changes: 3 additions & 4 deletions docs/src/10_quality_requirements.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,16 @@ ifndef::imagesdir[:imagesdir: ../images]

=== Quality Tree

:imagesdir: ../images
image::10_1_Quality_Tree.png[Business Context Diagram]
image:10_1_Quality_Tree.png[Business Context Diagram]

=== Quality Scenarios

[options="header",cols="1,3,3"]
|===
| Quality Requirements | Scenarios | Priority

| *_Privacity_*
| We will respect the privacy of the users, the user's data will be protected at all times. We will ensure the highest possible security, storing the user's sensitive information securely and trying to prevent any kind of attack or risk.
| *_Performance_*
| We'll run some performance testing and search for a good code optimization performance without taxing the system's resources or memory. Optimize the setups, algorithms, and system parts as well.
| High

| *_Usability_*
Expand Down
Loading