Stijlgids

Deze stijlgids legt vast hoe we de Aeyes handleiding schrijven. Eén stem, voorspelbare structuur, heldere communicatie. De gids combineert algemene schrijfprincipes met Nederlandse typografie en projectspecifieke afspraken.

Volg deze regels bij elke nieuwe pagina, en bij elke wijziging in een bestaande.

1. Aanspreekvorm en toon

  • Schrijf in de "je"-vorm. "Klik op …", niet "U klikt op …". Uitzondering: letterlijke citaten uit de UI of e-mailteksten waar Aeyes "u" zegt.

  • Toon: zakelijk-vriendelijk. Geen popi-jopi, geen afstandelijk gemeentejargon.

  • Spreek de lezer rechtstreeks aan. "Je hebt deze gegevens nodig", niet "Men heeft deze gegevens nodig".

  • Vakterm bij eerste gebruik altijd kort uitleggen, daarna mag je hem gebruiken.

2. Korte zinnen, actieve constructies

  • Eén idee per zin. Twijfel? Knip in tweeën.

  • Actief boven passief. "Aeyes verstuurt de e-mail", niet "De e-mail wordt verstuurd door Aeyes".

  • Werkwoorden vooraan in instructies. "Klik op Opslaan." Niet: "Op Opslaan dien je te klikken."

  • Schrap verzwakkers: vrijwel, in principe, eigenlijk, ongeveer, wat, redelijk.

  • Geen uitroeptekens — behalve in letterlijke citaten waar de UI er één toont.

3. Concreet, geen marketing

  • Specifiek boven vaag. "30 tot 45 minuten" — niet "korte tijd".

  • Toon, niet vertel. Beschrijf het resultaat in plaats van een bijwoord. Schrijf "De pagina laadt direct", niet "Razendsnel".

  • Vermijd buzzwords: innovatief, naadloos, synergie, stroomlijnen, optimaliseren, empowerment.

  • Echte getallen. "12 tekens", "8 cijfers", "7 dagen".

  • Geen onnodige bijvoeglijke naamwoorden. "De handleiding" — niet "De uitgebreide, complete handleiding".

4. Nederlandse typografie

4.1 Aanhalingstekens

  • Gebruik krullende dubbele aanhalingstekens "…" voor citaten van UI-tekst, foutmeldingen en e-mailteksten.

  • Krullende enkele aanhalingstekens '…' voor citaten binnen citaten of voor lichte nadruk op een woord.

  • Geen rechte ASCII-quotes ("…") in lopende tekst — alleen in code-blokken en command-line voorbeelden.

  • Cursief in plaats van aanhalingstekens voor titels van paragrafen of voor begrippen die je introduceert.

4.2 Streepjes

Type Teken Wanneer

Koppelteken

-

Verbindt woorden: BIG-nummer, e-mailadres, KvK-nummer, AGB-code.

En-streepje

–

Bereik: maandag–vrijdag, 9:00–17:00, 30–45 minuten.

Gedachtestreepje (em-dash)

—

Pauze in een zin — zoals hier — met non-breaking spaties eromheen.

4.3 Cijfers en getallen

  • Tot en met twaalf voluit: "Aeyes onthoudt je laatste vijf wachtwoorden."

  • Vanaf dertien als cijfer: "13 gebruikers", "100 patiënten".

  • Uitzondering — technische context, maten, tijden, codes: "12 tekens", "8 cijfers", "7 dagen".

  • Geen cijfer aan het begin van een zin. Herschrijf als nodig.

  • Decimalen met komma: 3,5 — niet 3.5.

4.4 Datum, tijd, bedragen

  • Datum in lopende tekst: 7 mei 2026, in juni 2026, niet 07-05-2026.

  • Maanden en dagen klein: mei, maandag.

  • Tijd: 09:00 uur, of in informele context 9 uur 's ochtends.

  • Bedragen: € 5,00 met non-breaking spatie tussen teken en bedrag.

4.5 Afkortingen

  • Voorkeur voor voluit: bijvoorbeeld boven bijv.

  • In tabellen of waar ruimte krap is: bv., enz., o.a.

  • Acroniemen eerste keer voluit + tussen haakjes het acroniem. Daarna mag je het acroniem gebruiken: "Algemene Verordening Gegevensbescherming (AVG)", daarna "AVG".

