covid19/cwa-documentation
covid19/cwa-documentation
1
0
Fork 0
mirror of https://github.com/corona-warn-app/cwa-documentation synced 2024-11-24 18:24:26 +01:00
Code Releases Activity

feat: Use makefile targets for document linting (#215)

Browse Source 
This Makefile provides several targets for linting
documents. It utilizes several npm packages.
Functionality includes:

* Spellcheck
* Linting of markdown
* Check for broken links
* Sorting of dictionary file
* Detect inconsidered language

All targets (excluding the sorting of the dict file) are part
of the Github Action pipeline and will fail if quality
standards are not met.

Signed-off-by: Johannes Amorosa <johannes.amorosa@endocode.com>
This commit is contained in:
Johannes Amorosa 2020-07-05 15:37:23 +02:00 committed by GitHub
parent f44275d4b1
commit 02caed10d1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
11 changed files with 4073 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.alexrc.yaml Normal file
View File

@ -0,0 +1,4 @@
allow:
- German
- german
- european

40
.github/workflows/checks.yml vendored Normal file
View File

@ -0,0 +1,40 @@
name: Checks
on: [push]
jobs:
build:
name: Build
runs-on: ubuntu-latest
steps:
- name: Install requirements
run: |
sudo apt install -y automake npm nodejs
- name: Checkout code
uses: actions/checkout@v2
- name: Install npm dependencies
if: always()
run: |
make install
- name: Linting markdown
if: always()
run: |
make markdownlint
- name: Checking for broken links
if: always()
run: |
make checklinks
- name: Spellchecking english
if: always()
run: |
make spellcheck-en
- name: Detect inconsiderate language
if: always()
run: |
make detect-inconsiderate-language

1
.gitignore vendored
View File

@ -1 +1,2 @@
.DS_STORE
node_modules

28
.spelling Normal file
View File

@ -0,0 +1,28 @@
backend
Backend
Bundesbeauftragter
Bundesnetzagentur
Commonmark
coronavirus
Covid-19
Deutsche
e.g.
en_US
Gesundheitsamt
Informationsfreiheit
Infrastrukturen
iOS
Kritische
linter
macOS
Metadata
npm
Probenbegleitschein
pseudonymized
RPIs
SARS-CoV-2
TalkBack
Telekom
TeleTAN
tl;dr
UI

7
CONTRIBUTING.md
View File

@ -1,5 +1,9 @@
# Contributing
## Build status
![Checks](https://github.com/corona-warn-app/cwa-documentation/workflows/Checks/badge.svg)
## Code of Conduct
All members of the project community must abide by the [Contributor Covenant, version 2.0](CODE_OF_CONDUCT.md).
@ -38,7 +42,8 @@ The following rule governs code contributions:
## Contributing Documentation
You are welcome to contribute documentation to the project.
You are welcome to contribute documentation to the project. Please see the
installation [document](INSTALL.md)
The following rule governs documentation contributions:

163
INSTALL.md Normal file
View File

@ -0,0 +1,163 @@
# Development on documentation
## tl;dr
**You will need to use following `make targets` before creating a pull request!**
1. `make install`
2. `make check`
## Features
* Linting of markdown documents
* Spell checking
* Link checking
## Specifications
This repository checks against following specification:
* [Markdown Commonmark](https://spec.commonmark.org/)
### Languages
Supported languages are:
* [English US](https://en.wikipedia.org/wiki/ISO/IEC_8859-1)
## Prerequisites
To run all the linters please install for your OS:
* [npm](https://github.com/nodesource/distributions)
## Installation
For linting and all the checks you need several npm packages. The following
command installs all necessary npm dependencies:
```shell
make install
```
This installs all dependencies into a local `node_modules` folder. `Make` adds
this to your execution path automatically. If you install the modules somewhere
else please make sure this folder is in your execution path. On macOS or Linux
you probably need to export your Path like this:
```shell
export PATH=my/path/to/node_modules/.bin:$PATH
```
## Checks
To enforce good spelling and specification conformity there are several checks
as `Makefile` targets defined. To run all checks please execute:
```shell
make check
```
As an alternative to make it is possible to utilize *npm-run-all* for testing:
```shell
npm run-script test
```
### Individual checks
If you want to run individual checks see the targets and the description below.
There are always Makefile targets. If you prefer npm for testing you can run
every individual check like so:
```shell
npm runscript my-individual-check
```
See the package-json file for help.
#### Markdown linter
Markdown linting. See the rules [here](https://github.com/DavidAnson/markdownlint).
```shell
make markdownlint
```
##### Overrides
Sometimes it is not possible to be commonmark conform. In this
rare cases an inline tag to skip linting is possible.
Candidates are tables.
```html
<!-- markdownlint-disable-->
| Column 1 | Column 2 | Column 3 |
|----------|----------|----------|
<!-- markdownlint-enable-->
```
Additionally html image tags can be allowed globally. This is useful if you need
to resize images, since commonmark has no annotation for this.
This is done with a .markdownlint.json override file which would look something
like this:
```json
{
"no-inline-html": {
"allowed_elements": [
"img",
"table"
]
}
}
```
For more information how to tweak overrides consult the markdown linter
documentation mentioned above.
#### Spell checker
##### English
Spell checking in American English (en_US).
```shell
make spellcheck-en
```
##### German
Not implemented yet.
##### Overrides
Add any additional words to the .spelling file and use the make target to sort
and clean them before adding these to master.
```shell
make format-spelling
```
Please note sometimes overriding is not the way to go. For example there may be
three ways for the word TeleTan (TeleTAN, teleTAN) in this repository. The
documents should stick to one variation.
#### Link resolver
All cross references and external URLs are resolved.
```shell
make checklinks
```
#### Inconsiderate language scanner
This checks against profanity and inconsiderate language. This is help full for
non-natives to detect words that could be inconsiderate. This utilizes
[alex](https://github.com/get-alex/alex)
```shell
make detect-inconsiderate-language
```

34
Makefile Normal file
View File

@ -0,0 +1,34 @@
.PHONY: all install check markdownlint clean checklinks spellcheck-en spellcheck detect-inconsiderate-language
SHELL := /bin/bash
export PATH := ./node_modules/.bin:$(PATH)
install:
# https://stackoverflow.com/a/56254478
npm ci
check: markdownlint checklinks spellcheck format-spelling detect-inconsiderate-language
spellcheck: spellcheck-en
spellcheck-en:
mdspell '**/*.md' --en-us -t -n -a --report \
'!**/node_modules/**/*.md' \
'!**/.github/**/*.md' \
'!**/translations/**/*.md'
markdownlint:
markdownlint '**/*.md' --ignore node_modules
checklinks:
# https://github.com/tcort/markdown-link-check/issues/57
find . -not -path "*node_modules*" -not -path "*.github*" -name \*.md | \
xargs -n 1 markdown-link-check
detect-inconsiderate-language:
alex
format-spelling:
sort < .spelling | sort | uniq | tee .spelling.tmp > /dev/null && mv .spelling.tmp .spelling
clean:
rm -rf node_modules

3626
package-lock.json generated Normal file
View File

File diff suppressed because it is too large Load Diff

32
package.json Normal file
View File

@ -0,0 +1,32 @@
{
"name": "docs",
"version": "1.0.0",
"description": "A central repository for documentation",
"main": "README.md",
"dependencies": {
"alex": "^8.1.1",
"markdown-link-check": "^3.8.1",
"markdown-spellcheck": "^1.3.1",
"markdownlint": "^0.20.4",
"markdownlint-cli": "^0.23.1",
"npm-run-all": "^4.1.5"
},
"devDependencies": {},
"scripts": {
"test": "run-s markdownlint checklinks spellcheck format-spelling detect-inconsiderate-language",
"spellcheck": "mdspell '**/*.md' --en-us -t -n -a --report '!**/node_modules/**/*.md' '!**/.github/**/*.md' '!**/translations/**/*.md'",
"markdownlint": "markdownlint '**/*.md' --ignore node_modules",
"checklinks": "find . -not -path \"*node_modules*\" -not -path \"*.github*\" -name \"*.md\" | xargs -n 1 markdown-link-check",
"detect-inconsiderate-language": "alex",
"format-spelling": "sort < .spelling | sort | uniq | tee .spelling.tmp > /dev/null && mv .spelling.tmp .spelling"
},
"repository": {
"type": "git",
"url": "git@github.com:corona-warn-app/cwa-documentation.git"
},
"keywords": [
"docs"
],
"author": "Johannes Amorosa",
"license": "Apache 2.0"
}

175
scoping_document.md
View File

@ -1,4 +1,5 @@
# TABLE OF CONTENTS
1. [INTRODUCTION](#introduction)
2. [USER JOURNEY](#user-journey)
1. [Description of Usage Profiles (Stakeholders)](#description-of-usage-profiles-stakeholders)
@ -19,72 +20,147 @@
NOTE: This scoping document is also available [in German](translations/scoping_document.de.md).
HINWEIS: Dieses Scoping-Dokument ist ebenfalls [auf Deutsch](translations/scoping_document.de.md) verfügbar.
HINWEIS: Dieses Scoping-Dokument ist ebenfalls [auf Deutsch](translations/scoping_document.de.md)
verfügbar.
# INTRODUCTION
The aim of the Corona-Warn-App is to identify SARS-CoV-2 chains of infection as quickly as possible and to break them. It does this by rapidly and reliably notifying people that they have had contact with infected persons and therefore may have been exposed to the virus. These individuals can then self-isolate, to help stop the SARS-CoV-2 pandemic.
## INTRODUCTION
This document describes the functional requirements of the app’s design from a technical and process-based perspective. This version of the scope document describes the first release and an initial version of the app only.
The aim of the Corona-Warn-App is to identify SARS-CoV-2 chains of infection as
quickly as possible and to break them. It does this by rapidly and reliably
notifying people that they have had contact with infected persons and therefore
may have been exposed to the virus. These individuals can then self-isolate, to
help stop the SARS-CoV-2 pandemic.
The overall planning also foresees publishing other development documents, to solicit feedback from an early stage for potential incorporation in the project. The release architecture document and back-end alpha source code will be made available subsequently.
This document describes the functional requirements of the app’s design from a
technical and process-based perspective. This version of the scope document
describes the first release and an initial version of the app only.
The requirements have been defined and outlined according to a person-centric methodology. This means the entire process flow is designed from the perspective of the people who use the app and the other stakeholders involved in the process. The aim is to map the needs of all stakeholders in such a way that it promotes a high degree of acceptance and makes the respective functions intuitive to use.
The overall planning also foresees publishing other development documents, to
solicit feedback from an early stage for potential incorporation in the project.
The release architecture document and back-end alpha source code will be made
available subsequently.
The interaction points and user experience are mapped based on a user journey. The resulting requirements are assigned to “epics”, or descriptions of the requirements at a high level of abstraction. These epics describe the individual contact points and general functions throughout the process that are required for usage and acceptance of the app. In turn, the epics are used to derive the detailed requirements in the form of user stories (software requirements formulated in everyday language). Through this approach, the individual requirements are structured as they are incorporated in the development process.
The requirements have been defined and outlined according to a person-centric
methodology. This means the entire process flow is designed from the perspective
of the people who use the app and the other stakeholders involved in the
process. The aim is to map the needs of all stakeholders in such a way that it
promotes a high degree of acceptance and makes the respective functions
intuitive to use.
# USER JOURNEY
The interaction points and user experience are mapped based on a user journey.
The resulting requirements are assigned to “epics”, or descriptions of the
requirements at a high level of abstraction. These epics describe the
individual contact points and general functions throughout the process that are
required for usage and acceptance of the app. In turn, the epics are used to
derive the detailed requirements in the form of user stories (software
requirements formulated in everyday language). Through this approach, the
individual requirements are structured as they are incorporated in the
development process.
## Description of Usage Profiles (Stakeholders)
The following key usage profiles and stakeholders are integrated in the user journey, or overall process, and described in their roles:
## USER JOURNEY
### Description of Usage Profiles (Stakeholders)
The following key usage profiles and stakeholders are integrated in the user
journey, or overall process, and described in their roles:
#### App User
All persons who use the app: Are notified of potential exposure to infected persons, verify their own test results, and then warn all the people they have encountered – voluntarily and under a pseudonym.
All persons who use the app: Are notified of potential exposure to infected
persons, verify their own test results, and then warn all the people they have
encountered – voluntarily and under a pseudonym.
#### Hotlines
Provide support to persons who use the app by in answering questions about how to use the app, the technology, and data privacy. If asked, they provide information on proper conduct and where to get further information in case of contact or infection.
Help verify and release test results in the app for infected individuals and can recommend that they contact their health department.
Provide support to persons who use the app by in answering questions about how
to use the app, the technology, and data privacy. If asked, they provide
information on proper conduct and where to get further information in case of
contact or infection.
Help verify and release test results in the app for infected individuals and can
recommend that they contact their health department.
#### Robert Koch Institute (RKI)
Provides epidemiological information and recommendations for using the app (content). Determines the parameters used to measure the number of contacts (to the extent of the API’s technical capabilities).
## User Journey
App usage is divided into different phases, based on contact points and interactions between people that occur successively. In each phase, persons are assigned motivations or requirements that meet their expectations of the app and guide them intuitively through the process.
Provides epidemiological information and recommendations for using the app
(content). Determines the parameters used to measure the number of contacts
(to the extent of the API’s technical capabilities).
### User Journey
App usage is divided into different phases, based on contact points and
interactions between people that occur successively. In each phase, persons are
assigned motivations or requirements that meet their expectations of the app and
guide them intuitively through the process.
![Figure 1: User Journey](user_journey.png "User Journey")
#### *Idea* phase
In this phase, a person decides to get more information about the app. In this phase, persons may have different questions regarding usage of the app (application, data privacy, accessibility, and so on). It should be possible to have these questions answered before downloading the app (hotline, information on the websites of the RKI and Federal Ministry of Health (BMG), App Store/Google Play Store).
In this phase, a person decides to get more information about the app. In this
phase, persons may have different questions regarding usage of the app
(application, data privacy, accessibility, and so on). It should be possible to
have these questions answered before downloading the app (hotline, information
on the websites of the RKI and Federal Ministry of Health (BMG), App
Store/Google Play Store).
#### *Installation* phase
A person decides to download the app (App Store/Google Play Store) and, after the technical installation process, is given an introduction to the app the first time it is opened. In this introductory phase, app users are given an overview of the functionality, terms of use, and privacy provisions; are asked for the necessary consent; and guided through the notification and other settings.
A person decides to download the app (App Store/Google Play Store) and, after
the technical installation process, is given an introduction to the app the
first time it is opened. In this introductory phase, app users are given an
overview of the functionality, terms of use, and privacy provisions; are asked
for the necessary consent; and guided through the notification and other
settings.
#### *Usage* phase
The usage phase is subdivided into four further areas, in which people who use the app have different needs.
The usage phase is subdivided into four further areas, in which people who use
the app have different needs.
1. **Background**
In idle mode, the application runs in the background on the smartphone and saves the pseudo IDs of other nearby app users, automatically and encrypted. At regular intervals, the app pulls from the server a list of pseudo IDs of the persons who have voluntarily reported that they are infected. The app compares their pseudo IDs with those stored on the smartphone to determine whether there has been any exposure.
In idle mode, the application runs in the background on the smartphone and
saves the pseudo IDs of other nearby app users, automatically and encrypted.
At regular intervals, the app pulls from the server a list of pseudo IDs of
the persons who have voluntarily reported that they are infected. The app
compares their pseudo IDs with those stored on the smartphone to determine
whether there has been any exposure.
2. **Exposure**
If exposure to infected persons is determined, app user receives a notification and recommendations on what to do. For instance, that they should contact a medical professional or their responsible health department, and whether they should self-isolate.
If exposure to infected persons is determined, app user receives a
notification and recommendations on what to do. For instance, that they
should contact a medical professional or their responsible health department,
and whether they should self-isolate.
3. **Testing**
If an app user is tested for a SARS-CoV-2 infection, they can start the digital test information process in the app, which notifies them of their test result.
If an app user is tested for a SARS-CoV-2 infection, they can start the
digital test information process in the app, which notifies them of their
test result.
4. **Infection case**
If an app user tests positive for SARS-COV-2 infection, they can voluntarily publish the pseudonymized warn IDs saved in their app. That way, other app users can use their smartphones to find out whether they have been exposed to the infected user.
If an app user tests positive for SARS-COV-2 infection, they can voluntarily
publish the pseudonymized warn IDs saved in their app. That way, other app
users can use their smartphones to find out whether they have been exposed
to the infected user.
#### *Uninstallation* phase
A person can uninstall the app at any time, completely deleting all the data stored in it.
# FUNCTIONAL DESCRIPTION
A person can uninstall the app at any time, completely deleting all the data
stored in it.
## Overview of Epics
The app functions are divided into user process phases (with direct ties to the user journey) and general support processes. An overview of the epics is depicted below:
## FUNCTIONAL DESCRIPTION
### Overview of Epics
The app functions are divided into user process phases (with direct ties to
the user journey) and general support processes. An overview of the epics is
depicted below:
#### Process Phases of Use
<!-- markdownlint-disable -->
| # | Epic | Description |
|---:|--------|--------------|
| 1 | Onboarding and Installation | All processes that take place the first time the app is used (such as consent, data privacy, language selection) |
@ -93,23 +169,30 @@ The app functions are divided into user process phases (with direct ties to the
| 4 | Exposure (Contact with an Infected Person) | All functions associated with contact points (such as notifications, recommended actions) |
| 5 | Notification of Covid-19 Test Results | Functions related to the notification of test results |
| 6 | Warning trigger | Process to trigger a warning if a test result is positive |
<!-- markdownlint-enable-->
#### Support processes
<!-- markdownlint-disable -->
| # | Epic | Description |
|---:|--------|--------------|
| 7 | Parameter Settings | Parameters for contact point definition |
| 8 | Technical Support | Support processes (such as hotlines) |
| 9 | Accessibility | Apps from public authorities must be accessible, pursuant to the German Act on Equal Opportunities for Persons with Disabilities (BGG, section 12). Apps should be usable by all persons with disabilities. |
| 10 | Content Management | To adjust and update content in the app (texts, links, hotlines, and so on) |
<!-- markdownlint-enable-->
## Overview of User Stories
The requirements the Corona-Warn-App must satisfy, and which define its functional scope, are formulated below in the usual format of a user story, unless specified otherwise:
_“As &lt;stakeholder&gt;, I want &lt;goal&gt;, so that &lt;reason&gt;.“_
The requirements the Corona-Warn-App must satisfy, and which define its
functional scope, are formulated below in the usual format of a user story,
unless specified otherwise:
The corresponding acceptance criteria supplement the specification of the requirements by defining the conditions that the software must fulfill to satisfy user needs..
“As &lt;stakeholder&gt;, I want &lt;goal&gt;, so that &lt;reason&gt;.“_
The corresponding acceptance criteria supplement the specification of the
requirements by defining the conditions that the software must fulfill to
satisfy user needs..
### Onboarding and Installation
<!-- markdownlint-disable-->
| # of user story ID | User story | Acceptance criteria |
|-----------------|------------|--------------------|
| E01.01 | As an app user, the first time I launch the app, I want to receive an introduction to how it works (app motivation). | 1. An introduction to how the app works is displayed the first time the app is launched.<hr/>2. The introduction to how the app works is not displayed when the app is launched subsequently.<hr/>3. The explanatory content is available to app users in the respective functional areas. |
@ -119,8 +202,9 @@ The corresponding acceptance criteria supplement the specification of the requir
| E01.05 | As an app user, the first time I use the app, I want to be asked whether the application is allowed to send me notifications, so that I can get notifications in a variety of situations. | 1. The app’s notification settings are queried before the app is used for the first time. This enables local notifications. True push notifications from external servers are not supported (APNs/FCM). <hr/>2. The prompt no longer appears after the first time the app is used. |
| E01.06 | As an app user, I want the app to be displayed in my language the first time I use it, so that I can understand how to use the app. | 1. The configured system language is detected.<hr/>2. If the content is not available in the detected system language, English is selected by default.<hr/>3. The first version of the app is expected to be available also in languages other than English. |
| E01.07 | As an app user, I want to see help functions and settings for accessibility during the onboarding process, so that I can use the app. | 1. Accessibility is provided depending on the options available in the respective operating system. |
<!-- markdownlint-enable-->
### Information and Instructions for Using the App
<!-- markdownlint-disable-->
| # of user story ID | User story | Acceptance criteria |
|-----------------|------------|--------------------|
| E02.01 | As an app user, I want to have access to a FAQ list, so that I can find answers to questions I might have about the app. | 1. The app will either contain a link to a web page with FAQs, which is displayed in a browser window, or the web page will be displayed within the app itself. |
@ -129,27 +213,31 @@ The corresponding acceptance criteria supplement the specification of the requir
| E02.04 | As an app user, I want to be able to display publication information for the app, so that I can see who is responsible for development and content of the app. | 1. There is a “Publication information” item in the menu.<hr/>2. The publication information contains the usual information required. |
| E02.05 | As an app user, I want to be able to display the terms of use and data privacy information at any time. | 1. The app provides simple access to the terms of use and data privacy information. |
| E02.06 | As an app user, I want to be able to see various hotlines for technical, privacy-related, health-related, and psychological questions, as well as for verification of test results, so that I can receive further information or answers to my questions. | 1. The app offers access to a technical hotline and a hotline for obtaining a phone TAN.<hr/>2. The times the hotline is available (such as 24/7) is displayed.<hr/>3. Phone numbers can be called directly from the app. |
<!-- markdownlint-enable-->
### Use in the Regular Process
<!-- markdownlint-disable-->
| # of user story ID | User story | Acceptance criteria |
|-----------------|------------|--------------------|
| E03.01 | As an app user, I want to be able to activate and deactivate the app, so that I can switch the functions on and off. | 1. The functions for generating pseudonymized IDs and sending them to nearby devices can be activated and deactivated. <hr/>2. The consequences of activation/deactivation are explained. |
| E03.02 | As an app user, I want to be able to reset to the app to the delivery defaults, so that I can reconfigure it. | 1. The app can be reset to the delivery defaults with a setting option. The saved traces have to be deleted through the system settings. |
| E03.03 | As an app user, I want to be able to adjust the app settings (access permissions, such as notifications) in a menu, so that I can manage the app functions and accesses. | 1. App users can call a menu for app settings. <hr/>2. Notifications can be activated and deactivated.<hr/>3. Access to the functions for generating pseudonymized IDs and sending them to nearby devices can be activated and deactivated.<hr/>4. Before access permissions are deactivated, I receive information as to which app functions will no longer work (in full). |
<!-- markdownlint-enable-->
### Exposure (Contact with an Infected Person)
<!-- markdownlint-disable-->
| # of user story ID | User story | Acceptance criteria |
|-----------------|------------|--------------------|
| E04.01 | As an app user, I want to be notified when a person I have had contact with has reported an infection, so that I can then take the appropriate measures to stop the spread of the virus. | 1. Depending on the notification settings, the app sends a notification to the user.<hr/>2. If the risk assessment for a user changes, a notification informs users that there is news in the app. The actual changed risk assessment is not displayed until the app is opened. |
| E04.02 | As an app user, if I am exposed to the virus, I want to receive instructions from the app, so that I can adapt my behavior to RKI recommendations. | 1. A notification leads the user to the app. The recommendations from the RKI are defined statically in the app. |
<!-- markdownlint-enable-->
### Notification of Covid-19 Test Results
<!-- markdownlint-disable-->
| # of user story ID | User story | Acceptance criteria |
|-----------------|------------|--------------------|
| E05.01 | As the RKI, I want only positive tested users to trigger a one-time warning, so that I can prevent misuse. | 1. Only positive tests can trigger a warning. This is ensured by the verification server and the hotline for the phone TAN procedure.<hr/>2. A warning can only be triggered once for each test. |
| E05.02 | As an app user, in case of a positive test result, I want to receive information about the illness and the necessary next steps, so that I can adapt my behavior to RKI recommendations. | 1. A notification merely informs you that there is news in the app. The test result itself can only be seen in the app. <hr/>2. An info text with defined content is displayed in the app (for example, information about the outcome of the test result, information about necessary measures, a hotline number). |
<!-- markdownlint-enable-->
### Triggering a Warning
<!-- markdownlint-disable-->
| # of user story ID | User story | Acceptance criteria |
|-----------------|------------|--------------------|
| E06.01 | As an app user, I want to be able to scan a QR code provided by a medical professional or test center, so that I can receive my test result in the Corona-Warn-App. | 1. A QR code provided on a flyer from the medical professional or test center can be scanned with the Corona-Warn-App.<hr/>2. An explanatory text is displayed. |
@ -158,25 +246,30 @@ The corresponding acceptance criteria supplement the specification of the requir
| E06.04 | As an app user, I want to be able to use a manual process (in addition to the digital process), for example, through a call center and without a QR code, to send the pseudonymized IDs under which I was visible to other app users in recent days, to the Warn server, so that the people I have been in contact with can be warned by their apps. | 1. The center responsible can generate a TAN and provide it to the person. (The TAN is generated by a server, not the call center itself.) |
| E06.05 | As an app user, I want to be able to enter a TAN in the app, so that I can use the TAN I have been given to assign my test result to my instance of the app. | 1. It is possible to enter a TAN within the app.<hr/>2. The app verifies the entered TAN and provides feedback as to whether it was correct (must be checked whether technically possible). |
| E06.06 | As an app user, after the TAN is verified, I want to share my pseudonymized IDs voluntarily, so that I can warn persons I may have been in contact with. | 1. The IDs can be sent to the Warn server pseudonymized.<hr/>2. Data transmission is only possible if successfully verified beforehand. This is ensured by the verification server and the hotline for the phone TAN procedure.<hr/>3. Data transmission is only possible if the person has granted consent beforehand. |
<!-- markdownlint-enable-->
### Parameter Settings
<!-- markdownlint-disable-->
| # of user story ID | User story | Acceptance criteria |
|-----------------|------------|--------------------|
| E07.01 | As the RKI, I want to be able to configure the parameters (to the extent the API is able to do this) for risk scoring, so that I can keep up with the latest research findings on virus transmission. | 1. Thresholds can be configured dependent on the provided API.<hr/>2. The app receives dynamic configurations from the RKI that can affect how the risk assessment is calculated. |
<!-- markdownlint-enable-->
### Technical Support
<!-- markdownlint-disable-->
| # of user story ID | User story | Acceptance criteria |
|-----------------|------------|--------------------|
| E08.01 | As an app user, I want to be able to contact a hotline, so that I can resolve any technical problems with the app. | 1. The phone number of the technical hotline is stored in the app. |
<!-- markdownlint-enable-->
### Accessibility
<!-- markdownlint-disable-->
| # of user story ID | User story | Acceptance criteria |
|-----------------|------------|--------------------|
| E09.01 | As an app user, I want it to have audio output, so that I can use the app even if I have impaired vision (or am blind), for example. | 1. Accessibility regarding audio output is provided depending on the options available in the respective operating system. |
| E09.02 | As an app user, I want to have good contrast settings, modifiable font sizes, and an easily readable font, so that I can read the texts in the app easily. | 1. Accessibility regarding contrast and font size/type is provided depending on the options available in the respective operating system. |
| E09.03 | As an app user, I want to have the content in simplified language, so that I can easily understand how to use the app and why I should use it. | 1. The texts and languages are defined by the ordering party. |
<!-- markdownlint-enable-->
### Content Management
<!-- markdownlint-disable-->
| # of user story ID | User story | Acceptance criteria |
|-----------------|------------|--------------------|
| E10.01 | As the RKI, I want to manage the app content centrally, so that I can update texts, links, hotlines, and so on once for all the places in the app. | 1. Content management will be carried out based on RKI requirements.<hr/>2. Content will be differentiated by static and dynamic content, in line with technical feasibility.<hr/>3. In the initial version, updates will be performed through an app update. |
<!-- markdownlint-enable-->