diff --git a/docs/src/03_system_scope_and_context.adoc b/docs/src/03_system_scope_and_context.adoc index 818439d..3f24776 100644 --- a/docs/src/03_system_scope_and_context.adoc +++ b/docs/src/03_system_scope_and_context.adoc @@ -51,14 +51,12 @@ The title of the table is the name of your system, the three columns contain the [plantuml,"Context Diagram",png] ---- actor Player -actor Client [Wikidata] <> [WIQ Game] <> [UsersAPI] <> [GeneratedQuestionsAPI] <> Player ..> (WIQ Game) : register/login -Client ..> (WIQ Game) : view data [GeneratedQuestionsAPI] ..> Wikidata [WIQ Game] ..> UsersAPI [WIQ Game] ..> GeneratedQuestionsAPI @@ -71,21 +69,18 @@ Client ..> (WIQ Game) : view data |Player |Plays the game and can consult past scores -|Client -|Can access the data about players and generated questions - |WIQ Game |Main system in which generated questions are shown and can be answered by players |Wikidata -|External data repository from which questions are generated using the WikidataAPI +|External data repository from which questions are generated |MongoDB -|Database for storing generated questions, players' info and scores +|Database for storing players' info and scores |Users Info API -|Allows clients to see the info about players stored in the database +|Manages data of users, both registration/login data and their past scores |Generated Questions API -|Allows clients to see the info about generated questions stored in the database +|Manages generation of questions from Wikidata |=== \ No newline at end of file diff --git a/docs/src/05_building_block_view.adoc b/docs/src/05_building_block_view.adoc index 048b720..006ba7a 100644 --- a/docs/src/05_building_block_view.adoc +++ b/docs/src/05_building_block_view.adoc @@ -66,21 +66,16 @@ In the best case you will get away with examples or simple signatures. [plantuml,"Whitebox overall system",png] ---- actor Player -actor Client [Wikidata] rectangle "WIQ Game (Level 1)"{ [WIQ Game GUI] -[Data View] [UsersAPI] [GeneratedQuestionsAPI] #BurlyWood Player ..> (WIQ Game GUI) -Client ..> (Data View) [GeneratedQuestionsAPI] ..> Wikidata [WIQ Game GUI] ..> UsersAPI [WIQ Game GUI] ..> GeneratedQuestionsAPI -[Data View] ..> UsersAPI -[Data View] ..> GeneratedQuestionsAPI } ---- @@ -97,11 +92,8 @@ Contained Black boxes:: |WIQ Game GUI |Main window in which questions are shown and can be answered by the player. The latter can also see past scores. -|Data View -|Access to data about users and generated questions for the client. - |Generated Questions API -|In charge of generating the questions and storing their data +|In charge of generating the questions |UsersAPI |In charge of keeping track of the data of the users (registration and scores) @@ -168,18 +160,15 @@ Leave out normal, simple, boring or standardized parts of your system [plantuml,"Generated Questions API (WhiteBox)",png] ---- [Wikidata] -[wikidatanpm] <> +[wikibase-sdk] <> [WIQ Game GUI] -[Data View] database MongoDB rectangle "GenedQuestsAPI (Level 2)"{ - -[GenQuestsService] ..> wikidatanpm +[GenQuestsService] ..> wikibase-sdk [GenQuestsService] ..> Wikidata [GenQuestsService] <--> MongoDB [WIQ Game GUI] ..> GenQuestsService : new Question -[Data View] ..> GenQuestsService : get Questions } ---- @@ -194,23 +183,12 @@ Contained Black boxes:: |Name |Responsibility |GenQuestsService -|Receives different petitions regarding the generation of questions or their retrieval and responds accordingly. +|Receives different petitions regarding the generation of questions and responds accordingly. -|wikidatanpm +|wikibase-sdk |External library that facilitates and simplifies the use of wikidata for the generation of questions. |MongoDB -|The data of the generated questions is stored here for showing it later to the client. - -|=== - -Additional explanation of relationships:: - -The service is requested either the generation of a question or the retrieval of a subset (from WIQ Game GUI or -Data View respectively). - -For the first case, it makes use of the library to generate the question, retrieves it -for the interface to use and stores the pertinent data in the DB. +|Data about users and their scores is stored here -In the other case, it just makes the query according to the client choosings and retrieves the data of the -questions for the Data View to show. \ No newline at end of file +|=== \ No newline at end of file