Skip to content

Commit

Permalink
Merge pull request #303 from Arquisoft/docs/revisited
Browse files Browse the repository at this point in the history
Some updates to the docu
  • Loading branch information
gony02 authored Apr 28, 2024
2 parents 208e3f7 + af47f01 commit 76384b3
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 5 deletions.
5 changes: 3 additions & 2 deletions docs/src/12_glossary.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ ifndef::imagesdir[:imagesdir: ../images]
[cols="e,2e" options="header"]
|===
|Term |Definition
|Question Generator
|A module of the application responsible for querying Wikidata, creating the questions and storing them in our DB.
|Distractor | Incorrect answer shown to the user alongside the correct one in each question
|KiWiq | The name of our project
|Question Generator |A module of the application responsible for querying Wikidata, creating the questions and storing them in our DB
|===
13 changes: 10 additions & 3 deletions docs/src/13_annex.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,6 @@ ifndef::imagesdir[:imagesdir: ../images]
** FR-DMU 1.1. Registered users shall be able to access the number of games they have played.
** FR-DMU 1.2. Registered users shall be able to access the number of questions they have answered correctly.
** FR-DMU 1.3. Registered users shall be able to access the number of questions they have answered incorrectly.
** FR-DMU 1.4. Registered users shall be able to access the time they have spent within the system.
** FR-DMU 1.5. Registered users shall be able to access the ranking of the game.

==== Play to WIQ.
Expand All @@ -66,7 +65,7 @@ ifndef::imagesdir[:imagesdir: ../images]
[none or no-bullet]
**** FR-PWIQ 3.1.1.1. When the answer is correct:
[none or no-bullet]
***** FR-PWIQ 3.1.1.1.1. The registered user shall earn 10 points.
***** FR-PWIQ 3.1.1.1.1. The registered user shall be notified.
***** FR-PWIQ 3.1.1.1.2. When the registered user is in the ninth round, the system shall end the game.
***** FR-PWIQ 3.1.1.1.3. When the registered user is not in the ninth round, the system shall move to the next round.
**** FR-PWIQ 3.1.1.2. When the answer is incorrect:
Expand All @@ -76,4 +75,12 @@ ifndef::imagesdir[:imagesdir: ../images]
** FR-PWIQ 3.2. When the specified time has ended:
[none or no-bullet]
*** FR-PWIQ 3.2.1. When the registered user is in the ninth round, the system shall end the game.
*** FR-PWIQ 3.2.2. When the registered user is not in the ninth round, the system shall move to the next round.
*** FR-PWIQ 3.2.2. When the registered user is not in the ninth round, the system shall move to the next round.
[none or no-bullet]
* FR-PWIQ 4. The system shall allow the user to create custom games.
[none or no-bullet]
** FR-PWIQ 4.1. The user may select.
[none or no-bullet]
*** FR-PWIQ 4.1.1 The number of rounds.
*** FR-PWIQ 4.1.2 The time per round.
*** FR-PWIQ 4.1.3 The categories of the questions.

0 comments on commit 76384b3

Please sign in to comment.