Merge remote-tracking branch 'origin/Documentation-General' into Docu…

…mentation-Topic-5

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "asciidoc.antora.enableAntoraSupport": true
+}

docs/src/01_introduction_and_goals.adoc

@@ -2,6 +2,8 @@ ifndef::imagesdir[:imagesdir: ../images]
 
 [[section-introduction-and-goals]]
 == Introduction and Goals
+The Spanish TV and news company RTVE has hired the software company HappySW to develop a web application based on the successful TV program "Saber y Ganar" called WIQ.
+The application will be a trivia style game composed by a series of questions with multiple answers dynamically generated by the use of the WikiData API.
 
 [role="arc42help"]
 ****
@@ -16,6 +18,9 @@ These include
 ****
 
 === Requirements Overview
+The system will follow the functionality of the "Saber y Ganar" TV program, and so it will allow the users to select an answer between some options.
+The questions and answers will be automatically generated using the WikiData API, that will also determine which of the answers is in fact the correct one.
+The system will also store the historical data of the users and will be accessible through the web.
 
 [role="arc42help"]
 ****
@@ -43,6 +48,16 @@ See https://docs.arc42.org/section-1/[Introduction and Goals] in the arc42 docum
 
 === Quality Goals
 
+[options="header",cols="1,2"]
+|===
+|Quality attribute|Scenario
+| Usability | The user must be able to understand the function of the application before the minute mark.
+| Performance | The application will be able to operate within reasonable response times, taking into account the already present waiting times (time to answer, between questions, etc). 
+| Security | The information stored about a user can only be accessed by said user, never others.
+| Robustness | The application will be able to handle any user error that could happen at runtime.
+| Accessibility | The application will be accessible by all users, even if the suffer from visual impediments such as colorblindness. 
+|===
+
 [role="arc42help"]
 ****
 .Contents
@@ -88,6 +103,8 @@ Table with role names, person names, and their expectations with respect to the
 [options="header",cols="1,2,2"]
 |===
 |Role/Name|Contact|Expectations
-| _<Role-1>_ | _<Contact-1>_ | _<Expectation-1>_
-| _<Role-2>_ | _<Contact-2>_ | _<Expectation-2>_
+| Development team | Lucía Ruiz Núñez, Mario Junquera Rojas, Jorge Cano Martinez, Laura Gómez Menéndez, Ahmet Erdem Yabaci, Daniel Sinne Argüelles | A working, tested and well documented application.
+| Professors | Pablo González | Provide guidance and help during the whole development, as well as evaluate the final product.
+| RTVE | RTVE | A working and robust application that the users can enjoy using.
+| Users | Users | A working and enjoyable application to play with.
 |===

docs/src/02_architecture_constraints.adoc

@@ -2,8 +2,24 @@ ifndef::imagesdir[:imagesdir: ../images]
 
 [[section-architecture-constraints]]
 == Architecture Constraints
-
-
+=== Technical constraints
+Wikidata:: The information needed must be got from this central storage.
+GitHub:: All the communication and code-sharing will be done by GitHub, so all the work will be recorded there.
+API:: Give access about users and generated questions through an API.
+
+=== Organizational constraints
+Team size:: The team is formed by 6 people.
+Meetings:: There will be a meeting every week where will be discussions about problems we could have, make an overview about the work done and the work to be done among other things.
+Time:: There will be several deliveries and the entire project must be developed and finished in the semester of the course.
+Budget:: There will not be any financial support.
+
+=== Political constraints
+Data protection:: The private information of the users must be stored securely.
+
+=== Conventions
+English:: As this course is taught in English, the project must be also developed in that language.
+ARC42:: The documentation must follow the arc42 template
+
 [role="arc42help"]
 ****
 .Contents

docs/src/03_system_scope_and_context.adoc

@@ -47,14 +47,29 @@ Alternatively (or additionally) you can use a table.
 The title of the table is the name of your system, the three columns contain the name of the communication partner, the inputs, and the outputs.
 
 ****
+image::3-BusinessContext.drawio.svg["Business context diagram"]
 
-**<Diagram or Table>**
 
-**<optionally: Explanation of external domain interfaces>**
+**Table for entities, inputs and outputs**
+
+|===  
+|Entity |Inputs | Outputs
+
+|*_User Interface UI_*
+|Users request a question to be shown 
+|The question and the set of answers corresponding to that question are presented
+|*_Question Generation_*
+|User requests a question and the information extracted from wikidata
+|The question and the set of answers corresponding to that question are created
+|*_Wikidata API_*
+|Some part or topic related to the creation of a question
+|Some concepts that will facilitate the creation of the question such as wrong answers
+|===
 
 === Technical Context
 
 [role="arc42help"]
+
 ****
 .Contents
 Technical interfaces (channels and transmission media) linking your system to its environment. In addition a mapping of domain specific input/output to the channels, i.e. an explanation which I/O uses which channel.
@@ -67,9 +82,17 @@ E.g. UML deployment diagram describing channels to neighboring systems,
 together with a mapping table showing the relationships between channels and input/output.
 
 ****
+image::3-TechnicalContext.drawio.svg["Business context diagram"]
+.User And Application interface +
+The user will access the web application via the HTTPs protocol
+
+.Home and Login interface +
+The home will allow user to be redirected to the login and authentication phase via the HTTPs protocol
+
+.Login and Question Generation interface +
+The login will allow the user to enter the game and so the question generation will start, this will happend through a redirect
 
-**<Diagram or Table>**
+.Login and Database +
+The login will access the database directly via TCP/IP protocol
 
-**<optionally: Explanation of technical interfaces>**
 
-**<Mapping Input/Output to Channels>**