From fdbf61138a5ea56c37d4c6c2798716baee830ef2 Mon Sep 17 00:00:00 2001 From: Iyan Robles Date: Wed, 28 Feb 2024 22:21:13 +0100 Subject: [PATCH 1/4] Initial quality requirements --- docs/src/10_quality_requirements.adoc | 74 +++++++++++++++++++++++++-- 1 file changed, 71 insertions(+), 3 deletions(-) diff --git a/docs/src/10_quality_requirements.adoc b/docs/src/10_quality_requirements.adoc index a8a2e40c..b26189a1 100644 --- a/docs/src/10_quality_requirements.adoc +++ b/docs/src/10_quality_requirements.adoc @@ -25,8 +25,6 @@ See https://docs.arc42.org/section-10/[Quality Requirements] in the arc42 docume **** -**TBD** - === Quality Tree [role="arc42help"] @@ -48,6 +46,20 @@ In any case the tree should include links to the scenarios of the following sect **** +[mermaid] +.... +graph TD + A[Quality] --> B[Usability] + A --> C[Availability] + A --> D[Security] + A --> E[Maintainability] + A --> F[Privacy] + A --> G[Performance] + A --> H[Efficiency] + A --> I[Testability] + A --> J[Adaptability] +.... + === Quality Scenarios [role="arc42help"] @@ -72,4 +84,60 @@ more precisely down to a level of scenarios that can be discussed and evaluated. .Form Tabular or free form text. -**** \ No newline at end of file +**** + +==== Usage Scenarios + +[cols="1,3,1",options="header"] +|=== +| Quality requirement | Scenario | Priority + +| Maintainability +| The application should have an architectura and design so that the code is more modular, allowing easier maintenance. The documentation should also be clear for potential new team members. +| High + +| Usability +| The web application should provide an intuitive design, making it easier for new users. It should meet usability standards. +| High + +| Performance +| The system reacts to a user's request within one second to ensure a smooth and responsive user experience. +| High + +| Adaptability +| The application should be able to adapt to screen sizes such as desktop screens or smartphones, providing a satisfactory user experience. +| High + +| Privacy +| Users' personal information is protected, and the system implements secure authentication mechanisms to prevent unauthorized access. +| High + +| Testability +| The application must be designed to facilitate testing across various scenarios, supporting robustness and reliability with basic testing frameworks and unit tests. +| Medium + +| Efficiency +| Application functionalities should be efficient for users to accomplish their tasks effectively. +| Medium + +| Availability +| Users can access the application 24 hours a day, ensuring continuous availability. +| Medium + +|=== + +==== Change Scenarios + +[cols="1,3,1",options="header"] +|=== +| Quality requirement | Scenario | Priority + +| Usability +| Usability improvements are implemented based on user feedback and usability testing. +| High + +| Security +| Security controls are updated and strengthened to protect against evolving threats and vulnerabilities. +| High + +|=== \ No newline at end of file From 89da37317900d9fb0e63bf6d050a732f9fe26c38 Mon Sep 17 00:00:00 2001 From: Iyan Robles Date: Tue, 12 Mar 2024 01:51:02 +0100 Subject: [PATCH 2/4] Updated quality requirements --- docs/src/10_quality_requirements.adoc | 55 ++++++++++++++++----------- 1 file changed, 33 insertions(+), 22 deletions(-) diff --git a/docs/src/10_quality_requirements.adoc b/docs/src/10_quality_requirements.adoc index b26189a1..c759a4ea 100644 --- a/docs/src/10_quality_requirements.adoc +++ b/docs/src/10_quality_requirements.adoc @@ -51,11 +51,10 @@ In any case the tree should include links to the scenarios of the following sect graph TD A[Quality] --> B[Usability] A --> C[Availability] - A --> D[Security] - A --> E[Maintainability] - A --> F[Privacy] - A --> G[Performance] - A --> H[Efficiency] + A --> D[Accesibility] + A --> E[Security] + A --> F[Performance] + A --> H[Privacy] A --> I[Testability] A --> J[Adaptability] .... @@ -92,36 +91,37 @@ Tabular or free form text. |=== | Quality requirement | Scenario | Priority -| Maintainability -| The application should have an architectura and design so that the code is more modular, allowing easier maintenance. The documentation should also be clear for potential new team members. -| High - | Usability -| The web application should provide an intuitive design, making it easier for new users. It should meet usability standards. +| When new users access the application the design should be intuitive enough, allowing them to navigate through the system and play the game easily. +The application should meet usability standards. | High | Performance -| The system reacts to a user's request within one second to ensure a smooth and responsive user experience. +| When a user interacts with the system it should react within one second to ensure a smooth and responsive user experience. | High -| Adaptability -| The application should be able to adapt to screen sizes such as desktop screens or smartphones, providing a satisfactory user experience. +| Privacy +| If a user provides personal information during the registration, the application should securely handle and store user-provided personal information. +Encryption should be applied for data storage. | High -| Privacy -| Users' personal information is protected, and the system implements secure authentication mechanisms to prevent unauthorized access. +| Security +| If a malicious user attempts unauthorized access to the application, the application should implement robust authentication mechanisms, +including secure password storage to prevent unauthorized access. | High -| Testability -| The application must be designed to facilitate testing across various scenarios, supporting robustness and reliability with basic testing frameworks and unit tests. +| Adaptability +| If a user accesses the application from a different device than a PC, the application should be able to adapt to the different screen size, providing a satisfactory user experience. | Medium -| Efficiency -| Application functionalities should be efficient for users to accomplish their tasks effectively. +| Accessibility +| In case a user with a visual impairment interacts with the web application, it should follow HTML standards to ensure accessibility. +All interactive elements must be navigable using screen readers, text alternatives should be provided for non-text content. +Additionally, the application's color contrast should be enough for people with color blindness. | Medium | Availability -| Users can access the application 24 hours a day, ensuring continuous availability. +| Users should be able to access the application at any time, with an availability of about 99.9%. | Medium |=== @@ -132,12 +132,23 @@ Tabular or free form text. |=== | Quality requirement | Scenario | Priority +| Maintainability +| When new functionalities are added to the application, they should be easy to add. +The application should have a good architecture and design that makes the code more modular, allowing easier maintenance. +The documentation should also be clear for potential new team members. +| High + | Usability -| Usability improvements are implemented based on user feedback and usability testing. +| New usability improvements should be implemented based on user feedback and usability testing. | High | Security -| Security controls are updated and strengthened to protect against evolving threats and vulnerabilities. +| Different components of the application should be updated frequently to protect against evolving threats and vulnerabilities. | High +| Testability +| When new features are added to the application, new test should be performed and they should be easy to add. +The application must be designed to facilitate testing across new scenarios. +| Medium + |=== \ No newline at end of file From 8b31a29135b35e4af474967b6ee2ac0c18400d2c Mon Sep 17 00:00:00 2001 From: Iyan Robles Date: Tue, 12 Mar 2024 01:53:52 +0100 Subject: [PATCH 3/4] Fixed small typo --- docs/src/10_quality_requirements.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/10_quality_requirements.adoc b/docs/src/10_quality_requirements.adoc index c759a4ea..95ab10b9 100644 --- a/docs/src/10_quality_requirements.adoc +++ b/docs/src/10_quality_requirements.adoc @@ -133,7 +133,7 @@ Additionally, the application's color contrast should be enough for people with | Quality requirement | Scenario | Priority | Maintainability -| When new functionalities are added to the application, they should be easy to add. +| When new functionalities need to be added to the application, they should be easy to integrate. The application should have a good architecture and design that makes the code more modular, allowing easier maintenance. The documentation should also be clear for potential new team members. | High From ef60cb87a14a3ab1b6f88f53d099380a719b078f Mon Sep 17 00:00:00 2001 From: IyanRobles <124174232+IyanRobles@users.noreply.github.com> Date: Wed, 13 Mar 2024 09:21:11 +0100 Subject: [PATCH 4/4] Changed testability priority to high --- docs/src/10_quality_requirements.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/10_quality_requirements.adoc b/docs/src/10_quality_requirements.adoc index 95ab10b9..d01581cd 100644 --- a/docs/src/10_quality_requirements.adoc +++ b/docs/src/10_quality_requirements.adoc @@ -149,6 +149,6 @@ The documentation should also be clear for potential new team members. | Testability | When new features are added to the application, new test should be performed and they should be easy to add. The application must be designed to facilitate testing across new scenarios. -| Medium +| High |=== \ No newline at end of file