diff --git a/images/Context Diagram.png b/images/Context Diagram.png index 0bce9d8..167280f 100644 Binary files a/images/Context Diagram.png and b/images/Context Diagram.png differ diff --git a/images/Generated Questions API (WhiteBox).png b/images/Generated Questions API (WhiteBox).png index 4966391..4509c81 100644 Binary files a/images/Generated Questions API (WhiteBox).png and b/images/Generated Questions API (WhiteBox).png differ diff --git a/images/QualityTree.png b/images/QualityTree.png deleted file mode 100644 index e90ed4e..0000000 Binary files a/images/QualityTree.png and /dev/null differ diff --git a/images/Sequence diagram.png b/images/Sequence diagram.png new file mode 100644 index 0000000..c5e1de8 Binary files /dev/null and b/images/Sequence diagram.png differ diff --git a/images/Whitebox overall system.png b/images/Whitebox overall system.png index 9dd0cde..c3889ef 100644 Binary files a/images/Whitebox overall system.png and b/images/Whitebox overall system.png differ diff --git a/images/game diagram.png b/images/game diagram.png deleted file mode 100644 index ec27888..0000000 Binary files a/images/game diagram.png and /dev/null differ diff --git a/images/questions diagram.png b/images/questions diagram.png deleted file mode 100644 index 7d8d915..0000000 Binary files a/images/questions diagram.png and /dev/null differ diff --git a/images/users diagram.png b/images/users diagram.png deleted file mode 100644 index 5a85b8a..0000000 Binary files a/images/users diagram.png and /dev/null differ diff --git a/index.html b/index.html index 708309a..5989065 100644 --- a/index.html +++ b/index.html @@ -447,8 +447,7 @@

arc42 T
  • 1. Introduction and Goals
  • 2. Architecture Constraints
  • @@ -470,6 +469,10 @@

    arc42 T
  • 6.2. Access to user data via API
  • 6.3. Access to questions data via API
  • 6.4. Game
  • +
  • 6.5. <Runtime Scenario 1>
  • +
  • 6.6. <Runtime Scenario 2>
  • +
  • 6.7. …​
  • +
  • 6.8. <Runtime Scenario n>
  • 7. Deployment View @@ -489,7 +492,6 @@

    arc42 T
  • 10. Quality Requirements
  • 11. Risks and Technical Debts
  • @@ -609,10 +611,9 @@

    1.1. Requirements Overview

    -

    The functional requirements have been grouped into the different microservices the web application will have.

    +

    The functional requirements have been grouped into the different microservices the web application will have. +==== User and Authorization Services

    -
    -

    1.1.1. User and Authorization Services

    1. @@ -671,9 +672,8 @@

      1.1.1. User and Authorization Services

    -
    -

    1.1.2. Question Service

    +

    1.1.1. Question Service

    1. @@ -718,14 +718,11 @@

      1.1.2. Question Service

  • -

    The questions should be selected randomly.

    +

    The questions should be selected randomly. +=== Quality Goals

  • - - -
    -

    1.2. Quality Goals

    @@ -785,8 +782,9 @@

    1.2. Quality Goals

    +
    -

    1.3. Stakeholders

    +

    1.2. Stakeholders

    @@ -1013,7 +1011,7 @@

    3.1. Business Context

    -Context Diagram +Context Diagram
    @@ -1033,28 +1031,24 @@

    3.1. Business Context

    - - - - - + - + - + - +

    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

    External data repository from which questions are generated

    MongoDB

    Database for storing generated questions, players' info and scores

    Database for storing players' info and scores

    Users Info API

    Allows clients to see the info about players stored in the database

    Manages data of users, both registration/login data and their past scores

    Generated Questions API

    Allows clients to see the info about generated questions stored in the database

    Manages generation of questions from Wikidata

    @@ -1251,12 +1245,8 @@

    5.1. Whitebox Overall System

    Main window in which questions are shown and can be answered by the player. The latter can also see past scores.

    -

    Data View

    -

    Access to data about users and generated questions for the client.

    - -

    Generated Questions API

    -

    In charge of generating the questions and storing their data

    +

    In charge of generating the questions

    UsersAPI

    @@ -1361,7 +1351,7 @@

    5.2.1. Generated Questions API (Whit

    -Generated Questions API (WhiteBox) +Generated Questions API (WhiteBox)
    @@ -1387,35 +1377,18 @@

    5.2.1. Generated Questions API (Whit

    GenQuestsService

    -

    Receives different petitions regarding the generation of questions or their retrieval and responds accordingly.

    +

    Receives different petitions regarding the generation of questions and responds accordingly.

    -

    wikidatanpm

    +

    wikibase-sdk

    External library that facilitates and simplifies the use of wikidata for the generation of questions.

    MongoDB

    -

    The data of the generated questions is stored here for showing it later to the client.

    +

    Data about users and their scores is stored here

    -
    -
    -
    Additional explanation of relationships
    -
    -

    The service is requested either the generation of a question or the retrieval of a subset (from WIQ Game GUI or -Data View respectively).

    -
    -
    -
    -
    -

    For the first case, it makes use of the library to generate the question, retrieves it -for the interface to use and stores the pertinent data in the DB.

    -
    -
    -

    In the other case, it just makes the query according to the client choosings and retrieves the data of the -questions for the Data View to show.

    -

    @@ -1448,7 +1421,7 @@

    6.2. Access to user data via API

    -users diagram +Sequence diagram
    @@ -1463,7 +1436,7 @@

    6.3. Access to questions data via API

    -questions diagram +Sequence diagram
    @@ -1478,7 +1451,7 @@

    6.4. Game

    -game diagram +Sequence diagram
    @@ -1543,6 +1516,39 @@

    6.4. Game

    + +
    +

    6.5. <Runtime Scenario 1>

    +
    + +
    +
    +

    It is possible to use a sequence diagram:

    +
    +
    +
    +Sequence diagram +
    +
    +
    +
    +

    6.6. <Runtime Scenario 2>

    + +
    +
    +

    6.7. …​

    + +
    +
    +

    6.8. <Runtime Scenario n>

    @@ -1985,14 +1991,16 @@

    10.1. Quality Tree

    -
    -
    -The Quality Tree of the project -
    -
    +
    +

    @startmindmap +* Quality + Testability + Usability + Portability + Performance +@endmindmap +=== Quality Scenarios

    -
    -

    10.2. Quality Scenarios

    @@ -2032,7 +2040,7 @@

    10.2. Quality Scenarios

    -

    10.2.1. Usage Scenarios

    +

    10.1.1. Usage Scenarios

    @@ -2077,7 +2085,7 @@

    10.2.1. Usage Scenarios

    -

    10.2.2. Change Scenarios

    +

    10.1.2. Change Scenarios