Merge pull request #65 from Arquisoft/docs-11-12

Docs 11 12
Arquisoft · Feb 21, 2024 · b416269 · b416269
2 parents fbacacf + efdf020
commit b416269
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 10 deletions.
diff --git a/docs/src/08_concepts.adoc b/docs/src/08_concepts.adoc
@@ -9,9 +9,6 @@ The following concepts provide a foundation for the design and implementation of
 
 The domain model for our game includes entities such as `Question`, `Category`, `Player`, and `GameSession`. These are crucial for representing the game's data and logic. The model serves as the basis for interactions within the application and between the application and the database.
 
-.Explanation:
-The `Question` entity encapsulates details of the trivia questions. `Category` classifies these questions into various topics. `Player` represents users and their interactions with the game, while `GameSession` maintains the state of play, including scores and progress.
-
 === Hexagonal Architecture
 
 Our application is structured using hexagonal architecture principles, which prioritize the separation of core logic from peripheral concerns like user interface and external API interactions.

diff --git a/docs/src/11_technical_risks.adoc b/docs/src/11_technical_risks.adoc
@@ -27,13 +27,19 @@ See https://docs.arc42.org/section-11/[Risks and Technical Debt] in the arc42 do
 
 [cols="1,2,3a", options="header"]
 |===
-| Priority | Risk/Debt | Description
+| Priority | Risk | Description
 
 | High | Migration to Java | Migration from the current project language, JavaScript (JS), to Java
 | Medium | IDE Configuration | Version compatibility, extensions and other preferences to work perfectly without conflicts
 | Medium | Database | Discuss which database is best for the project 
 | Low | Docker  | Know how docker works, what it is for, how it is used and what its alternatives could be.
-| Low | Microservices | Research about microservices and what they can contribute to the project
 
 
 |===
+
+[cols="1,2,3a", options="header"]
+|===
+| Priority | Debt | Description
+| Low | Microservices | Research about microservices and what they can contribute to the project
+
+|==
diff --git a/docs/src/12_glossary.adoc b/docs/src/12_glossary.adoc
@@ -36,12 +36,11 @@ See https://docs.arc42.org/section-12/[Glossary] in the arc42 documentation.
 
 |WikiData |A collaborative platform that provides structured data for Wikimedia projects, including Wikipedia.
 
-|IDE (Integrated Development Environment) |A software application that provides comprehensive facilities to programmers for software development.
+|Question | Entity that encapsulates details of the trivia questions.
 
-|Docker |An open-source platform designed to automate the deployment of applications inside lightweight, portable containers.
+|Category | Classifies questions into various topics, each question can only belong to one category.
 
-|Microservices |An architectural style that structures an application as a collection of small, independent services.
-
-|API (Application Programming Interface) |A set of protocols and tools for building software applications, allowing them to communicate with each other.
+|Player | Represents users and their interactions with the game
 
+|GameSession | Maintains the state of play, including scores and progress.
 |===