Skip to content

Best Practices

Be explicit

Always state:

  • which parameter
  • which element type
  • what expected value.

Keep error messages actionable

Users must immediately understand:

  • what is wrong
  • how to fix it.

Prefer clear terminology

Use consistent naming:

Revit term Meaning
Family Instance Instance in project
Family Type FamilySymbol
Loadable Family Editable family
System Family Revit system element

Avoid vague language

  • Bad example: The value is incorrect.
  • Good example: The value {{ActualValue}} is not allowed. The value must exist in lookup table NL:SfB_Tabel_1.

Quick Rule Writing Checklist

Before publishing a rule:

✔ Filter selects correct elements ✔ Validation logic is clear ✔ Description follows DAQS template ✔ Error message uses Issue / Solution / Explanation ✔ Placeholders use {{ }} ✔ Notion documentation added ✔ Scope clearly defined ✔ Reason for rule explained