Skip to content

Commit

Permalink
Modification in documentation, fixing errors
Browse files Browse the repository at this point in the history
  • Loading branch information
uo289029 committed Feb 22, 2024
1 parent 5ab11cd commit 5ad9dc7
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions docs/src/02_architecture_constraints.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ ifndef::imagesdir[:imagesdir: ../images]
|Web app | The application we are developing is a web game called WIQ consisting of automatically generated questions and answers. Users, once logged in, must answer within a certain time to win prizes.
Additionally, users will also have access to the history of their games.
|Documentation | PlantUML and ASCIIDoc will be used along with the Arc42 template to keep the documentation updated throughout the development of the web app.
|API | To generate the questions and answers for the game, we will use tha API of Wikidata as it is a great source of information to provide
|SPARQL | To generate the questions and answers for the game, we will use SPARQL in Wikidata as it is a great source of information to provide
different types of questions to the users, making the game versatile and non-repetitive.
|Question generator | Using the Wikidata API, questions will be automatically generated along with the correct and three incorrect answers. This questions will be
answered by the user and saved in their history. By using this generator, we ensure that the likelihood of getting the same question in another game is almost none.
Expand All @@ -24,7 +24,7 @@ for testing before releasing, we will use Docker
|Organizational Constraint |Reason
|Github | Github will be used to keep the web app in a repository with Git version control. Projects will also be used to track who and when someome takes up
a task and completes it. Issues will be opened for every task involving the web app.
|Class reunions | We will use the time during classes to discuss new tasks that need to be done, as well as to address any common problems we might face in order to solve them as soon as possible.
|Class meetings | We will use the time during classes to discuss new tasks that need to be done, as well as to address any common problems we might face in order to solve them as soon as possible.
Other forms of communication, like a Whatsapp group, can be used to communicate between developers.
|===

2 changes: 1 addition & 1 deletion docs/src/05_building_block_view.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ image::buildingBlock3.png["More detailed microservices diagram"]

==== White Box Question Generator

The Question Generator is the microservice that interacts with the Wikidata external service through their API.
The Question Generator is the microservice that interacts with the Wikidata external service through SPARQL.
It is the microservice dedicated to generate the questions and the answers and pass them to the interface to show them to the user.

==== White Box Users service
Expand Down

0 comments on commit 5ad9dc7

Please sign in to comment.