Die Hauptfunktion der IBM Rational SoDA-Integration ist das Abrufen von Informationen
aus den Rational-UML-Modellierungsprodukten und das Verwenden der Informationen
zum Generieren angepasster Dokumente und Berichte mit Microsoft Word. SoDA ist die Abkürzung für
Software Documentation Automation.
SoDA ist
ein flexibles, leistungsfähiges Dokumentationstool, das Ihnen beim Veröffentlichen
von Projektdokumenten durch das Abrufen von Informationen aus den Projekt-Software-Tools
behilflich ist. Sie können vordefinierte UML-Modellierungsproduktschablonen verwenden,
die SoDA für Sie
bereitstellt, oder Sie können eine Ihren Bedürfnissen entsprechende Schablone anpassen.
Vor der Verwendung
der Funktion zur SoDA-Integration
muss IBM Rational SoDA for Word Version 2003.06.14 mit dem SR4-
Hotfix, oder später, installiert sein. Wenn Sie die Installation noch nicht durchgeführt haben,
können Sie unter
http://www.ibm.com/software/awdtools/soda/support/ Informationen zum Erhalt und der Installation einer Kopie abrufen.
Um ein Duplizieren der Funktionalität zu vermeiden, wird die
Generierung aller Dokumente und Berichte virtuell im SoDA-Produkt vorgenommen.
Gehen Sie wie folgt vor, um Rational SoDA for
Word zu verwenden:
- Aktivieren Sie die SoDA-Integrationsfunktion für die allgemeine
Berichterstellung innerhalb des UML-Modellierungsprodukts, indem Sie die
folgenden Schritte durchführen:
Anmerkung: Die SoDA-Integrationsfunktion
ist standardmäßig aktiviert.
- Klicken Sie auf .
- Klicken Sie im Fenster "Benutzervorgaben" auf Allgemeine Berichterstellung.
- Wählen Sie auf der Seite, die auf der rechte Seite geöffnet wird, das Markierungsfeld
SoDA-Integration aktivieren aus.
- Klicken Sie auf Anwenden,
um das Ändern der Benutzervorgaben fortzusetzen, oder klicken Sie auf OK,
um den Speichervorgang auszuführen und das Fenster zu verlassen.
Nach der Aktivierung der SoDA-Integrationsfunktion können Sie
mit der Verwendung des Tools zur Dokumentberichtsgenerierung beginnen. Anmerkung: Um einen SoDA-Bericht erstellen zu können, muss das UML-Modellierungsprodukt
aktiv sein.
- Starten Sie anschließend SoDA, indem Sie auf klicken.
- Klicken Sie im Fenster Getting Started: Introduction
auf Next.
- Im Fenster Select Template werden alle verfügbaren
Schablonen aufgelistet. Blättern Sie so lange nach unten, bis Sie die Liste der Schablonen mit rsa\ finden.
Wählen Sie den Schablonennamen aus, der am besten die Informationen
widerspiegelt, aus denen Sie eine Dokumentation generieren möchten;
klicken Sie anschließend auf Next.
- Das Fenster Save Template wird geöffnet;
darin müssen Sie einen Namen und eine Position zum Speichern
des generierten Dokuments auswählen. Klicken Sie auf Browse,
um einen Namen und eine Position für Ihre Datei auszuwählen, oder geben Sie einfach
einen Pfad und einen Dateinamen ein, und klicken Sie auf Next. Klicken Sie im Fenster
zum Generieren eines Berichts auf Generate,
um die Berichterstellung zu starten.
Microsoft Word wird geöffnet, und es wird der
generierte Bericht angezeigt. Wenn Sie ausführliche Hilfe zur Verwendung von SoDA benötigen, klicken Sie in der Symbolleiste auf , um
die vollständige Onlinehilfe zu SoDA anzuzeigen.