Anhang B: Screenshots von der Dokumentation von OSEFA

Auf den folgenden Seiten stelle ich einige Screenshots der Nachdokumentation von OSEFA vor, die mit der implementierten Werkzeugumgebung erstellt wurde. Mit den jeweils rot markierten Links kommt man zur nächsten dargestellten Seite.

Dies ist die Eingangsseite der Dokumentation von OSEFA. Von hier aus gelangt man zu allen Teilen der Dokumentation. Der rot markierte Link führt zu der Dokumentation des Entwurfs.

OSEFA-Dokumentation 1: Der Einstieg

Dies ist die erste Seite der Designdokumentation von OSEFA. Hier ist rechts der Aufbau der Dokumentation erklärt. Die Links zu den möglichen Einstiegen in das Design sind links. Mit dem rot markierten Link gelangt man zu den Klassendiagrammen

. OSEFA-Dokumentation 2: Die Design-Dokumentation

Hier ist das erste Klassendiagramm von OSEFA. Der Bildschirm ist in die Bereiche Kopf, Inhaltsverzeichnis, Navigationsleiste und Rumpf unterteilt. Das Diagramm im Rumpf bietet einen Überblick über die wesentlichen Klassen des Frameworks. Hier sind auch die Entwurfsmuster und Hot Spots entsprechend markiert. Zusätzlich ist hier auch der Bereich eingezeichnet, der durch ein weiteres Diagramm genauer spezifiziert wird. Zu diesem Diagramm gelangt man über einen der zwei markierten Links im Klassendiagramm bzw. dem Inhaltsverzeichnis.

OSEFA-Dokumentation 3: Das Überblicks-Klassendiagramm

Dies ist ein weiteres Klassendiagramm von OSEFA. In diesem Diagramm sind einige Klassen aus dem Überblicksdiagramm. Hier sind weitere Klassen hinzugekommen, die das Zusammenwirken der Klassen weiter erklären. Über einen der rot markierten Links kommt man zu einem Hot Spot.

OSEFA-Dokumentation 4: Ein Verfeinerungsdiagramm

Hier wird ein Hot Spot erklärt. Der äußere Rahmen vom Klassendiagramm ist erhalten geblieben. Nur der gelbe Bereich dient zur Beschreibung des Hot Spots. In diesem Bereich ist wieder die Unterteilung in Kopf, Inhaltsverzeichnis, Navigationsleiste und Rumpf vorhanden. Der Text im Rumpf ist in kleinere Abschnitte unterteilt, die man von dem Inhaltsverzeichnis direkt anspringen kann. Da der Hot Spot durch ein Entwurfsmuster implementiert wurde, ist in der Navigationsleiste ein Link, mit dem man zu diesem Entwurfsmuster gelangt.

OSEFA-Dokumentation 5: Ein Hot Spot

Hier ist Beschreibung eines Entwurfsmusters im 3. Schritt der Entwicklung, d.h. hier ist die Anpassung an die Klassen des Problembereichs vollzogen und evtl. nötige neue Klassen wurden hinzugefügt. Hier wird der Abschnitt "Participants" angezeigt, weil in diesem Abschnitt der Unterschied in den Texten zum nächsten Schritt am größten ist. Zum nächsten Schritt in der Entwicklung des Entwurfmusters kommt man mit dem rot markierten Link. OSEFA-Dokumentation 6: Ein Entwurfmuster (3. Schritt)

Hier ist ein Beschreibung eines Entwurfsmuster nach dem 4. Schritt. Hier sind nun die technischen Klassen in das Entwurfsmuster aufgenommen worden. Dadurch haben sich im Abschnitt "Participants" die Beziehungen zwischen den Klassen etwas verändert. Dies wird durch die Farben verdeutlicht (grau = keine Änderung, rot = bestehender Text wurde verändert, schwarz = neuer zusätzlicher Text). Mit dem rot markierten Link kommt man zur Beschreibung einer Klasse des Entwurfsmusters.

OSEFA-Dokumentation 7: Ein Entwurfsmuster (4. Schritt)

Hier ist die Beschreibung einer Klasse. Hier ist ein zusätzlicher Frame vorhanden, der zwischen dem Rumpf und dem Navigationsframe liegt. Dieser Frame nimmt die Beziehungen zu anderen Klassen auf. In dem Inhaltsframe sind nun die Links zu den Methoden und den Attributen. Über den rot markierten Link dort kommt man zu Beschreibung der Methode StrategyCollection.

OSEFA-Dokumentation 8: Eine Klasse

Hier ist die Beschreibung einer Methode. Bei dieser Darstellung sieht man gut die c³-Struktur mit allen Ebenen des Entwurfes: Klassendiagramme (rosa), Entwurfsmuster (gelb), Klassen (grün) und Methoden (türkis).

OSEFA-Dokumentation 9: Eine Methode



© Technische Informatik