Skip to content

Commit

Permalink
Final version of 03_system_scope_and_context & quick fix in 12_glossary
Browse files Browse the repository at this point in the history
  • Loading branch information
PabloGOP committed Feb 19, 2024
1 parent 3041a6b commit ba7867b
Show file tree
Hide file tree
Showing 7 changed files with 17 additions and 15 deletions.
Binary file modified docs/images/03_Business_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/03_Technical_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/03_Technical_2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 10 additions & 10 deletions docs/src/03_system_scope_and_context.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -48,12 +48,10 @@ The title of the table is the name of your system, the three columns contain the
****

image:03_Business_1s.png["Diagram 3.1: Business Context"]
image:03_Business_1.png["Diagram 3.1: Business Context"]


**<Diagram or Table>**

**<optionally: Explanation of external domain interfaces>**
- **WIQ:** Overview of the whole system. Essentialy, a web application in which users will be able to register/log in, play "Saber y Ganar" and display statistics of their games.
- **Wikidata:** Free and open knowledge base that acts as a central storage repository for structured data. Its API will be used to obtain information used in questions and answers of the application.

=== Technical Context

Expand All @@ -74,12 +72,14 @@ together with a mapping table showing the relationships between channels and inp
==== System Scope
image:03_Technical_1.png["Diagram 3.2: Techincal Context"]

==== Gateway Service System
image:03_Technical_2.png["Diagram 3.3: Communication"]

- **WIQ Webapp:** Module that supports user interaction via UI _i.e._, the front-end of the whole system.
- **Gateway Service:** Express service that is exposed to the public and serves as a proxy to the users management allowing sign up and log in.
- **Question Generation Service**: Service that will be used internally to manage information retrival from Wikidata.

**<Diagram or Table>**
==== Gateway Service System
image:03_Technical_2.png["Diagram 3.3: Communication"]

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

**<Mapping Input/Output to Channels>**
- **User service:** Express service that handles the insertion of new users in the system.
- **Auth service:** Express service that handles the authentication of users.
2 changes: 1 addition & 1 deletion docs/src/12_glossary.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ See https://docs.arc42.org/section-12/[Glossary] in the arc42 documentation.
|Proposal to merge a set of changes from one branch into another. In a pull request, collaborators can review and discuss the proposed set of changes before they integrate the changes into the main codebase.

|WIQ
|TBD
|https://github.com/Arquisoft/wiq_es04a/discussions/19[Wikidata Infinite Quest]
|Web application's name, where the users can register and login themselves to play different type of rounds.
|===

Expand Down
5 changes: 3 additions & 2 deletions docs/src_mermaid/03_Business_1
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
flowchart TD
el1[User] -.->|Interacts with| sis1(WIQ Webapp)
subgraph system
subgraph WIQ
sis1 --> |Authenticate| sis2(Gateway Service)
sis1 --> |Create user| sis2
sis1 --> |Get questions| sis5(Question Generation Service)
end
sis1 --> |Get questions| D[Wikidata]
sis5 -.-> D[Wikidata]
5 changes: 3 additions & 2 deletions docs/src_mermaid/03_Technical_1
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
flowchart TD
el1[User] -.->|Interacts with| sis1(WIQ Webapp)
subgraph system
subgraph WIQ
sis1 --> |Authenticate| sis2(Gateway Service)
sis1 --> |Create user| sis2
sis1 --> |Get questions| sis5(Question Generation Service)
sis2 --> |Log in validation| sis3(Authentication service)
sis2 --> |Sign up user| sis4(User service)
sis3 --> db1[(MongoDB)]
sis4 --> db1
end
sis1 --> |Get questions| D[Wikidata]
sis5 -.-> D[Wikidata]

0 comments on commit ba7867b

Please sign in to comment.