Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation topic 1 #25

Merged
merged 4 commits into from
Feb 24, 2024
Merged

Documentation topic 1 #25

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
54624f7
Updated the Quality Goals with the professor's feedback
UO289845 Feb 21, 2024
1bbe2c3
Made some changes in the Requirements Overview of the Introduction fo…
UO289845 Feb 21, 2024
33f5d3d
Fixed typo
UO289845 Feb 24, 2024
ab9c02d
Fixed the requirements overview following the corrections made in the…
UO289845 Feb 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions docs/src/01_introduction_and_goals.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,13 @@ These include
****

=== Requirements Overview
The system will follow the functionality of the "Saber y Ganar" TV program, and so it will allow the users to select an answer between some options.
The questions and answers will be automatically generated using the WikiData API, that will also determine which of the answers is in fact the correct one.
The system will also store the historical data of the users and will be accessible through the web.
The system will follow the functionality of the "Saber y Ganar" TV program, and so it will allow the users to select an answer between some options. +
The questions and answers will be automatically generated using the WikiData API, that will also determine which of the answers is in fact the correct one. +
In adition to this, the system will also store the historical data of the users, thanks to the login and registering service featured in the application, and users will be able to access their information. +
The application will have at least English as an available language. +
Moreover, the project will be stored and deployed through GitHub. +
Lastly, the system will give access to non sensitive user's information through a public API as well as another API for the questions generated.


[role="arc42help"]
****
Expand Down Expand Up @@ -53,7 +57,7 @@ See https://docs.arc42.org/section-1/[Introduction and Goals] in the arc42 docum
|Quality attribute|Scenario
| Usability | The user must be able to understand the function of the application before the minute mark.
| Performance | The application will be able to operate within reasonable response times, taking into account the already present waiting times (time to answer, between questions, etc).
| Security | The information stored about a user can only be accessed by said user, never others.
| Security & Privacy | The information stored about a user can only be accessed by said user, never others.
| Robustness | The application will be able to handle any user error that could happen at runtime.
| Accessibility | The application will be accessible by all users, even if the suffer from visual impediments such as colorblindness.
|===
Expand Down