Skip to content

Commit

Permalink
Business context documentation deployed
Browse files Browse the repository at this point in the history
  • Loading branch information
ChristianFN2 committed Feb 11, 2024
1 parent 832c8fb commit 4bdca57
Showing 1 changed file with 43 additions and 25 deletions.
68 changes: 43 additions & 25 deletions docs/src/03_system_scope_and_context.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -48,28 +48,46 @@ The title of the table is the name of your system, the three columns contain the
****

**<Diagram or Table>**

**<optionally: Explanation of external domain interfaces>**

=== Technical Context

[role="arc42help"]
****
.Contents
Technical interfaces (channels and transmission media) linking your system to its environment. In addition a mapping of domain specific input/output to the channels, i.e. an explanation which I/O uses which channel.
.Motivation
Many stakeholders make architectural decision based on the technical interfaces between the system and its context. Especially infrastructure or hardware designers decide these technical interfaces.
.Form
E.g. UML deployment diagram describing channels to neighboring systems,
together with a mapping table showing the relationships between channels and input/output.
****

**<Diagram or Table>**

**<optionally: Explanation of technical interfaces>**

**<Mapping Input/Output to Channels>**
[plantuml,"Context diagram",png]
----
actor Player
actor Client
database MongoDB <<local>>
[WIQ Game] <<system>>
[Wikidata] <<external>>
[UsersInfoAPI] <<internal>>
[GeneratedQuestionsAPI] <<internal>>
Player .> (WIQ Game) : login
Client ..> (UsersInfoAPI)
Client ..> (GeneratedQuestionsAPI)
MongoDB --> (UsersInfoAPI)
MongoDB --> (GeneratedQuestionsAPI)
[WIQ Game] <.> (Wikidata) : WikidataAPI
[WIQ Game] <--> (MongoDB)
----

[cols="e,2e" options="header"]
|===
|Element |Description

|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

|MongoDB
|Database for storing generated questions, players' info and scores

|Users Info API
|Allows clients to see the info about players stored in the database

|Generated Questions API
|Allows clients to see the info about generated questions stored in the database
|===

0 comments on commit 4bdca57

Please sign in to comment.