Fix bug Runtime View. General View now is Level 1. Added General View.

docs/src/05_building_block_view.adoc

@@ -66,6 +66,122 @@ In the best case you will get away with examples or simple signatures.
 [plantuml, format="png"]
 ----
 @startuml
+title Scope & Context
+left to right direction
+' Define custom style for components
+skinparam componentStyle uml2
+
+' Define components as rectangles without default stereotypes
+rectangle "WIQ" as WIQ
+cloud "Wikidata API" as WikidataAPI
+actor "User" as User
+
+' Define connections
+User --> WIQ
+WIQ --> WikidataAPI
+@enduml
+----
+
+
+Motivation::
+
+This is a basic introduction to the app, highlighting the external services it uses and how they work together.
+
+Contained Building Blocks::
+
+[cols="1,2" options="header"]
+|===
+| **Name** | **Responsibility**
+| WIQ  | It’s the main application, currently represented as a whitebox. The following sections will break it down in detail.
+| WikidataAPI | External API used as the knowledge hub.
+|===
+
+
+[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**
+| _<black box 1>_ | _<Text>_
+| _<black box 2>_ | _<Text>_
+|===
+
+
+
+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.
+****
+
+
+==== <Name black box 1>
+
+[role="arc42help"]
+****
+Here you describe <black box 1>
+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
+
+
+
+_<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 1
+
+[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
+
+****
+
+[plantuml, format="png"]
+----
+@startuml
+title Main App
+
 ' Define custom style for components
 skinparam componentStyle uml2
 
@@ -74,8 +190,10 @@ rectangle Frontend
 rectangle "User Management" as UserManagement
 rectangle "Question Generation" as QuestionGeneration
 cloud "Wikidata API" as WikidataAPI
+actor "User" as User
 
 ' Define connections
+User --> Frontend
 Frontend --> UserManagement
 Frontend --> QuestionGeneration
 QuestionGeneration --> WikidataAPI
@@ -144,7 +262,7 @@ according the the following black box template:
 * (Optional) Fulfilled requirements (if you need traceability to requirements).
 * (Optional) Open issues/problems/risks
 
-****
+
 
 _<Purpose/Responsibility>_
 
@@ -176,7 +294,7 @@ _<black box template>_
 
 ==== <Name interface m>
 
-
+****
 
 === Level 2
 
@@ -189,16 +307,29 @@ 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>_
+==== White Box User Management Service
 
 [role="arc42help"]
 ****
-...describes the internal structure of _building block 1_.
+...describes the internal structure of the User Management Service.
 ****
 
-_<white box template>_
+[plantuml, format="png"]
+----
+@startuml
+' Define custom style for components
+skinparam componentStyle uml2
 
-==== White Box _<building block 2>_
+' Define components as rectangles without default stereotypes
+rectangle "User Management" as UserManagement
+database "MongoDB Database" as MongoDB
+
+' Define connections
+UserManagement --> MongoDB
+@enduml
+----
+
+==== White Box Question Generation Service
 
 
 _<white box template>_
@@ -211,7 +342,6 @@ _<white box template>_
 _<white box template>_
 
 
-
 === Level 3
 
 [role="arc42help"]

docs/src/06_runtime_view.adoc

@@ -36,6 +36,6 @@ UsersService  -> DB: CreateUserData()
 DB -> UsersService: Confirm data
 UsersService -> UsersService: signUp()
 UsersService -> FrontEnd: Redirect to login page
+@enduml
 ----
-
 === <Runtime Scenario n>