Skip to content

DAQS ErrorMessage Style Guide

Versie 1.0 – definitief

Deze style guide beschrijft de verplichte structuur en schrijfregels voor error messages binnen DAQS-analyses. Afwijkingen leiden tot inconsistente foutmeldingen en zijn niet toegestaan.

1. Structuur (verplicht)

Elke error message bestaat altijd uit de volgende secties, in deze volgorde:

#### Issue

<probleembeschrijving>

#### Oplossing

<concrete actie voor de gebruiker>

#### Informatie

<normatieve context en toelichting>
  • Sectietitels zijn exact zoals hierboven
  • Geen extra secties
  • Geen geneste headings

2. Schrijfstijl (principes)

  • Direct en actiegericht
  • Geen technische uitleg die de gebruiker niet nodig heeft
  • Zo min mogelijk klikken: de foutmelding moet zelfstandig begrijpelijk zijn
  • Geen marketingtaal
  • Geen aannames over gebruikerskennis

3. Placeholders (zeer strikt)

3.1 Enkele accolades {}

ALLEEN de volgende placeholders gebruiken enkele accolades:

  • {ActualValue}
  • {ExpectedValue}

❌ Niet uitbreiden ❌ Geen andere placeholders met enkele accolades

3.2 Dubbele accolades {{ }}

ALLE andere dynamische waarden gebruiken altijd dubbele accolades, bijvoorbeeld:

  • {{name}}
  • {{guid}}
  • {{roomPrefix}}
  • {{levelName}}
  • {{parameterName}}

✔ Consistent ✔ Engine-veilig ✔ Toekomstvast

4. Bold (**) – verplichte spatieregel

Regel

Voor en na elk bold element moet exact één spatie staan.

  <spatie>**bold tekst**<spatie>

Let op

  • De spatieregel geldt alleen voor bold
  • Geen uitzonderingen

5. Interpunctie (normaal Nederlands)

  • Punten, komma’s, dubbelepunten:

  • sluiten direct aan op het woord

  • geen spatie vóór het leesteken

Correct

Deze parameter is verplicht.

Fout

Deze parameter is verplicht .

❗ Er gelden geen speciale engine-regels voor interpunctie buiten bold.

6. Taalgebruik

  • Schrijf in correct Nederlands

  • Gebruik consistente termen:

  • Room, Level, Project Base Point, Survey Point

  • Vermijd afkortingen zonder context

  • Gebruik vetgedrukte termen alleen voor:

  • parameters

  • normen
  • sleutelbegrippen

7. Normverwijzingen

  • Verwijs expliciet naar de relevante paragraaf, bijv.:

  • BIM Basis ILS – §4.1 Ruimten

  • Geen vage formuleringen (“volgens de norm”)
  • URLs mogen, maar zijn optioneel

8. Wat niet is toegestaan

  • Extra spaties aan het einde van zinnen
  • Afwijkende placeholder-notatie
  • Technische JSON/IFC/Revit-details in de error message
  • Meerdere issues in één foutmelding
  • Impliciete aannames (“dit hoort zo”)

9. Samenvatting (controlelijst)

Voor elke error message moet gelden:

  • [ ] Juiste structuur (Issue / Oplossing / Informatie)
  • [ ] Alleen {ActualValue} en {ExpectedValue} met enkele accolades
  • [ ] Alle andere placeholders met dubbele accolades
  • [ ] Spatie vóór en na elke **bold**
  • [ ] Normale interpunctie
  • [ ] Actiegericht en zelfstandig begrijpelijk