diff --git a/docs/images/5-Level1.svg b/docs/images/5-Level1.svg index c5658b44..58e7fca5 100644 --- a/docs/images/5-Level1.svg +++ b/docs/images/5-Level1.svg @@ -1,4 +1,4 @@ -
WIQ










Wikidata
User
HOME
USER MANAGMENT
USER DB
QUESTION GAME
QUESTIONS DB
\ No newline at end of file +
WIQ










Wikidata
User
HOME
USER MANAGEMENT
USER DB
QUESTION GAME
QUESTIONS DB
\ No newline at end of file diff --git a/docs/images/5-Level2.svg b/docs/images/5-Level2.svg index d76e105a..b13fc127 100644 --- a/docs/images/5-Level2.svg +++ b/docs/images/5-Level2.svg @@ -1,4 +1,4 @@ -
WIQ














HOME










User
WELCOME PAGE
USER MANAGMENT










AUTHSERVICE
USERSERVICE
GAMEMODE PAGE
QUESTION GAME










GAME CONFIGURATION
QUESTION RESTAPI
QUESTION GENERATOR
Wikidata
GAME
\ No newline at end of file +
WIQ














HOME










User
WELCOME PAGE
USER MANAGEMENT










AUTHSERVICE
USERSERVICE
GAMEMODE PAGE
QUESTION GAME










GAME CONFIGURATION
QUESTION RESTAPI
QUESTION GENERATOR
Wikidata
GAME
\ 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 8aaad1e0..1609e9ff 100644 --- a/docs/src/05_building_block_view.adoc +++ b/docs/src/05_building_block_view.adoc @@ -38,29 +38,6 @@ Thus it contains the white box description of selected building blocks of level See https://docs.arc42.org/section-5/[Building Block View] in the arc42 documentation. -**** - -=== Whitebox Overall System - -[role="arc42help"] -**** -Here you describe the decomposition of the overall system using the following white box template. It contains - - * an overview diagram - * a motivation for the decomposition - * black box descriptions of the contained building blocks. For these we offer you alternatives: - - ** use _one_ table for a short and pragmatic overview of all contained building blocks and their interfaces - ** use a list of black box descriptions of the building blocks according to the black box template (see below). - Depending on your choice of tool this list could be sub-chapters (in text files), sub-pages (in a Wiki) or nested elements (in a modeling tool). - - - * (optional:) important interfaces, that are not explained in the black box templates of a building block, but are very important for understanding the white box. -Since there are so many ways to specify interfaces why do not provide a specific template for them. - In the worst case you have to specify and describe syntax, semantics, protocols, error handling, - restrictions, versions, qualities, necessary compatibilities and many things more. -In the best case you will get away with examples or simple signatures. - **** === Scope and Context @@ -76,16 +53,7 @@ Contained Building Blocks:: === Level 1 -image::5-Level1.svg["Scope and Context"] - -[role="arc42help"] -**** -Here you can specify the inner structure of (some) building blocks from level 1 as white boxes. - -You have to decide which building blocks of your system are important enough to justify such a detailed description. -Please prefer relevance over completeness. Specify important, surprising, risky, complex or volatile building blocks. -Leave out normal, simple, boring or standardized parts of your system -**** +image::5-Level1.svg["Level 1"] Motivation:: @@ -93,165 +61,26 @@ In this level of descomposition we separate the main services of our system show Contained Building Blocks:: -* *WIQ _HOME_* : Service which will collect the user interaction and redirect it to the corresponding service. -* *USER_MANAGMENT_* : Service that will manage the user information, login, authentication, etc. -* *WIQ _QUESTION GAME_* Service that will generate and show the different questions for our game. - -[role="arc42help"] -**** -...describes the internal structure of _building block 1_. -**** - -__ - -==== White Box __ - - -__ - -... - -==== White Box __ - - -__ - - - -Important Interfaces:: -__ - -[role="arc42help"] -**** -Insert your explanations of black boxes from level 1: - -If you use tabular form you will only describe your black boxes with name and -responsibility according to the following schema: - -[cols="1,2" options="header"] -|=== -| **Name** | **Responsibility** -| __ | __ -| __ | __ -|=== - - - -If you use a list of black box descriptions then you fill in a separate black box template for every important building block . -Its headline is the name of the black box. -**** - - -==== - -[role="arc42help"] -**** -Here you describe -according the the following black box template: - -* Purpose/Responsibility -* Interface(s), when they are not extracted as separate paragraphs. This interfaces may include qualities and performance characteristics. -* (Optional) Quality-/Performance characteristics of the black box, e.g.availability, run time behavior, .... -* (Optional) directory/file location -* (Optional) Fulfilled requirements (if you need traceability to requirements). -* (Optional) Open issues/problems/risks - -**** - -__ - -__ - -_<(Optional) Quality/Performance Characteristics>_ - -_<(Optional) Directory/File Location>_ - -_<(Optional) Fulfilled Requirements>_ - -_<(optional) Open Issues/Problems/Risks>_ - - - - -==== - -__ - -==== - -__ - - -==== - -... - -==== - - +* *_WIQ_ HOME* : Service which will collect the user interaction and redirect it to the corresponding service. +* *_WIQ_ USER MANAGEMENT* : Service that will manage the user information, login, authentication, etc. +* *_WIQ_ QUESTION GAME* Service that will generate and show the different questions for our game. === Level 2 -[role="arc42help"] -**** -Here you can specify the inner structure of (some) building blocks from level 1 as white boxes. - -You have to decide which building blocks of your system are important enough to justify such a detailed description. -Please prefer relevance over completeness. Specify important, surprising, risky, complex or volatile building blocks. -Leave out normal, simple, boring or standardized parts of your system -**** - -==== White Box __ - -[role="arc42help"] -**** -...describes the internal structure of _building block 1_. -**** - -__ - -==== White Box __ - - -__ - -... - -==== White Box __ - - -__ - - - -=== Level 3 - -[role="arc42help"] -**** -Here you can specify the inner structure of (some) building blocks from level 2 as white boxes. - -When you need more detailed levels of your architecture please copy this -part of arc42 for additional levels. -**** - - -==== White Box <_building block x.1_> - -[role="arc42help"] -**** -Specifies the internal structure of _building block x.1_. -**** - - -__ - - -==== White Box <_building block x.2_> - -__ +image::5-Level2.svg["Level 2"] +Motivation:: +In this level of descomposition of the system we start to identify the different microservices of the system. -==== White Box <_building block y.1_> -__ +Contained Building Blocks:: +* *_HOME_ WELCOME PAGE* : Microservice that will welcome the user giving a small explanation about the game and facilate the registration/login process. +* *_USER MANAGEMENT_ USERSERVICE* : Microservice that will allow the user create an account for the user and let him access the game. +* *_USER MANAGEMENT_ AUTHSERVICE* : Microservice that will login the user in the system and let him access the game. +* *_HOME_ GAMEMODE PAGE* : Microservice that will let the user start a game. +* *_QUESTION GAME_ GAME CONFIGURATION* Microservice that will let the user customize some game parameters (amount of questions, time to respond a question, etc). +* *_QUESTION GAME_ QUESTION RESTAPI* Microservice that will work as our open API allowing other systems to retrieve information like: + ** Random questions and corresponding answers +* *_QUESTION GAME_ QUESTION GENERATOR* Microservice that will generate the different questions for our game communicating with wikidata. +* *_QUESTION GAME_ GAME* Microservice that will show the different questions for our game and manage the user answers in order to give a final score.