Skip to content
This repository was archived by the owner on May 10, 2023. It is now read-only.

Commit 80e03f9

Browse files
author
David Hund
authored
Fix README text and formatting (#441)
* Unify Markdown formatting * Textual changes - Change initial 'Goals of the website' heading to 'Status' - Remove old (duplicate) 'Thank You + Requirements' section
1 parent 0133bf1 commit 80e03f9

1 file changed

Lines changed: 16 additions & 28 deletions

File tree

README.md

Lines changed: 16 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,14 @@
1-
About
2-
---------------------
1+
## About
32

43
This repository contains the source files of the official website for the Dutch COVID-19 Notification App CoronaMelder and is available at [coronamelder.nl](https://coronamelder.nl)
54

65

7-
Goals of the website
8-
---------------------
6+
## Status
7+
98
Please join the Slack channel and check out the kanban board for the latest status.
109

11-
Goals of the website:
12-
---------------------
10+
11+
## Goals of the website:
1312

1413
Before the app is finished, the main goal is to **inform** visitors:
1514
* Goal 1: Provide a clear overview of which areas the team is working on / what the project status is.
@@ -26,8 +25,8 @@ After the app is finished:
2625

2726
* **Goal after finished: Convince** people to download the app
2827

29-
Design principles
30-
-----------------
28+
29+
## Design principles
3130

3231
* Design principle 1: Clarity and usability over eye candy
3332
* Design principle 2: Test the results on the target group, guerilla testing in the supermarket, etc.
@@ -36,8 +35,9 @@ Design principles
3635
* Design principle 5: Confirm to the design principles of[ ](https://www.gebruikercentraal.nl/)[Gebruiker](https://www.gebruikercentraal.nl/)[ ](https://www.gebruikercentraal.nl/)[Centraal](https://www.gebruikercentraal.nl/).
3736
* Design principle 6: The website 'feels' just like the app itself (tone of voice ("je", not "u"), graphics, interaction patterns, UX design, use, etc.)
3837

39-
Features, requirements and standards
40-
------------------------------------
38+
39+
## Features, requirements and standards
40+
4141
**Preamble:** the intended quality of the website is very high (10/10), as this will impact the number of downloads both directly (defined as a high click-through rate to the app stores) and indirectly (influencing public opinion, by taking away common misconceptions etc.).
4242
* Requirement 1: Adhering to **WCAG accessibility standards** as specified in the [Accessibility document](https://github.com/minvws/nl-covid19-notification-app-coordination/blob/master/accessibility/Toegankelijkheid.md) of the app itself.
4343
* Requirement 2: **Download button should be easily added after launch of the app.**
@@ -57,28 +57,14 @@ Features, requirements and standards
5757

5858
The hosting requirements are defined elsewhere.
5959

60-
How this website came about (pinging journalists)
61-
------------------------------------
62-
There is a nice story to be told about how the website was created. It all started with a high-level traffic light dashboard idea to indicate the status of the project. This idea was adopted by the community, that let this project evolve (via Github and Slack) from the traffic dashboard to what is now the project website-to-be. The whole process can be followed via [Channel notificatie-app-website](https://app.slack.com/client/T68FXPFQV/C0151NCG140) ([join Slack workspace here](https://doemee.codefor.nl/)).
63-
Please ping any of the people involved via Slack if you are interested in writing an article about this.
6460

65-
## Honorable mentions and gratitude
66-
Shout out to all volunteers that helped out, among which: Harrie Kuipers (project lead), Paul Wagener (initial HTML implementation), Benjamin W. Broersma (tech lead, HTML implementation of the version 0.6 design, translatable templates via markdown), Anouschka Scholten (UX research questionnaire among 500+ people and interaction design feedback website), Arian van van Putten (helped out with Github issues and useful comments) and Bart Lenstra (designs in Figma). Also involved were Laura Engelshove, Cas Zeegers, Nelleke Harmse, Ruben Vandenbussche, Ruben Ahuluheluw, Joost Soeterbroek.
67-
68-
The main objective of coronamelder.nl is to activate Dutch citizens to download and use CoronaMelder to reduce COVID-19 infections. Therefore, the site meets the information needs of visitors. Mainly:
69-
70-
- Explain why the app is needed, what the app does and how CoronaMelder works
71-
- Give answers to frequently asked questions about CoronaMelder and debunk misconceptions
72-
- Provide the current privacy statement, accessibility statement, colophon and version information of CoronaMelder
73-
- Refer to the iOS App Store and Android Google Play Store to install CoronaMelder on a smartphone
74-
- Offer contact channels for other questions about CoronaMelder
75-
76-
See also the [Requirements and design principles](https://github.com/minvws/nl-covid19-notification-app-website/blob/master/README.requirements.md) for the website.
61+
## How this website came about (pinging journalists)
7762

63+
There is a nice story to be told about how the website was created. It all started with a high-level traffic light dashboard idea to indicate the status of the project. This idea was adopted by the community, that let this project evolve (via Github and Slack) from the traffic dashboard to what is now the project website-to-be. The whole process can be followed via [Channel notificatie-app-website](https://app.slack.com/client/T68FXPFQV/C0151NCG140) ([join Slack workspace here](https://doemee.codefor.nl/)).
64+
Please ping any of the people involved via Slack if you are interested in writing an article about this.
7865

7966

80-
Disclaimer
81-
-----------
67+
## Disclaimer
8268

8369
The design and development of the website started as a volunteering project [in the community](https://minvws.github.io/nl-covid19-notification-app-community-website/). The Ministry of Health, Welfare and Sport has built the current website on the foundation created by community members.
8470

@@ -91,7 +77,9 @@ Shout out to all volunteers that helped out, among which: Harrie Kuipers (projec
9177

9278
Harrie, Bart, Cas and Laura have later been asked to finish the project on a paid basis.
9379

80+
9481
## Development & Contribution process
82+
9583
Note: rather than rely on a third party CDN or dependencies that are not part of this repository; all assets and dependencies are part of this build. Please go to [the vendor licenses directory](./vendor-licenses) for the vendor licenses.
9684

9785
The development team works directly from this open-source repository. If you plan to propose changes, we recommend opening an issue beforehand where we can discuss your planned changes. This increases the chance that we’re able to use your contribution (or it avoids doing work if there are reasons why we wouldn't be able to use it).

0 commit comments

Comments
 (0)