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?

[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.

[jeffreylauwers]

Jeff's kladblok

Ik gebruik deze comment om mijn eigen gedachtes rond foutmeldingen te ordenen en aan te scherpen na feedback.

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?

Minimale foutmelding als het niet mogelijk is om een reden of goed voorbeeld aan te dragen.

'Ingevulde {onderwerp} is niet toegestaan.'

Bijvoorbeeld:

• 'Ingevulde e-mailadres is niet toegestaan.'
• 'Ingevulde KVK-nummer is niet toegestaan.'
• 'Ingevulde voornaam is niet toegestaan.'

Ingevuld maar ongeldig? + Reden

Als het duidelijk is wat er fout is, kunnen we de reden van de foutmelding als opdracht schrijven.

'Vul een geldig {onderwerp} in. {reden}.'

Bijvoorbeeld:

• 'Ingevulde e-mailadres is niet toegestaan. Gebruik geen speciale karakters.'
• 'Ingevulde KVK-nummer is niet toegestaan. Gebruik geen letters.'
• 'Ingevulde voornaam is niet toegestaan. Gebruik geen cijfers.'

Ingevuld maar ongeldig? + Goed voorbeeld

Als de data op een bepaalde manier ingevuld moet worden, en er geen voorbeeld als Form Field Description beschikbaar is, kunnen we een goed voorbeeld tonen.

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

Bijvoorbeeld:

• 'Ingevulde e-mailadres is niet toegestaan. Vul een e-mailadres in, zoals bijvoorbeeld [email protected]'
• 'Ingevulde postcode is niet toegestaan. Vul een nederlandse postcode in, zoals bijvoorbeeld 1234AB'

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 --> 'Het gekozen bestand is te groot.' of 'Het gekozen 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.
• Daarnaast is 'Geldig' misschien niet het juiste woord. Door een te strenge afstemming van validatie kan iets dat wel degelijk geldig is voor iemand als ongeldig worden gezien. En daarmee leg je de schuld bij de gebruiker.
• 'Correct' is geen B1.
• Misschien iets met 'niet toegestaan'?
• Uit een onderzoek met mensen met een beperking en laaggeletterden werden foutmeldingen als duidelijk ervaren. Hierbij werd de zin 'De ingevulde {onderwerp} is niet toegestaan. {aanvulling}'.
• 'De ingevulde...' gaat echter niet op bij e-mailadres of KVK-nummer. Hier zou het 'Het ingevulde...' moeten zijn. Is dit per {onderwerp} in te stellen? Voor nu laat ik 'De/Het' in zijn geheel weg.
• 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 [email protected].

[Rozerinay]

Hi allemaal! Ik heb een Google Spreadsheet opgesteld als poging tot een opzet voor de foutmeldingen die eerder in deze Discussion zijn genoemd. Het bevat een verzameling van de informatie die hierboven al besproken is, aangevuld met concrete voorbeelden van foutmeldingen.

Dit document is bedoeld als een eerste versie, en er staan ook nog foutmeldingen in waarbij keuzes gemaakt moeten worden. Niets is definitief, en ik hoor graag jullie feedback of suggesties om dit verder te verbeteren.

Ik zit eraan te denken om in verschillende sheets binnen de spreadsheet verschillende patronen uit te werken, zodat alles overzichtelijk blijft.

Spreadsheet Schrijfwijze van foutmeldingen

[Rozerinay]

Wil je bijdragen? Laat het me weten, dan voeg ik je toe aan de spreadsheet zodat je bewerkingen kunt doen 😁