cwa-documentation
cwa-documentation copied to clipboard
Published
20 hours ago •
corona-warn-app
corona-warn-app
[Overview] Missing/Outdated documentation
Motivation
The purpose of this issue is to list missing and outdated information in the official documents inside this repository. It should provide you with an overview of documents that need to be improved by us.
Small issues can be reported in the comment section of this issue. Missing documentation of core features should be reported as its own issue.
Missing documentation
- https://github.com/corona-warn-app/cwa-documentation/issues/587
- https://github.com/corona-warn-app/cwa-documentation/issues/579
- https://github.com/corona-warn-app/cwa-documentation/issues/417
- https://github.com/corona-warn-app/cwa-documentation/issues/302
Outdated documentation
- https://github.com/corona-warn-app/cwa-documentation/issues/586
- https://github.com/corona-warn-app/cwa-documentation/issues/453
- https://github.com/corona-warn-app/cwa-documentation/issues/496
Corona-Warn-App Open Source Team
| Documentation description | Link | Outdated (my POV)? |
|---|---|---|
| Documentation Repository | ||
| Fraunhofer IIS - API testing | https://github.com/corona-warn-app/cwa-documentation/blob/master/2020_06_24_Corona_API_measurements.pdf | Yes - Fraunhofer did more testing |
| Backend Infrastructure Architecture documentation - Markdown file | https://github.com/corona-warn-app/cwa-documentation/blob/master/backend-infrastructure-architecture.md | No |
| Backend Infrastructure Architecture documentation - PDF | https://github.com/corona-warn-app/cwa-documentation/blob/master/backend-infrastructure-architecture.pdf | Yes - New features were added to the app which require a server (e.g. DCC retrieval) |
| How does the Corona-Warn-App identify an increased risk? | https://github.com/corona-warn-app/cwa-documentation/blob/master/cwa-risk-assessment.md | Yes - see #453 |
| Versioning | https://github.com/corona-warn-app/cwa-documentation/blob/master/cwa-versioning.md | No |
| Event Registration documentation | https://github.com/corona-warn-app/cwa-documentation/blob/master/event_registration.md | No - Not at the moment, has to be updated once on behalf warning has been released |
| Glossary | https://github.com/corona-warn-app/cwa-documentation/blob/master/glossary.md | Yes - Terms are missing (e.g. ENF/ENS, DCC, RAT, etc.) |
| Security Overview | https://github.com/corona-warn-app/cwa-documentation/blob/master/overview-security.md | I'd say Yes - the document says "[…] will be updated regularly.", however, there was no update to this document for over a year now |
| Scoping document | https://github.com/corona-warn-app/cwa-documentation/blob/master/scoping_document.md | I'm not sure about this document |
| Solution architecture | https://github.com/corona-warn-app/cwa-documentation/blob/master/solution_architecture.md | Yes - The document says that "[…] further technical details on the individual components, the security concept, and the data protection concept are provided at a later date." however, these details were never provided since 15 months. |
| Transmission Risk - R Markdown file | https://github.com/corona-warn-app/cwa-documentation/blob/master/transmission_risk.Rmd | I don't feel qualified enough to make any statement about this document |
| Transmission Risk - PDF | https://github.com/corona-warn-app/cwa-documentation/blob/master/transmission_risk.pdf | I don't feel qualified enough to make any statement about this document |
| Transmission Risk - BIB file | https://github.com/corona-warn-app/cwa-documentation/blob/master/transmission_risk_references.bib | I don't feel qualified enough to make any statement about this document |
| Screenshots of the UI | https://github.com/corona-warn-app/cwa-documentation/blob/master/ui_screens.md | Yes - Was already marked as outdated |