Skip to content

Commit

Permalink
Point 5 of the documentation written and point 3 updated
Browse files Browse the repository at this point in the history
  • Loading branch information
ChristianFN2 committed Feb 18, 2024
1 parent 3b42219 commit b773d4c
Show file tree
Hide file tree
Showing 2 changed files with 85 additions and 83 deletions.
18 changes: 8 additions & 10 deletions docs/src/03_system_scope_and_context.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -52,18 +52,16 @@ The title of the table is the name of your system, the three columns contain the
----
actor Player
actor Client
database MongoDB <<local>>
[WIQ Game] <<system>>
[Wikidata] <<external>>
[UsersInfoAPI] <<internal>>
[WIQ Game] <<system>>
[UsersAPI] <<internal>>
[GeneratedQuestionsAPI] <<internal>>
Player .> (WIQ Game) : login
Client ..> (UsersInfoAPI)
Client ..> (GeneratedQuestionsAPI)
MongoDB --> (UsersInfoAPI)
MongoDB --> (GeneratedQuestionsAPI)
[WIQ Game] <.> (Wikidata) : WikidataAPI
[WIQ Game] <--> (MongoDB)
Player ..> (WIQ Game) : register/login
Client ..> (WIQ Game) : view data
[GeneratedQuestionsAPI] ..> Wikidata
[WIQ Game] ..> UsersAPI
[WIQ Game] ..> GeneratedQuestionsAPI
----

[cols="e,2e" options="header"]
Expand Down
150 changes: 77 additions & 73 deletions docs/src/05_building_block_view.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -63,18 +63,53 @@ In the best case you will get away with examples or simple signatures.
****

_**<Overview Diagram>**_
[plantuml,"White box 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
}
----

Motivation::

_<text explanation>_
We made the decomposition separating the functionallities (The names are self explanatory but components will be described later)

Contained Black boxes::

Contained Building Blocks::
_<Description of contained building block (black boxes)>_
[cols="e,2e" options="header"]
|===
|Name |Responsibility

|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

|UsersAPI
|In charge of keeping track of the data of the users (registration and scores)

|Wikidata
|External element used for the generation of questions

Important Interfaces::
_<Description of important interfaces>_
|===

[role="arc42help"]
****
Expand All @@ -97,8 +132,6 @@ Its headline is the name of the black box.
****


==== <Name black box 1>

[role="arc42help"]
****
Here you describe <black box 1>
Expand All @@ -113,37 +146,6 @@ according the the following black box template:
****

_<Purpose/Responsibility>_

_<Interface(s)>_

_<(Optional) Quality/Performance Characteristics>_

_<(Optional) Directory/File Location>_

_<(Optional) Fulfilled Requirements>_

_<(optional) Open Issues/Problems/Risks>_




==== <Name black box 2>

_<black box template>_

==== <Name black box n>

_<black box template>_


==== <Name interface 1>

...

==== <Name interface m>



=== Level 2

Expand All @@ -156,57 +158,59 @@ Please prefer relevance over completeness. Specify important, surprising, risky,
Leave out normal, simple, boring or standardized parts of your system
****

==== White Box _<building block 1>_
==== Generated Questions API (White Box)

[role="arc42help"]
****
...describes the internal structure of _building block 1_.
****

_<white box template>_

==== White Box _<building block 2>_


_<white box template>_

...

==== White Box _<building block m>_


_<white box template>_

[plantuml,"Generated Questions API (White Box)",png]
----
[Wikidata]
[wikidatanpm] <<library>>
[WIQ Game GUI]
[Data View]
database MongoDB
rectangle "GenedQuestsAPI (Level 2)"{
=== Level 3
[GenQuestsService] ..> wikidatanpm
[GenQuestsService] ..> Wikidata
[GenQuestsService] <--> MongoDB
[WIQ Game GUI] ..> GenQuestsService : new Question
[Data View] ..> GenQuestsService : get Questions
}
----

[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.
****
Motivation::

We made the decomposition separating the functionallities.

==== White Box <_building block x.1_>

[role="arc42help"]
****
Specifies the internal structure of _building block x.1_.
****
Contained Black boxes::

[cols="e,2e" options="header"]
|===
|Name |Responsibility

_<white box template>_
|GenQuestsService
|Receives different petitions regarding the generation of questions or their retrieval and responds accordingly.

|wikidatanpm
|External library that facilitates and simplifies the use of wikidata for the generation of questions.

==== White Box <_building block x.2_>
|MongoDB
|The data of the generated questions is stored here for showing it later to the client.

_<white box template>_
|===

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).

==== White Box <_building block y.1_>
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.

_<white box template>_
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.

0 comments on commit b773d4c

Please sign in to comment.