Skip to content

Commit

Permalink
Point 1.2 done
Browse files Browse the repository at this point in the history
  • Loading branch information
andrrsin committed Feb 17, 2024
1 parent 3b45b89 commit f8f2cbd
Show file tree
Hide file tree
Showing 2 changed files with 58 additions and 43 deletions.
1 change: 1 addition & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{}
100 changes: 57 additions & 43 deletions docs/src/01_introduction_and_goals.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down Expand Up @@ -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

Expand Down

0 comments on commit f8f2cbd

Please sign in to comment.