Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Some updates to the docu #303

Merged
merged 2 commits into from
Apr 28, 2024
Merged

Some updates to the docu #303

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
64d0b5a
Requirements revisited
UO283615 Apr 27, 2024
af47f01
Updated the glossary
UO283615 Apr 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions docs/src/12_glossary.adoc
View file
Open in desktop
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's a missing blank before the definition of Question Generator module

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
View file
Open in desktop
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.