Ga naar hoofdinhoud

Schrijfwijzer

Gebruik deze Schrijfwijzer om goede teksten te maken voor de NL Design System community, wanneer je werkt in opdracht van het project. Dit geldt voor communicatie via e-mails, brieven, teksten op de website, social media, chats, e-mails, posters, folders of presentaties. Maar ook online in de programma's of tools waar we mee werken, zoals in Figma, Miro, Slack en GitHub.

Schrijfstijl

Eerst de essentie

Zorg dat je belangrijkste boodschap vindbaar is aan het begin van alinea's en in de kopjes. Dat is handig omdat mensen tekst scannen in een F-patroon: de kopjes en het begin van teksten.

Vraag om actie

Maak het makkelijk voor mensen om de actie te onthouden, want dat is belangrijker dan de toelichting. We gaan ervan uit dat mensen onze teksten lezen terwijl ze ook nog aan andere dingen denken. Als mensen eenmaal het besluit hebben genomen om actie te ondernemen, dan kunnen ze later altijd nog de toelichting opzoeken.

Wees precies

Zeg precies wat je bedoelt. Veel mensen schrijven graag teksten met understatement, eufemisme, ironie, sarcasme, beeldspraak, uitdrukkingen en spreekwoorden. Dat is prima in chatgesprekken, maar doe dit niet in de documentatie.

Duidelijke taal

Maak teksten makkelijk te lezen voor onze doelgroep. Dat betekent niet dat we teksten voor B1-leesniveau hoeven te maken, maar wel dat we niet onnodig moeilijke woorden gebruiken. Schrijf je een tekst voor specialisten? Gebruik dan gerust vaktermen.

Bijzinnen en haakjes zijn vaak onnodig

Zorg dat je elke zin in 1 keer kan begrijpen, zonder terug te gaan. Haakjes in de tekst onderbreken een zin. Je kunt beter de extra opmerkingen of verduidelijkingen in de lopende tekst verwerken. Bijvoorbeeld als een extra zin.

Derde persoon

Gebruik niet te vaak ‘wij’, als in ‘wij van NL Design System’. Dit komt over als ‘Wij van WC-eend’. We willen juist graag laten zien dat ‘wij’ niet alle wijsheid in pacht hebben, maar veel kennis en input vanuit de community komt.

Informeel en zakelijk

Gebruik ‘je’ in plaats van ‘u’.

Positief

Kies voor een vriendelijke toon en wees niet belerend. We willen mensen motiveren, niet afwijzen op hun fouten.

Taalgebruik

  • Gebruik begrijpelijke woorden en korte, eenvoudige zinnen.
  • Vermijd dubbele ontkenningen.
  • Schrijf actief en vermijd de lijdende vorm. Actief is bijvoorbeeld: ‘we kunnen snel schakelen’. Lijdend is bijvoorbeeld: ‘er kan snel geschakeld worden’
  • Vermijd tekst tussen haakjes. Gebruik gewoon een nieuwe zin.
  • Vermijd bijzinnen zoveel mogelijk.
  • Begin liever een tweede zin dan onnodig een komma gebruiken.

Afkortingen

Voorleessoftware en vertaalsoftware werken beter als tekst voluit is geschreven. Vermijd de volgende notaties die niet voor iedereen duidelijk zijn.

  • Gebruik geen afkortingen in plaats van lopende tekst.
  • Gebruik geen haakjes tussen woorden, zoals: voorna(a)m(en). Beter is: ‘voornaam (1 of meerdere)’.

Ga er vanuit dat lezers niet bekend zijn met de namen en afkortingen van overheidsorganisaties:

  • Schrijf namen van organisaties de eerste keer voluit. Denk aan Kamer van Koophandel (KVK) of Rijksdienst voor Ondernemend Nederland (RVO). Niet iedereen kent alle bedrijfsafkortingen.

Vraagvorm

