Documentation updated

Up to point 5 (included)
Arquisoft · Apr 13, 2024 · 81b1b1d · 81b1b1d
1 parent 2ede579
commit 81b1b1d
Show file tree

Hide file tree

Showing 7 changed files with 25 additions and 16 deletions.
diff --git a/docs/images/05_level1.drawio.png b/docs/images/05_level1.drawio.png
diff --git a/docs/images/05_level2.drawio.png b/docs/images/05_level2.drawio.png
diff --git a/docs/images/05_level3.drawio.png b/docs/images/05_level3.drawio.png
diff --git a/docs/src/01_introduction_and_goals.adoc b/docs/src/01_introduction_and_goals.adoc
@@ -23,14 +23,16 @@ image::01_jordi_hurtado_happy.jpg[Jordi Hurtado, 1600, 900, align="center"]
 
 === Requirements Overview
 
-Users will be able to interact with our system in a lot of different ways.
+The main goal of this project is to develop a web application that will allow users to play a Q&A game with multiple categories.
+The application must have the following functionalities:
 
-* A fun Q&A game
-* A user registration system
-* An API to obtain user information respecting the privacy terms accorded
-* An API to obtain generated questions using real time updated and truthful information from the WikiData Programming Interface.
+* A front-end web that allows users to register and play the game.
+* A user registration system with a history of their games.
+* All of the questions data must be obtained from the WikiData knowledge database.
+* The application must have an API to obtain users information.
+* The application must have an API to obtain generated questions.
 
-More information can be obtained following this https://docs.google.com/document/d/1pahOfYFY--Wi7_9bbxiKOGevB_9tOSyRm78blncgBKg[link], where the course project is fully described and detailed.
+Further information can be found link:https://docs.google.com/document/d/1pahOfYFY--Wi7_9bbxiKOGevB_9tOSyRm78blncgBKg/[here].
 
 === Quality Goals
 

diff --git a/docs/src/02_architecture_constraints.adoc b/docs/src/02_architecture_constraints.adoc
@@ -41,15 +41,19 @@ collaborate effectively, maintain a clean codebase and assign tasks
 |*_Time_*
 | Deadline at the end of the semester,
 the time is divided among two hours per week of in-class work, multiple meetings with team members, and individual self-work.
-Additionally, we will have three deliverables throughout the course, with weekly feedback from the instructor.
+We'll also have four deliverables spaced two weeks apart, where we'll receive feedback from the instructor.
 
 |*_Testing_*
-| Various scenarios will be explored to assess the application's functionality accurately. Diverse testing techniques
-will be employed to achieve comprehensive coverage, aiming for the highest possible quality assurance.
+| Various scenarios will be explored to accurately assess the application's functionality.
+Diverse testing techniques will be employed to achieve comprehensive coverage, aiming for
+the highest possible quality assurance. We also work with different levels of testing,
+including unit, integration, load, and system testing. Additionally, a shift-left testing
+approach will be used, where testing is performed as early as possible in the development
+process, enabling the early detection of bugs and errors.
 
 |*_Tech proficiency_*
 |All team members are beginners in the majority of the technologies we're using, and this is our first endeavor
-in developing a real-world application.
+in developing a real-world application. As a result, all of us should contribute to the project as fullstack developers.
 
 |===
 
@@ -61,13 +65,15 @@ in developing a real-world application.
 |*_Clean Code_*
 |The code composing the application must prioritize clarity and cleanliness, facilitating comprehension and ease of
 maintenance in the long term. We adhere to camelCase for JavaScript and PascalCase for React, ensuring clear and
-descriptive names while steering clear of confusing prefixes.
+descriptive names while steering clear of confusing prefixes. We need to adhere to the conventions of the
+programming languages we're using, including https://jsdoc.app/[JavaScript] , https://html.spec.whatwg.org/[HTML]
+and https://www.w3.org/Style/CSS/[CSS].
 
 |*_Arc42_*
 |The project utilizes https://arc42.org/[Arc42] for documentation purposes.
 
 |*_Usability_*
-|We need to adhere to the conventions of the programming languages we're using, including https://jsdoc.app/[JavaScript]
-, https://html.spec.whatwg.org/[HTML] and https://www.w3.org/Style/CSS/[CSS].
+|The application must be user-friendly, with a clean and intuitive interface that is easy to navigate.
+The user experience should be seamless and engaging, with a focus on accessibility and adaptability.
 
 |===
diff --git a/docs/src/04_solution_strategy.adoc b/docs/src/04_solution_strategy.adoc
@@ -11,9 +11,10 @@ we have decided to use the following technologies, as they were the one given to
 * *_JavaScript_*: Main programming language. It is used in both back and front end.
 * *_React_*: JavaScript library used in the design of graphical user interfaces.
 * *_ExpressJS_*: Framework built on the top of _Node.js_ and used in the backend.
+* *_MongoDB_*: Used as the database for the app.
 * *_Github_*: Used for versioning the proyect and as a mean of communication for the dev team.
-* *_Docker_*: Used for local deployment.
-* *_Github actions_*: Used for testing purposes
+* *_Docker_*: Used for the app deployment.
+* *_Github actions_*: Used for testing purposes, app deployment and as a CI/CD tool.
 
 === Top-level Decomposition
 

diff --git a/docs/src/05_building_block_view.adoc b/docs/src/05_building_block_view.adoc
@@ -89,7 +89,7 @@ This third level provides a deeper insight into the questions microservice. As t
 |Model
 |Component that interacts with the database and retrieves the data to be processed by the service.
 
-|DB
+|NoSQL Database
 |Component independent for each service that contains the data related to it.
 
 |===