Documentatie¶
Zib-blauwdrukken dienen op een consistente wijze te worden gedocumenteerd.
ZB-DO.001: Zib-blauwdrukken MOETEN zodanig worden gedocumenteerd dat ze door een competente modelleur op de juiste wijze kunnen worden toegepast bij de ontwikkeling van zibs¶
De kwaliteit van de documentatie dient zodanog te zijn dat een competente modelleur het patroon op de bedoelde wijze toepast.
| Toepasselijke rollen | Eisniveau |
|---|---|
| Zib-ontwerper | MUST |
ZB-DO.002: De documentatie van een zib-blauwdruk MOET een unieke naam voor de blauwdruk bevatten¶
Iedere zib-blauwdruk heeft een unieke naam aan de hand waarvan zij kan worden geïdentificeerd.
| Toepasselijke rollen | Eisniveau |
|---|---|
| Zib-ontwerper | MUST |
ZB-DO.003: De documentatie van een zib-blauwdruk MAG alternatieve namen (aliassen) voor de blauwdruk bevatten¶
Dit betreft een opsomming van eventuele alternatieve namen voor de blauwdruk.
| Toepasselijke rollen | Eisniveau |
|---|---|
| Zib-ontwerper | MAY |
ZB-DO.004: De documentatie van een zib-blauwdruk MOET de intentie van de blauwdruk bevatten¶
Dit betreft een beschrijving van het doel van de blauwdruk en de redenen om de blauwdruk te gebruiken.
| Toepasselijke rollen | Eisniveau |
|---|---|
| Zib-ontwerper | MUST |
ZB-DO.005: De documentatie van een zib-blauwdruk MOET de motivatie voor het patroon bevatten¶
Dit betreft een beschrijving van welk probleem het patroon oplost en waarom daar een patroon voor nodig is.
| Toepasselijke rollen | Eisniveau |
|---|---|
| Zib-ontwerper | MUST |
ZB-DO.006: De documentatie van een zib-blauwdruk MOET de toepasbaarheid van het patroon bevatten¶
Dit betreft een beschrijving van wanneer het patroon dient te worden gebruikt en wanneer niet.
| Toepasselijke rollen | Eisniveau |
|---|---|
| Zib-ontwerper | MUST |
ZB-DO.007: De documentatie van een zib-blauwdruk MOET de eventuele implicaties van het patroon bevatten¶
Dit betreft eventuele nadelen, beperkingen of compromissen bij toepassing van het patroon.
| Toepasselijke rollen | Eisniveau |
|---|---|
| Zib-ontwerper | MUST |
ZB-DO.008: De documentatie van een zib-blauwdruk MOET de structuur van de blauwdruk bevatten¶
Dit betreft een grafische (UML) weergave van het patroon, de entiteiten en relaties tussen entiteiten en een tekstuele beschrijving van entiteiten en relaties.
| Toepasselijke rollen | Eisniveau |
|---|---|
| Zib-ontwerper | MUST |
ZB-DO.009: De documentatie van een zib-blauwdruk MOET richtlijnen voor gebruik en voorbeelden van gebruik bevatten¶
Dit betreft extra aanwijzingen voor de toepassing van de bauwdruk en voorbeelden van toepassing.
| Toepasselijke rollen | Eisniveau |
|---|---|
| Zib-ontwerper | MUST |