Skip to content

Structuur van foutmeldingen in DAQS

Waarom een vaste structuur?

Een goede foutmelding doet drie dingen:

  1. Legt uit wat er fout is
  2. Vertelt hoe het probleem opgelost kan worden
  3. Geeft context waarom de regel bestaat

Om dit consistent te houden gebruikt DAQS een vaste Markdown-structuur voor foutmeldingen.

Deze structuur wordt gebruikt in:

  • DAQS Assist voor Revit
  • rapportages
  • documentatie
  • trainingsmateriaal

Structuur van een foutmelding

Elke foutmelding bestaat uit drie onderdelen.

#### Issue

Beschrijving van het probleem.

#### Oplossing

Concrete stappen om het probleem op te lossen.

#### Uitleg

Extra context over waarom deze regel bestaat.

Issue

De Issue beschrijft wat er fout is in het model.

Richtlijnen:

  • benoem welke parameter of eigenschap het probleem heeft
  • gebruik placeholders zoals {ActualValue} en {ExpectedValue}
  • vermijd uitleg of oplossingen in dit deel

Voorbeeld

Issue

De huidige waarde van parameter NLRS_C_brandwerendheid is {ActualValue}.

Deze waarde komt niet voor in de lijst met toegestane waarden: {ExpectedValue}.

Oplossing

De Oplossing beschrijft hoe het probleem opgelost kan worden.

Richtlijnen:

  • geef concrete stappen
  • verwijs indien nodig naar de juiste parameter of standaard
  • vermijd lange uitleg

Voorbeeld

Oplossing

Open het element in Revit en wijzig de waarde van parameter NLRS_C_brandwerendheid.

Gebruik een waarde uit de toegestane lijst: {ExpectedValue}.

Uitleg

De Uitleg geeft achtergrondinformatie.

Richtlijnen:

  • leg uit waarom de regel bestaat
  • verwijs eventueel naar een standaard of afspraak
  • dit deel is optioneel maar sterk aanbevolen

Voorbeeld

Uitleg

De parameter NLRS_C_brandwerendheid geeft de brandwerendheid van een element aan in minuten.

De toegestane waarden zijn gebaseerd op de Europese norm EN 13501, waarin:

E = vlamdichtheid
I = thermische isolatie

Gebruik van placeholders

Binnen foutmeldingen worden placeholders gebruikt zodat DAQS dynamisch informatie kan invullen.

Placeholder Betekenis
{ActualValue} De huidige waarde in het model
{ExpectedValue} De toegestane waarde of lijst
{name} Naam van het element
{id} Revit element ID

Voorbeeld

De huidige waarde is {ActualValue}, maar moet één van de volgende waarden zijn: {ExpectedValue}.

Slechte vs goede foutmelding

Slecht

Parameter heeft verkeerde waarde.

Problemen:

  • onduidelijk
  • geen oplossing
  • geen context

Goed

Issue

De waarde van parameter NLRS_C_brandwerendheid is {ActualValue}.

Deze waarde komt niet voor in de lijst met toegestane waarden: {ExpectedValue}.

Oplossing

Wijzig de parameter naar een toegestane waarde uit de lijst {ExpectedValue}.

Uitleg

De parameter NLRS_C_brandwerendheid geeft de brandwerendheid van een element aan volgens de Europese norm EN 13501.

Best practices

Gebruik deze richtlijnen bij het schrijven van foutmeldingen:

  • schrijf kort en duidelijk
  • benoem altijd de parameternaam
  • gebruik placeholders in plaats van harde waarden
  • vermijd technische implementatiedetails
  • houd de structuur Issue → Oplossing → Uitleg