Gebruik de vraagvorm niet in documentatie, wees daar stellig en beschrijf de informatie als een regel. Bijvoorbeeld niet:

Is de Checkbox disabled? Gebruik dan het HTML-attribuut disabled.

Wees duidelijk en stellig:

Je moet het HTML-attribuut disabled gebruiken wanneer de Checkbox disabled is.

Gebruik de vraagvorm wel in e-mails, sociale media en chatkanalen, voor afwisseling tussen langere en korte zinnen. Bijvoorbeeld, zonder vraagvorm:

"Wanneer je met openbaar vervoer komt, neem dan de trein of tram naar Station Den Haag Laan van NOI".

Hetzelfde bericht met vraagvorm:

"Kom je met openbaar vervoer? Neem dan de trein of tram naar Station Den Haag Laan van NOI."

Consistent taalgebruik

Wees consistent. Gebruik dezelfde woorden voor dezelfde dingen. Dit draagt ook bij aan voldoen aan WCAG-succescriterium 3.2.4 Consistente identificatie.

Tekstopmaak

Opsommingen

Gebruik voor lijsten en opsommingen de instructies voor goede opsommingen van de gemeente Amsterdam.

Lees meer in de richtlijnen voor toegankelijke opsommingen.

Bij een link moet het direct duidelijk zijn wat er achter de link zit. Gebruik dus geen onduidelijke linktekst als "klik hier" of "deze link". Gebruik sowieso geen ‘hier’ in een link. Duidelijker is bijvoorbeeld "inschrijven voor dit webinar" of "rapport downloaden (pdf)". Omdat je als lezer meteen begrijpt wat zich achter de link bevindt.

Lees meer in de richtlijnen voor toegankelijke linkteksten.

Afbeeldingen

  • Gebruik nooit zomaar afbeeldingen van internet. Krijg je een afbeelding aangeleverd? Check dan of je deze mag gebruiken en of bronvermelding nodig is. Maak je zelf foto's op een evenement of bijeenkomst? Vraag dan altijd toestemming aan de aanwezigen of je de foto mag delen.
  • Gebruik ook geen afbeeldingen met veel tekst erin.
  • Een afbeelding heeft een alt-tekst nodig. In de alt-tekst beschrijf je wat er op de afbeelding staat. Houd afbeeldingen daarom zo simpel mogelijk.

Video

We delen vaak opnames van bijeenkomsten in de community, zodat iedereen op een eigen moment de presentatie kan bekijken. Gebruik hiervoor de YouTube Video component die geen cookies van derden plaatst.

Soms plaatsen we een schermopname in de documentatie, bijvoorbeeld om te laten zien hoe een component of patroon werkt. Overleg met de productmanager voordat je een video publiceert, omdat een video voor documentatie relatief veel werk is om up-to-date te houden.

Ondertitels

Maak altijd ondertitels voor video's die op de website worden gedeeld. Overleg met de projectmanager of de productmanager voordat je video's publiceert, om zeker te weten dat er capaciteit is om ook ondertitels te maken.

Voor video's die het kernteam publiceert is een afspraak met een vaste organisatie die de onderitels toevoegt aan YouTube video's. Aan de opnames van de Heartbeat en de Design Systems Week worden de onderitels automatisch toegevoegd, op initiatief van de ondertitelaar.

Voeg ondertitels toe via een bestandformaat voor ondertitels. Gebruik nooit video's met hardcoded ondertitels.

Deel video's door een link te maken naar de webpagina op onze website waar de video staat, in plaats de link naar YouTube delen. Op deze manier blijven de links werken, als we in de toekomst een andere platform gebruiken voor video.

Meer tips

Wil je meer algemene schrijf- en taaltips? Bekijk dan eens de schrijfwijzer van Toolkit Taal of de uitgebreide schrijfwijzer van de gemeente Amsterdam. En natuurlijk ook onze eigen richtlijnen voor toegankelijke content!