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.

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 part 1 - Stakeholders and Quality #30

Merged
merged 3 commits into from
Feb 10, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
42 changes: 38 additions & 4 deletions docs/01_introduction_and_goals.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ Describes the relevant requirements and the driving forces that software archite

=== Requirements Overview


[role="arc42help"]
****
.Contents
Expand All @@ -30,6 +31,20 @@ 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.
****


* Users must be able to add locations to their own maps
** The locations could be of different types, initially shops, bars, restaurants, sight and monuments.
* Users must be able to add reviews to locations.
** Scores, comments and pictures could be added to a location.
* Locations could be shared with other users.
** Locations will be shared to a friend or a group of friends.
* User's data will be extracted and stored into SOLID PODS.
** Users' locations information will also be stored in the user' POD.
* Locations will be printed in a map.
** The map should have filters. Initially vategory, friends, and different types of locations.



=== Quality Goals

[role="arc42help"]
Expand All @@ -44,6 +59,15 @@ 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,2,2"]
|===
|Priority|Description|Expectations
|1|Delivery time|Project must be delivered the first week of May.
|2|Privacy|Users' data will only be accessed when permissions have been granted.
|3|Decentralization|Users' data will be accessed and stored using Solid PODS.
|4|Usability|The application must be intuitive so a novice user should be able to navigate in less than 10 minutes.
|5|Accesibility|The web application will comply with WCAG 2.0 at level AAA.
|===

=== Stakeholders

Expand All @@ -67,9 +91,19 @@ These stakeholders determine the extent and the level of detail of your work and
Table with role names, person names, and their expectations with respect to the architecture and its documentation.
****

[options="header",cols="1,2,2"]
[options="header",cols="1,2,2,2"]
|===
|Role/Name|Contact|Expectations
| _<Role-1>_ | _<Contact-1>_ | _<Expectation-1>_
| _<Role-2>_ | _<Contact-2>_ | _<Expectation-2>_
|Role/Name|Contact|Description|Expectations
|Developers|Mario Pérez Fernández ([email protected]) +
Ivan Vega Gracía ([email protected]) +
Silvia Suárez Prendes ([email protected]) +
Sara María Ramírez Pérez ([email protected]) +
Elías Llera García-Riaño ([email protected]) +
Andrés Álvarez Murillo ([email protected])|Group of students in charge of developing the project.|Deliver a fucntional version that meets the specified requirements.
|Teachers|Pablo González González ([email protected]) +
José Emilio Labra Gayo ([email protected]) |Professors of the course in charge of supervising and guide the development team.| Evaluate the final delivery and help through the process.
|Users| |Final users of LoMap. |Use the application, and they should be satisfied by it.
|Solid|https://forum.solidproject.org|Specification to store users' data in a decentralized manner. | Gain decentralization of data.
|Compaines |Inrupt +
Empathy |Compaines involved in the Solid challenge. |
|===
2 changes: 1 addition & 1 deletion docs/12_glossary.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,6 @@ Potentially more columns in case you need translations.
[options="header"]
|===
| Term | Definition
| <Term-1> | <definition-1>
| WCAG | Web Content Accessibility Guidelines (https://www.w3.org/WAI/WCAG2AAA-Conformance)
| <Term-2> | <definition-2>
|===