From f8f2cbdbaa699d6c54b6b6a3c636d6ee7ca63ca4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andr=C3=A9s=20Cadenas?= <77900120+andrrsin@users.noreply.github.com> Date: Sat, 17 Feb 2024 13:34:19 +0100 Subject: [PATCH] Point 1.2 done --- .vscode/settings.json | 1 + docs/src/01_introduction_and_goals.adoc | 100 ++++++++++++++---------- 2 files changed, 58 insertions(+), 43 deletions(-) create mode 100644 .vscode/settings.json diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..9e26dfe --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/docs/src/01_introduction_and_goals.adoc b/docs/src/01_introduction_and_goals.adoc index 587e6c0..8a8206d 100644 --- a/docs/src/01_introduction_and_goals.adoc +++ b/docs/src/01_introduction_and_goals.adoc @@ -3,44 +3,44 @@ ifndef::imagesdir[:imagesdir: ../images] [[section-introduction-and-goals]] == Introduction and Goals -// [role="arc42help"] -// **** -// Describes the relevant requirements and the driving forces that software architects and development team must consider. -// These include - -// * underlying business goals, -// * essential features, -// * essential functional requirements, -// * quality goals for the architecture and -// * relevant stakeholders and their expectations -// **** -In this points, the main goals and functional requirements will be explained. In order to give context on how the webapp will be developed. +[role="arc42help"] +**** +Describes the relevant requirements and the driving forces that software architects and development team must consider. +These include + +* underlying business goals, +* essential features, +* essential functional requirements, +* quality goals for the architecture and +* relevant stakeholders and their expectations +**** +In these points, the main goals and functional requirements will be explained. In order to give context on how the webapp will be developed. === Requirements Overview -// [role="arc42help"] -// **** -// .Contents -// Short description of the functional requirements, driving forces, extract (or abstract) -// of requirements. Link to (hopefully existing) requirements documents -// (with version number and information where to find it). +[role="arc42help"] +**** +.Contents +Short description of the functional requirements, driving forces, extract (or abstract) +of requirements. Link to (hopefully existing) requirements documents +(with version number and information where to find it). -// .Motivation -// From the point of view of the end users a system is created or modified to -// improve support of a business activity and/or improve the quality. +.Motivation +From the point of view of the end users a system is created or modified to +improve support of a business activity and/or improve the quality. -// .Form -// Short textual description, probably in tabular use-case format. -// If requirements documents exist this overview should refer to these documents. +.Form +Short textual description, probably in tabular use-case format. +If requirements documents exist this overview should refer to these documents. -// Keep these excerpts as short as possible. Balance readability of this document with potential redundancy w.r.t to requirements documents. +Keep these excerpts as short as possible. Balance readability of this document with potential redundancy w.r.t to requirements documents. -// .Further Information +.Further Information -// See https://docs.arc42.org/section-1/[Introduction and Goals] in the arc42 documentation. +See https://docs.arc42.org/section-1/[Introduction and Goals] in the arc42 documentation. -// **** +**** The functional requirements have been grouped into the different microservices the web application will have. ==== User and Authorization Services [decimal] @@ -80,25 +80,39 @@ The functional requirements have been grouped into the different microservices t . The questions should be selected randomly. === Quality Goals -// [role="arc42help"] -// **** -// .Contents -// The top three (max five) quality goals for the architecture whose fulfillment is of highest importance to the major stakeholders. -// We really mean quality goals for the architecture. Don't confuse them with project goals. -// They are not necessarily identical. +[role="arc42help"] +**** +.Contents +The top three (max five) quality goals for the architecture whose fulfillment is of highest importance to the major stakeholders. +We really mean quality goals for the architecture. Don't confuse them with project goals. +They are not necessarily identical. -// Consider this overview of potential topics (based upon the ISO 25010 standard): +Consider this overview of potential topics (based upon the ISO 25010 standard): -// image::01_2_iso-25010-topics-EN.drawio.png["Categories of Quality Requirements"] +image::01_2_iso-25010-topics-EN.drawio.png["Categories of Quality Requirements"] -// .Motivation -// You should know the quality goals of your most important stakeholders, since they will influence fundamental architectural decisions. -// Make sure to be very concrete about these qualities, avoid buzzwords. -// If you as an architect do not know how the quality of your work will be judged... +.Motivation +You should know the quality goals of your most important stakeholders, since they will influence fundamental architectural decisions. +Make sure to be very concrete about these qualities, avoid buzzwords. +If you as an architect do not know how the quality of your work will be judged... + +.Form +A table with quality goals and concrete scenarios, ordered by priorities +**** +[options="header", cols="1,1"] +|=== +| Goal | Description +| Testability |Test will be developed, so the application has a good quality. + +| Usability | The application has to be intuitive for its users. -// .Form -// A table with quality goals and concrete scenarios, ordered by priorities -// **** +| Portability | The application works in different devices and browsers. With different screen sizes. + +| Performance | The application can handle a big number of users and give good response times. + + + +|=== === Stakeholders