Merge pull request #135 from Arquisoft/DOC_Corrections

Add wiq logo image, and some small details on index
Arquisoft · Mar 11, 2024 · e17b52c · e17b52c
2 parents 0b69112 + 8f68af3
commit e17b52c
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 21 deletions.
diff --git a/docs/images/wiq-logo.png b/docs/images/wiq-logo.png
diff --git a/docs/index.adoc b/docs/index.adoc
@@ -6,10 +6,10 @@
 // configure EN settings for asciidoc
 include::src/config.adoc[]
 
-= image:arc42-logo.png[arc42] WIQ es04b
-:revnumber: 8.2 EN
-:revdate: January 2023
-:revremark: (based upon AsciiDoc version)
+= image:wiq-logo.png[wiq-image] WIQ es04b
+:revnumber: 2
+:revdate: March 2024
+:revremark: ASW - wiq_es04b
 // toc-title definition MUST follow document title without blank line!
 :toc-title: Table of Contents
 
@@ -24,6 +24,11 @@ ifdef::backend-html5[]
 @media print {
 	.arc42help {display:none;}
 }
+
+img[alt="wiq-image"] {
+    width: 100px;
+    height: auto;
+}
 </style>
 ++++
 endif::backend-html5[]

diff --git a/docs/src/03_system_scope_and_context.adoc b/docs/src/03_system_scope_and_context.adoc
@@ -14,12 +14,10 @@ component System [
   QuestionGame
 ]
 component WikiData as wikidata
-database Database
 
 user -down-> System : Uses
-System -right-> Database : Stores/Fetches\nData
-System -left-> wikidata : Retrieves\nInformation
-developers -down-> System : Accesses via\nREST API
+System -left-> wikidata : Retrieves\nInformation to\nform questions\nand answers
+developers -down-> System : Asks for Player\n& Question Data
 System -----> developers : Provides\nPlayer &\n Question Data
 @enduml
 

diff --git a/docs/src/04_solution_strategy.adoc b/docs/src/04_solution_strategy.adoc
@@ -11,13 +11,6 @@ ifndef::imagesdir[:imagesdir: ../images]
 === System Decomposition
 The Model-View-Controler architecture pattern will be followed for structuring the system, dividing it into modules/classes responsible for the managment of the players, questions, answers and game, and the views of the frontend.
 
-=== Quality Goals
-* Performance: A quick system response will be sought, especially during question generation and gameplay.
-* Security: Security measures will be implemented to protect user information and ensure the integrity of generated questions.
-* Availability:
-* Responsiveness:
-* Usability: The system must be easy to use, with a simple and intuitive interface.
-
 === Organizational Decisions
 Development Methodology: GitFlow will be adopted for project management, facilitating collaboration and iterative delivery.
 

diff --git a/docs/src/05_building_block_view.adoc b/docs/src/05_building_block_view.adoc
@@ -1,8 +1,12 @@
-= Building Block View
+ifndef::imagesdir[:imagesdir: ../images]
+
+[[section-building-block-view]]
+
+== Building Block View
 
 The Building Block View elaborates on the static structure of the system. It decomposes the system into building blocks like modules, components, subsystems, and others, detailing their responsibilities and relationships.
 
-== 5.1 Whitebox Overall System
+=== 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.
 
@@ -30,11 +34,11 @@ Dev --> APIMgmt : Uses APIs
 @enduml
 ----
 
-=== Motivation
+==== Motivation
 
 The decomposition provides a clear, high-level overview of how the WIQ system interacts with users, external services (Wikidata), stores data (Database), and interfaces with external developers through the REST API. This modularity supports scalability and maintainability.
 
-=== Contained Building Blocks
+==== Contained Building Blocks
 
 [options="header"]
 |===
@@ -56,7 +60,7 @@ The decomposition provides a clear, high-level overview of how the WIQ system in
 | Developers or systems that interact with the WIQ system via the REST API to access or modify player and question data.
 |===
 
-== 5.2 Level 2
+=== Level 2
 
 For Level 2 of the Building Block View, the WIQ (QuestionGame) system is further decomposed into four primary components that define its operational structure. Each component is designed to fulfill specific roles within the architecture, ensuring the system's functionality and responsiveness to user interactions.
 
@@ -94,7 +98,7 @@ package "WIQ QuestionGame" {
 @enduml
 ----
 
-== 5.3 Level 3
+=== Level 3
 
 In Level 3, we take a closer look at the API Management component, breaking it down into two essential services: the Player Information API and the Question Information API. These services are fundamental to the system's ability to interact with external applications, providing necessary functionalities with a focus on usability and security.