Bei der formalen Beschreibung von Mustern sollte man die Reihenfolge und Gliederung der Textlichen Abschnitte immer gleich halten. Im folgenden ein Aufbau einer idealen Gliederung von Überschriften die für die formale Beschreibung von Mustern.
- Titel
- Bild
- Beschreibung – Description
- Problem – Problem description
- Kontext – Context of Use
- Lösung – Solution
- Diagramm
- Abhängigkeiten
- Referenzen, Beispiele – Where Used
- Bemerkungen – Notes
- Web Links & Quellen – Related Weblinks & Sources
- Autor, Coautor
Beschreibung und nähere Erklärung zu den Überschriften
Titel – Title
Der Titel sorgt für eine klare und unmissverständlichen Kommunikation.
Bild
Beschreibung – Description
Problem – Problem description
Das Problem, zu dessen Lösung das Muster eingesetzt werden soll, ist auf-zuführen (ein Kunde möchte ein Produkt suchen, welches seinen Anforde-rungen gerecht wird).
Kontext – Context of Use
Ein Kontext ist erforderlich, wenn ein Problem unter verschiedenartigen Vorbedingungen auftreten kann (der Nutzer kennt das Geschäft und die Art und Weise der Produktsuche noch nicht).
Lösung – Solution
Eine Lösung währe z.B. die Darstellung eines Architektur-, Entwurfs- oder Implementierungs-Vorschlages in bekannter Form. Auch die Angabe von bestimmten Regeln oder Verhaltensweisen für die Umsetzung des Musters kann als Lösung beschrieben werden.
Diagramme – Charts
Abhängigkeiten
Abhängigkeiten zu anderen Mustern sind dann anzugeben, wenn eine Mustersprache aufgestellt wird.
Referenzen, Beispiele – Where Used
Die Angabe einer in diesem Sinne guten Umsetzung gibt dem Entwickler die Möglichkeit, die Verwendbarkeit eines Musters für ein eigenes Projekt abzuschätzen.
Bemerkungen – Notes
Weblinks & Quellen – Related Weblinks
Hier sollten Angaben und Verweise zu Webseiten oder Dokumenten aufgelistet werden.
Autoren, Coautore
Informationen des Autors (Name, Email, Webseite). Auch mehrere Autoren sind möglich.