Schrijfwijze van foutmeldingen

[jeffreylauwers]

Schrijfwijze van foutmeldingen

Doel

Het zou goed zijn als we tot patronen kunnen komen voor het schrijven van foutmeldingen. In deze Discussie kunnen we daar aan samenwerken.

Gerelateerde componenten

• Form Field Error Message
• Invalid Form Alert

Richtlijnen

Foutmeldingen in een formulier - NL Design System
Onze richtlijnen rondom foutmeldingen in formulieren.

Writing - GOV.UK
Richtlijnen van GOV.UK over het schrijven van foutmeldingen.

Onderzoek

Improve Validation Errors with Adaptive Messages - Baymard Institute
Artikel waarin wordt geadviseerd om de error messages 'op maat' te schrijven.

Eerder deden we een poging om tot een patroon voor foutmeldingen te komen. Dit was voor het prototype van het formulier dat werd gebruikt voor WMEBV. Bekijk de poging in Figma inclusief afwegingen als comments. Deze zijn ingezet bij een onderzoek waarbij we spraken met mensen met een beperking of die minder taalvaardig waren. De resultaten van het onderzoek staan op gebruikersonderzoeken.nl. Zoek daar bijvoorbeeld op 'foutmeldingen'.

Handige Linkjes

Toegankelijke foutmeldingen in formulieren - NL Design System
Artikel door Rian Rietveld waarin ook kort wordt ingegaan op het schrijven van foutmeldingen.

Spreadsheet met foutmeldingen - Logius
Spreadsheet opgezet door Aline Nap voor foutmeldingen bij Logius.

[jeffreylauwers]

Eerste samenkomst

Op 19 december hebben we met de gemeenten Rotterdam, Groningen en Utrecht gezeten om gezamenlijk na te denken over het verbeteren van foutmeldingen. We hebben ideeën en best practices uitgewisseld om foutmeldingen duidelijker en gebruiksvriendelijker te maken.

https://miro.com/app/board/uXjVK_Pu_OY=/?moveToWidget=3458764610269507012&cot=14

Kunnen we toewerken naar een patroon dat herbruikbaar en uitbreidbaar is?

Work in progress

Verplicht veld niet ingevuld?

'Vul een {onderwerp} in.'

Bijvoorbeeld:

• 'Vul een e-mailadres in.'
• 'Vul een KVK-nummer in.'
• 'Vul een voornaam in.'

Ingevuld maar ongeldig?

'Vul een geldig {onderwerp} in.'

Bijvoorbeeld:

• 'Vul een geldig e-mailadres in.'
• 'Vul een geldig KVK-nummer in.'
• 'Vul een geldige voornaam in.'

Ingevuld maar ongeldig? +

'Vul een geldig {onderwerp} in. Bijvoorbeeld {goed voorbeeld}.'

Bijvoorbeeld:

• 'Vul een geldig e-mailadres in. Bijvoorbeeld naam@emailadres.nl'
• 'Vul een geldig KVK-nummer in. Bijvoorbeeld 12345678'

Ingevuld maar ongeldig? ++

'{reden}. Vul een geldig {onderwerp} in. Bijvoorbeeld {goed voorbeeld}.'

Bijvoorbeeld:

• '{reden}. Vul een geldig e-mailadres in. Bijvoorbeeld naam@emailadres.nl'
• '{reden}. Vul een geldig KVK-nummer in. Bijvoorbeeld 12345678'

Patroon per type?

Is het een idee om patronen te maken op basis van type foutmelding?

• Leeg --> Die hebben we al.
• Te lang --> ‘{onderwerp} moet {aantal} tekens of minder zijn.
• Te kort --> ‘{onderwerp} moet {aantal} tekens of meer zijn.
• Gebruik van karakters die niet zijn toegestaan --> '{onderwerp} mag geen {karakter} hebben.
• Verkeerde format

Patroon per uitgevraagde data?

Is het een idee om patronen te maken op basis uitgevraagde data?

• Naam
• E-mailadres
• KVK-nummer
• etc.

Patroon per input type?

Is het een idee om patronen te maken op basis van input type?

• Text Input --> Vul in
• Checkbox Group --> 'Selecteer...' of 'Kies...'
• Radio Group --> 'Selecteer...' of 'Kies...'
• Select --> 'Selecteer...' of 'Kies...'
• File Input --> 'Dit bestand is te groot.' of 'Dit bestandstype is niet toegestaan'.

Notities

• Expres niet 'uw' omdat het niet altijd de gegevens zijn van de persoon die de data invult.
• 'Geldig' zorgt ervoor dat je soms ook 'Geldige' krijgt.
• Is 'Geldig' wel het juiste woord? Misschien iets met 'niet toegestaan'? 'Correct' is geen B1.
• Wanneer het 'goede voorbeeld' al als Form Field Description staat aangegeven, dan niet in de foutmelding herhalen.
• Hoewel een punt aan het eind van de zin verstandig is, zodat schermlezers even een pauze innemen, zou het bij de goede voorbeelden misschien verkeerd kunnen uitpakken? Bijvoorbeeld naam@emailadres.nl.

[JeroenduC]

Liked-subscribed.

Leuk om te kijken of we een set aan veelgebruikte velden kunnen linken aan foutmeldingen + regEx, zodat we daar een standaard in kunnen maken.