From d57de3c63027223bbb934991962d347dc81e517c Mon Sep 17 00:00:00 2001 From: uo264915 Date: Sun, 25 Feb 2024 01:26:07 +0100 Subject: [PATCH] cambios visualizacion de la documentacion --- .../images/{DOCsection5-1.png => DOCsection5_1.png} | Bin .../images/{DOCsection5-2.png => DOCsection5_2.png} | Bin .../images/{DOCsection5-3.png => DOCsection5_3.png} | Bin .../images/{DOCsection8-1.png => DOCsection8_1.png} | Bin docs/src/05_building_block_view.adoc | 6 +++--- docs/src/08_concepts.adoc | 4 ++-- docs/src/10_quality_requirements.adoc | 7 +++---- 7 files changed, 8 insertions(+), 9 deletions(-) rename docs/images/{DOCsection5-1.png => DOCsection5_1.png} (100%) rename docs/images/{DOCsection5-2.png => DOCsection5_2.png} (100%) rename docs/images/{DOCsection5-3.png => DOCsection5_3.png} (100%) rename docs/images/{DOCsection8-1.png => DOCsection8_1.png} (100%) diff --git a/docs/images/DOCsection5-1.png b/docs/images/DOCsection5_1.png similarity index 100% rename from docs/images/DOCsection5-1.png rename to docs/images/DOCsection5_1.png diff --git a/docs/images/DOCsection5-2.png b/docs/images/DOCsection5_2.png similarity index 100% rename from docs/images/DOCsection5-2.png rename to docs/images/DOCsection5_2.png diff --git a/docs/images/DOCsection5-3.png b/docs/images/DOCsection5_3.png similarity index 100% rename from docs/images/DOCsection5-3.png rename to docs/images/DOCsection5_3.png diff --git a/docs/images/DOCsection8-1.png b/docs/images/DOCsection8_1.png similarity index 100% rename from docs/images/DOCsection8-1.png rename to docs/images/DOCsection8_1.png diff --git a/docs/src/05_building_block_view.adoc b/docs/src/05_building_block_view.adoc index 94b08d63..efbacecd 100644 --- a/docs/src/05_building_block_view.adoc +++ b/docs/src/05_building_block_view.adoc @@ -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. @@ -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. @@ -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. diff --git a/docs/src/08_concepts.adoc b/docs/src/08_concepts.adoc index 591e2424..f23c94bb 100644 --- a/docs/src/08_concepts.adoc +++ b/docs/src/08_concepts.adoc @@ -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. diff --git a/docs/src/10_quality_requirements.adoc b/docs/src/10_quality_requirements.adoc index 984ec7cf..f8149dd3 100644 --- a/docs/src/10_quality_requirements.adoc +++ b/docs/src/10_quality_requirements.adoc @@ -5,8 +5,7 @@ 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 @@ -14,8 +13,8 @@ image::10_1_Quality_Tree.png[Business Context Diagram] |=== | 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_*