Skip to content

Commit

Permalink
Update doc 5
Browse files Browse the repository at this point in the history
  • Loading branch information
Pelayori committed Apr 28, 2024
1 parent 652886b commit 145fc1e
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 25 deletions.
2 changes: 1 addition & 1 deletion docs/src/03_system_scope_and_context.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ RestApiService ---> PlayerService: Retrieve/Modify player data
[options="header",cols="1,2,2"]
|===
|Component|Input/Output|Channel/Protocol
| RestApiService| External developer interactions| HTTP
| RestApiService| External developer interactions| HTTPS
| Frontend| User interactions, game display| HTTPS
| Database| User data, game history, questions| Specific database driver
| WikiData| Data for question generation| HTTP
Expand Down
51 changes: 27 additions & 24 deletions docs/src/05_building_block_view.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The Building Block View elaborates on the static structure of the system. It dec

=== Whitebox Overall System

This section provides an overview of the main components of the system and their interactions. The core of the system is the WIQ (QuestionGame) component, which interfaces with Users, Wikidata for question generation, a Database for persistence, and offers a REST API for External Developers.
This section provides an overview of the main components of the system and their interactions. The core of the system is the WIQ (WiqEs04bApplication) component, which interfaces with Users, Wikidata for question generation, a Database for persistence, and offers a REST API for External Developers.

[plantuml,"Whitebox-overall",png]
----
Expand All @@ -17,19 +17,16 @@ This section provides an overview of the main components of the system and their
actor User
actor "External Developers" as Dev
component "[WIQ QuestionGame]" as WIQ {
component "[GameSession\nService]" as Logic
component "[PlayerService]" as UserMgmt
component "[QuestionService]" as QuestMgmt
component "[RestApi\nService]" as APIMgmt
component "com.uniovi.WiqEs04bApplication" as WIQ {
}
database "Database" as DB
[WikiData] as WikiData
User --> WIQ : Interacts
WIQ --> WikiData : Fetches data
WIQ --> DB : Reads/Writes Data
Dev --> APIMgmt : Uses APIs
Dev --> WIQ : Uses APIs
@enduml
----
Expand All @@ -47,7 +44,7 @@ The decomposition provides a clear, high-level overview of how the WIQ system in
| User
| Represents the end users of the WIQ application, interacting with the system to play games and view their history.

| WIQ (QuestionGame)
| WIQ (WiqEs04bApplication)
| The central component that manages gameplay logic, user interactions, and integrates external data for question generation.

| Wikidata
Expand Down Expand Up @@ -78,23 +75,29 @@ For Level 2 of the Building Block View, the WIQ (QuestionGame) system is further
@startuml
!theme plain
package "WIQ QuestionGame" {
component "[GameSession\nService]" as Logic
component "[PlayerService]" as UserMgmt
component "[QuestionService]" as QuestMgmt
component "[RestApi\nService]" as APIMgmt
UserMgmt -[hidden]-> Logic : <<uses>>
QuestMgmt -[hidden]-> Logic : <<uses>>
APIMgmt -[hidden]-> UserMgmt : <<interfaces>>
APIMgmt -[hidden]-> QuestMgmt : <<interfaces>>
Logic ..> UserMgmt : Uses
Logic ..> QuestMgmt : Uses
UserMgmt ..> APIMgmt : Interfaces
QuestMgmt ..> APIMgmt : Interfaces
actor User
actor "External Developers" as Dev
component "com.uniovi.WiqEs04bApplication" {
package "com.uniovi.services" {
component "[GameSession\nService]" as Logic
component "[PlayerService]" as UserMgmt
component "[QuestionService]" as QuestMgmt
component "[RestApi\nService]" as APIMgmt
UserMgmt -[hidden]-> Logic : <<uses>>
QuestMgmt -[hidden]-> Logic : <<uses>>
APIMgmt -[hidden]-> UserMgmt : <<interfaces>>
APIMgmt -[hidden]-> QuestMgmt : <<interfaces>>
Logic ..> UserMgmt : Uses
Logic ..> QuestMgmt : Uses
UserMgmt ..> APIMgmt : Interfaces
QuestMgmt ..> APIMgmt : Interfaces
}
}
User --> [com.uniovi.WiqEs04bApplication] : Interacts
Dev --> APIMgmt : Uses APIs
@enduml
----

Expand All @@ -113,7 +116,7 @@ This level of documentation provides a structured and clear view of the system's
@startuml
!theme plain
package "API Management" {
package "com.uniovi.services.RestApiService" {
interface "Player Information API" as PlayerAPI
interface "Question Information API" as QuestAPI
Expand Down

0 comments on commit 145fc1e

Please sign in to comment.