Skip to content

Commit

Permalink
Merge pull request #30 from Arquisoft/documentacion2
Browse files Browse the repository at this point in the history
Ampliación de las restricciones del proyeto en la documentación
  • Loading branch information
uo285032 authored Feb 16, 2025
2 parents 91ab9be + 9ae25f2 commit 8d22589
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions docs/src/02_architecture_constraints.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ endif::arc42help[]
|===
| Constraints | Explanations
| _Fixed data source_ | Questions, images, and hints must be generated exclusively from Wikidata data.
| _External language model_ | A LLM accessed through a predefined API will be used, limiting the choice of models and customization options.
| _External language model_ | A LLM accessed through a predefined API will be used, limiting the choice of models, customization options, and potential for fine-tuning or adaptation to specific needs.
|===

=== Technical Constraints
Expand All @@ -44,8 +44,8 @@ endif::arc42help[]
| Constraints | Explanations
| _Mandatory web platform_ | The application must be accessible via web browsers and deployed online.
| _Conversational hints logic_ | Hints must be generated while mitigating hallucinations using specific techniques, integrated with Wikidata.
| _Automatic generation_ | Both the questions and distractors must be generated automatically, restricting manual design.
| _Time-limited answers_ | Each question must be answered within a set time, necessitating efficient interaction and time management design.
| _Docker for containerization_ | Docker must be used for application containerization, as the solution's architecture requires that all components be packaged into containers to ensure portability, isolation, and compatibility across environments
| _GitHub Actions for CI/CD_ | GitHub Actions must be used for automating the CI/CD pipeline, ensuring seamless integration, testing, and deployment processes.
|===

=== Legal and Regulatory Constraints
Expand All @@ -65,6 +65,8 @@ endif::arc42help[]
| _Fixed question format_ | Each question must have one correct answer and several incorrect ones generated automatically, with balanced and coherent options.
| _User registration_ | The system must include functionalities for registration, participation history, and statistics.
| _Mandatory interaction_ | Users must interact with the system to obtain conversational hints about the questions.
| _Time-limited answers_ | Each question must be answered within a set time, necessitating efficient interaction and time management design.
| _Automatic generation_ | Both the questions and distractors must be generated automatically, restricting manual design to ensure consistency and scalability.
|===

=== Operational Constraints
Expand All @@ -73,5 +75,6 @@ endif::arc42help[]
|===
| Constraints | Explanations
| _Scalability_ | The system must support multiple simultaneous users.
| _Monitoring and deployment_ | Observability and deployment automation are required.
| _Monitoring and deployment_ | Observability and deployment automation are required. The deployment must maintain high availability, meaning the infrastructure must be capable of handling potential failures with minimal service disruption, ensuring maximum uptime. Due to this, an online virtual machine provider must be selected for deployment.
| _Docker for deployment_ | Docker is also used in the deployment process to ensure efficient management of production, testing, and development environments. This facilitates scalability and maintenance by allowing more precise control over dependencies and configurations.
|===

0 comments on commit 8d22589

Please sign in to comment.