Dokumentation für Musteranwender bereitstellen

Der Musteranwender benötigt Musterdokumentation, um ein geeignetes Muster auszuwählen, das Muster anzuwenden und die Ergebnisse der Anwendung des Musters einzuschätzen. Die Musterautoren stellen verschiedene Arten von Dokumentation bereit, um die Anforderungen der Musteranwender zu erfüllen.

Mit Ausnahme des Übersichtsdiagramms ist die gesamte Dokumentation in zwei Typen von Standardmanifestdateien des RAS-Softwarebausteins enthalten, die entweder die Musterbibliothek oder die Musterstrukturen unterstützen. Manifestdateien enthalten die statischen Daten für das Muster und sind an der Dateierweiterung .rmd (Rational Manifest Documentation) zu erkennen. Einige Manifestdaten werden mit den Mustereigenschaften gemeinsam genutzt (z. B. die Kurzbeschreibung). Teile der gespeicherten Daten werden dem Musteranwender angezeigt, wenn sie für die Mustertask relevant sind.

Um das Suchen von Mustern in Repositorys zu erleichtern, kann der Musterautor mehrere Schlüsselwörter in das Musterdesign einfügen. Zum Bewerten der Suchergebnisse prüft der Musteranwender die Mustermanifestdateien in der Sicht 'RAS-Softwarebausteinexplorer', um das zu importierende Muster auszuwählen. In der Sicht 'Musterexplorer' zeigt eine HTML-Seite mit einer Kurzbeschreibung dem Musteranwender den Typ bzw. Zweck jedes Musters und jedes Parameters an. Eine Übersichtsseite zeigt die Beziehungen zwischen den Hauptkomponenten des Musters auf. Die Onlinehilfe für das Muster erläutert statische Daten wie die UML 2.0-Typen der Parameter und die Gruppen, zu denen die Muster in der Bibliothek zusammengefasst sind. Je nach Komplexität des Musters hat der Musterautor möglicherweise eine einfache oder ausführliche Beschreibung des Musters in die Onlinehilfe eingefügt. Im Diagrammeditor kann der Musteranwender beim Angeben von Argumenten die QuickInfos zu den Parametern im Musterexemplar nutzen, oder das Übersichtsfach öffnen, um das Übersichtsdiagramm einzusehen.

Zugehörige Konzepte
IBM Rational-Entwurfsmuster
Mustercode und Unterstützungsdateien
RAS-Mustersoftwarebausteine
Inhalt des Musterprojekts
Nutzungsbedingungen | Feedback
(C) Copyright IBM Corporation 2004, 2005. Alle Rechte vorbehalten.