From 7189ea2d8afdc98fee6924cfbe275f9c3d35b0ce Mon Sep 17 00:00:00 2001 From: Fernando Date: Sun, 23 Feb 2025 18:12:15 +0100 Subject: [PATCH] Issue#32-write-documentation-for-the-annex --- docs/index.adoc | 4 ++- docs/src/13_annex.adoc | 69 ++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 72 insertions(+), 1 deletion(-) create mode 100644 docs/src/13_annex.adoc diff --git a/docs/index.adoc b/docs/index.adoc index d4e4ab31..b075fb17 100644 --- a/docs/index.adoc +++ b/docs/index.adoc @@ -97,4 +97,6 @@ include::src/11_technical_risks.adoc[] // 12. Glossary include::src/12_glossary.adoc[] - +<<<< +// 13. Annex +include::src/13_annex.adoc[] diff --git a/docs/src/13_annex.adoc b/docs/src/13_annex.adoc new file mode 100644 index 00000000..e05d6604 --- /dev/null +++ b/docs/src/13_annex.adoc @@ -0,0 +1,69 @@ +ifndef::imagesdir[:imagesdir: ../images] + +[[section-annex]] +== Annex +=== Functional Requirements +==== Users Register. +[none or no-bullet] +* UR 1. The system must allow an unregistered user to register in the application. +* UR 2. The system must request data to register: +[none or no-bullet] +*** UR 2.1.1. Username. +*** UR 2.1.2. Email address. +*** UR 2.1.3. Password. +* UR 3. The system shouldn't allow the user to be registered when any value entered by the new user is invalid. +* UR 4. The system must check for existing users with the data obtained. +[none or no-bullet] +** UR 4.1. The system shouldn't allow the user to create a new account if the email matches with an existing user. +** UR 4.2. The system should allow the user to create a new account if the email does not match with an existing user. +* UR 5. The system must recognice the user as registered. + +==== Users Log. +[none or no-bullet] +* UL 1. The system must allow an unidentified user to log in. +[none or no-bullet] +** UL 1.1. The system must request the email address as the user identifier. +[none or no-bullet] +*** UL 1.1.1. The system must check that its format is valid. +*** UL 1.1.2. The system must check the box is filled. +** UL 1.2. The system must request the user's password. +[none or no-bullet] +*** UL 1.2.1. The system must check the box is filled. +** UL 1.3. The system must automatically validate the entered data to verify when it corresponds to a registered user account. +[none or no-bullet] +*** UL 1.3.1. When the user is not stored in the system, an error message must be displayed. +*** UL 1.3.2. When the user exists in the system, but the password does not match, a message must be displayed to the user notifying them of the error. +*** UL 1.3.3. When the user is stored in the system and the password matches, the user must be logged in. +* UL 2. The system must allow users who are logged in to log out. + +==== Users Data. +[none or no-bullet] +* UD 1. The system must allow all identified users to access their historical data. +[none or no-bullet] +** UD 1.1. Identified users must be able to access the number of: +[none or no-bullet] +*** UD 1.1.1. Games they have played. +*** UD 1.1.2. Questions they have answered correctly. +*** UD 1.1.3. Questions they have answered incorrectly. +** UD 1.2. Identified users must be able to access the ranking of the game. + +==== Playing WIChat. +[none or no-bullet] +* PWIC 1. The system must only allow identified users to play WIChat. +* PWIC 2. The system must retrieve indormation for the questions from Wikidata. +* PWIC 3. The system must provide the user with a LLM API to help answering the questions. +[none or no-bullet] +** PWIC 3.1 The LLM must provide the user with hints about the questions. +* PWIC 4. The game consists of nine rounds by default. +[none or no-bullet] +** PWIC 4.1. the system must automatically provide a question to the identified user. +** PWIC 4.3. The system must automatically provide one correct answer. +** PWIC 4.2. The system must automatically provide three distractors. +* PWIC 5. The system must allow the user to answer the questions if there is time remaining. +[none or no-bullet] +** PWIC 5.1. The system must check when the identified user has provided an answer in the time given: +[none or no-bullet] +*** PWIC 5.1.1. If the answer is correct. +*** PWIC 5.1.2. If the answer is incorrect. +** PWIC 5.2. The system must move to the next round when the specified time has ended. +* PWIC 6. The system must terminate the game and give a score when the last round is over. \ No newline at end of file