Merge pull request #12 from Arquisoft/sergio-doc

Introduction and goals Documentation
Arquisoft · Feb 11, 2025 · 0c0d903 · 0c0d903
2 parents 5e2ae5b + 21aa719
commit 0c0d903
Showing 1 changed file with 34 additions and 3 deletions.
diff --git a/docs/src/01_introduction_and_goals.adoc b/docs/src/01_introduction_and_goals.adoc
@@ -17,8 +17,24 @@ These include
 ****
 endif::arc42help[]
 
+=== Introduction
+
+We are a team of seven Software engineering *students* working for ChattySw, a company that has been hired by RTVE aiming to extend their online version of the "Saber y Ganar" quiz show.
+
 === Requirements Overview
 
+The system is designed to provide an interactive quiz experience based on *Saber y Ganar*. The key requirements include:
+
+- **Web-Based Interface**: The application will be accessible through a web frontend, displaying questions, answers, and a hint system.  
+- **User Accounts & Progress Tracking**: Users will be able to register and view their participation history, including game statistics.  
+- **Automated Question Generation**: Questions and answers will be taken from WikiData.  
+- **AI-Powered Hints**: An LLM-based hint system will assist users without revealing direct answers, mitigating incorrect information.  
+- **Time-Limited Responses**: Players must answer within a given time frame.  
+- **API Access**: The system will expose APIs to retrieve user data and question details.
+
+For a detailed breakdown of requirements, please refer to the following document: 📄 link:https://docs.google.com/document/d/1_4KBTx6hVuR90cUW4LoDHEH0E3NZJ3DInacCZjAuGXY/edit?pli=1&tab=t.0#heading=h.knuq2aw7zapd[Project Requirements Document].
+
+
 ifdef::arc42help[]
 [role="arc42help"]
 ****
@@ -47,6 +63,18 @@ endif::arc42help[]
 
 === Quality Goals
 
+The following quality attributes are prioritized in the architecture:
+
+[options="header",cols="1,2"]
+|===
+| Quality Goal | Description 
+| **Usability** | The interface should be user-friendly, ensuring smooth interaction with questions and the AI assistant.  
+| **Scalability** | The system should efficiently handle multiple concurrent users.  
+| **Reliability** | The application must function without errors, correctly retrieving and displaying questions.  
+| **Maintainability** | The codebase should follow best practices, allowing future extensions and improvements.  
+| **Security** | User data and interactions must be securely managed, preventing unauthorized access.  
+|===
+
 ifdef::arc42help[]
 [role="arc42help"]
 ****
@@ -95,7 +123,10 @@ endif::arc42help[]
 
 [options="header",cols="1,2,2"]
 |===
-|Role/Name|Contact|Expectations
-| _<Role-1>_ | _<Contact-1>_ | _<Expectation-1>_
-| _<Role-2>_ | _<Contact-2>_ | _<Expectation-2>_
+|Role/Name | Contact | Expectations
+| **RTVE** | Client | To have a modernized and functional quiz system with AI-based hints to engage users.
+| **End Users (Players)** | Public Users | Want an enjoyable, responsive, and fair game experience with accurate hints and reliable performance.
+| **Development Team (ChattySw)** | Internal Team | Responsible for implementing the system following the defined requirements and quality standards.
+| **WikiData** | API Provider | Provides the database of questions and images, ensuring relevant and accurate information for the game.
+| **External AI Provider (LLM Service)** | API Provider | Provides the AI-based hint system, which must be reliable and minimize incorrect responses.
 |===