4.6 Spaties bij leestekens

  • Geen spatie vóór punt, komma, dubbele punt, puntkomma, vraagteken, uitroepteken.

  • Wél spatie erna.

  • Em-dash heeft non-breaking spaties aan beide kanten.

  • Drie puntjes: het echte ellipsis-teken … (één teken), niet drie losse punten.

5. Werkwoordtijden

  • Imperatief voor instructies: "Klik op Opslaan".

  • Tegenwoordige tijd voor systeemgedrag: "Aeyes verstuurt een bevestiging". Niet: "Aeyes zal een bevestiging versturen".

  • Verleden tijd alleen voor history of release-notes: "In v1 was nog geen logo-upload mogelijk".

  • Geen toekomende tijd voor wat het systeem standaard doet.

6. UI-elementen in tekst

Element Markup Voorbeeld

Knoptekst, menu-item

vetgedrukt

Klik op Opslaan.

Veldnaam

vetgedrukt

Vul E-mailadres in.

Foutmelding of UI-citaat

"cursief, krullende quotes"

"Naam is verplicht"

URL-pad of bestandspad

backticks

Ga naar /organization-admin/users.

Toetscombinatie

Ctrl+S

Druk op Ctrl+S.

Vakterm bij introductie

cursief

Beroep versus rol.

Variabele / placeholder

{naam} met escape

Onderwerp: "Wijziging praktijkprofiel — {praktijknaam}"

7. Lijsten

  • Eindstreep: punt aan het einde van elke bullet — tenzij het een enkelwoord-lijst is.

  • Parallelle structuur. Begin elke bullet op dezelfde manier: allemaal werkwoord, allemaal zelfstandig naamwoord, of allemaal volledige zin.

  • Genummerd voor stappen-in-volgorde, bullets voor opsommingen zonder volgorde.

  • Streef naar 3–7 items per lijst. Korter — gebruik geen lijst. Langer — splits in meerdere lijsten of een tabel.

  • Cross-page-link: gebruik xref:doelpagina.adoc[Linktekst]. De linktekst is een betekenisvol fragment, niet "klik hier".

  • Externe link: volledige URL met betekenisvolle linktekst.

  • In-page-anker: liever niet. Schrijf "zie sectie 2 hierboven" — robuuster bij herstructurering.

9. Privacy en voorbeelden

  • Geen echte patiënt-, gebruiker- of praktijkgegevens. Alle namen, adressen, BSN’s, postcodes en telefoonnummers in voorbeelden zijn fictief.

  • Plaatsaanduidingen voor variabelen: {praktijknaam}, {e-mailadres}. Escape de eerste accolade om AsciiDoc-attribuut-substitutie te voorkomen.

10. Pagina-template

Elk taakgericht hoofdstuk heeft deze opbouw, in deze volgorde:

  1. Doel — wat ga je bereiken (één bullet-lijst).

  2. Vereisten — wat moet er al zijn ingericht.

  3. Genummerde stappen. Eén actie per stap. Schermafbeelding waar dat de stap concreet maakt.

  4. Optionele sub-secties (validatie-regels, varianten, randgevallen).

  5. Veelvoorkomende vragen of problemen — Q&A-tabel.

  6. Volgende stap — link naar het volgende hoofdstuk in de slice.

Zie Eerste keer inloggen als canoniek voorbeeld.

11. Checklist voor je pagina klaar is

Check Vraag aan jezelf

Zinslengte

Past elke zin in twee regels?

Verzwakkers

Heb je vrijwel, eigenlijk, wat uit alle zinnen verwijderd?

Buzzwords

Geen innovatief, naadloos, stroomlijnen, optimaliseren?

Hoofdletters

Geen onnodige Engelse Title Case in headings of buttons?

Aanhalingstekens

Krullend, niet recht?

Streepjes

Em-dash met non-breaking spaties? Koppelteken vs en-streepje correct?

UI-tekst

Verbatim uit het scherm, cursief tussen krullende aanhalingstekens?

Stappen

Imperatief, één actie per stap, werkwoord vooraan?

Lijsten

Parallelle structuur, 3–7 items, punt aan eind?

Specificiteit

Echte getallen en limieten in plaats van vage termen?

Privacy

Alle voorbeeldgegevens fictief?