Skip to content

Commit

Permalink
Merge pull request #144 from martinweck/more-requirements
Browse files Browse the repository at this point in the history
adds more example requirements.
  • Loading branch information
gernotstarke authored Dec 5, 2023
2 parents 3e5fb4f + 0441d09 commit 21e005c
Show file tree
Hide file tree
Showing 6 changed files with 93 additions and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ You have an environment that allows to run

### Build and test

In the root directory, run `docker compose up`.
In the root directory, run `docker-compose up`.



Expand Down
20 changes: 20 additions & 0 deletions requirements/A/_posts/2023-12-05-accurate-vehicle-position-gps.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: Vehicle's position validity influences accuracy
tags: reliable usable
related: preciseness, precision, reliability, functional correctness
permalink: /requirements/accurate-vehicle-position-gps
---

<div class="quality-requirement" markdown="1">

**Scenario**: The vehicle's position on the map of the navigation system

**Stimulus**: is updated.

**Reaction**: The current position of the vehicle is determined by extrapolation and not GPS data.

**Metric**: The extrapolated position is recalculated with a frequency greater than 10Hz.

**Background**: The GPS position retrieval rate via satellite might be insufficient low, such that in-between positions are determined using extrapolation.

</div><br>
16 changes: 16 additions & 0 deletions requirements/E/_posts/2023-12-05-efficient-save-function.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: "Efficient save function"
tags: efficient
related: efficiency, time behaviour, capacity
permalink: /requirements/efficient-save-function
---

<div class="quality-requirement" markdown="1">

**Stimulus**: A user uses the web interface to add article to the shopping cart.

**Reaction**: The system displays a confirmation, i.e. an article counter above the shopping cart icon is incremented, once the article has been added reliably to the cart.

**Metric**: The time between hitting the add article button and the displayed confirmation is less than 1 second in 99% of the tests.

</div><br>
18 changes: 18 additions & 0 deletions requirements/I/_posts/2023-12-05-installability-new-feature
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: "Rollout of a new feature"
tags: installability
related: agility, changeability, maintainability
permalink: /requirements/rollout-new-feature
---

<div class="quality-requirement" markdown="1">

**Stimulus**: The product team provides a new feature.

**Reaction**: The system updates itself in a way that the new feature can be used.

**Metric**: There is no action required from the user to be able to use the new feature, i.e. the new feature just becomes available.

**Background**: If software is provided via an install kit, it may need to be provided for different operating systems and users will have to run an update installer to access new features. In contrast, web-based systems retrieve their logic over the network, so no action from the user site is needed. Since a requirement, like the one above, is not dictating a solution, but what needs to be fulfilled other solutions than a web-based system that avoids installation were also valid.

</div><br>
20 changes: 20 additions & 0 deletions requirements/L/_posts/2023-12-05-learnability-find-article.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: New users learn to find articles on their own
tags: usable
related: usability, user experience
permalink: /requirements/learnability-find-article
---

<div class="quality-requirement" markdown="1">

**Scenario**: A user who has never used the system before, but other IT systems in general

**Stimulus**: has to find a specific article.

**Reaction**: The system's search page displays the article as a search result if asked for it.

**Metric**: 95% of the users find the search page and then the article in less than two minutes.

**Background**: The navigation and search page must be built in a way that users who use other IT-systems learn the usage of the given system without having to read a manual or the need to ask someone.

</div><br>
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
title: Precision of vehicle's orientation
tags: reliable
related: accuracy, preciseness, precision, reliability, functional correctness
permalink: /requirements/precise-vehicle-orientation-gps
---

<div class="quality-requirement" markdown="1">

**Scenario**: The orientation of the vehicle

**Stimulus**: is measured twice for the same orientation.

**Reaction**: The orientation is displayed in the gps software.

**Metric**: The orientation precision is better than ± 3°

</div><br>

0 comments on commit 21e005c

Please sign in to comment.