Merge pull request #18 from Arquisoft/documentation_abel

Documentation abel

docs/src/01_introduction_and_goals.adoc

@@ -41,6 +41,17 @@ See https://docs.arc42.org/section-1/[Introduction and Goals] in the arc42 docum
 
 ****
 
+The WIQ web application allows users to play a game similar to the one of Saber y Ganar quiz show. This game consists on answering a number of questions with different types and subjects obtaining  a prize for each question well answered. Game´s questions are automatically generated from data available in Wikidata (https://www.wikidata.org/).
+
+* The system will have at least a web front-end which will be available and accessible through the web.
+* Users will be able to register to the system and obtain the historical data from their participation: number of games, questions passed and failed, times, etc ..
+* Questions will be automatically generated from data available in Wikidata.
+* Questions have to be answered before some specific time.
+* Each question will have one right answer and several incorrect ones or distractors. Both the right answer and the distractors should be automatically generated.
+* The system will give access to the information about the users through an API.
+* The system will give access to information about the generated questions through an API.
+
+
 === Quality Goals
 
 [role="arc42help"]
@@ -62,6 +73,17 @@ If you as an architect do not know how the quality of your work will be judged..
 .Form
 A table with quality goals and concrete scenarios, ordered by priorities
 ****
+.Quality goals ordered by priority (from most to least important)
+[options="header",cols="1,3"]
+|===
+|Quality Goal|Description
+| _Satisfaction_ | _Users will not get repeated questions in at least a hundred questions._
+| _Modularity_ | _The application will be divided in modules so that a change on one component has minimal impact on other components._
+| _Testability_ | _The application should be able to go through different test and complete them successfully._
+| _Learnability_ | _Any user must be able to use the app with ease. The interface must remind the user to the one in  Saber y Ganar quiz show._
+| _Time behaviour_ | _Users will not have to wait more than 500ms to get a new question._
+|===
+
 
 === Stakeholders
 
@@ -88,6 +110,10 @@ 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>_
+| _Professors_ | _ASW module professors_ | _Get a great project which can be evaluated and shown in their github._
+| _Developers_ | _wiq_es6c team_ | _Carrying out a full real project using all the knowledge obtained in the degree._
+| _Responsible company_ | _HappySw_ | _Development of an experimental version of the Saber y Ganar quiz show._
+| _Client_ | _RTVE_ | _Getting a Web App to promote its famous Saber y Ganar quiz show by letting their viewers enjoy a similar experience._
+| _Main beneficiaries_ | _Public users_ | _Having a great time playing an interesting and easy to use quiz game._
+| _Side beneficiaries_ | _Wikidata_ | _Obtain free promotion of their application and its ease to use in multiple projects._
 |===

docs/src/06_runtime_view.adoc

@@ -63,3 +63,16 @@ Alice <-- Bob: another authentication Response
 === ...
 
 === <Runtime Scenario n>
+
+=== Wikidata questions requests
+
+[plantuml,"Sequence diagram WikidataApi",png]
+----
+actor User
+entity App
+entity WikidataApi
+User -> App: Starts a game
+App -> WikidataApi: Request data
+App <-- WikidataApi: Returns data
+User <-- App: Displays data in question-answer format
+----