ProdukteUModelUML- Projektdokumentation

Dokumentation für ein Software-Projekt zu erstellen und auf aktuellem Stand zu halten, kann mühsam und zeitaufwändig sein. Mit UModel® 2012 können Sie Ihre Produktivität steigern, indem Sie die Dokumentationsdateien automatisch generieren lassen.

Dokumentation bildet einen wichtigen Teil Ihres Software-Entwicklungsprojekts. Sie dient dazu, gemachte Fortschritte festzuhalten, Funktionalitäten für Teammitglieder zu dokumentieren und für spätere Aktualisierungen der Applikation eine Projektskizze bereitzustellen. Durch die automatische Generierung von Dokumentation in den Formaten HTML, Microsoft Word oder Rich Text (RTF) lassen sich diese Aufgaben mit Hilfe von UModel® 2012 schneller erledigen.

Zur Kommunikation innerhalb des Entwicklungsteams bietet UModel® 2012 eine schnelle On-the-Fly-Dokumentationsoption, mit der Projektdiagramme als Bilddateien exportiert werden können. Über eine Option im Projektmenü können Sie jederzeit eine vollständige Projektdokumentation generieren:

UModel UML-Projektdokumentation

Das integrierte Projektdokumentationsdesign von UModel® 2012 bietet dem Benutzer einen hohen Grad an Flexibilität und zahlreiche Möglichkeiten zur Anpassung der Designs. Auf dem Hauptregister des Dialogfelds "Dokumentation generieren" können Sie das Ausgabeformat sowie Bildverarbeitungsoptionen für das vordefinierte UModel Projektdokumentationsdesign auswählen.

Auf dem Register "Inkludieren" stehen zahlreiche Optionen zum Anpassen der Projektdokumentation an Ihre Bedürfnisse zur Verfügung. So können Sie sich während einer frühen Phase der Modellentwicklung auf einen einzigen Diagrammtyp konzentrieren - z.B. auf Zustandsdiagramme oder Sequenzdiagramme, während Sie den Applikationsfluss Schritt für Schritt planen. Später, beim Code Engineering, gilt Ihr Augenmerk vielleicht ausschließlich Klassendiagrammen.

Wenn Sie Ihr Projekt fertig gestellt haben, können Sie mit Hilfe der Schaltflächen "Alle Diagramme auswählen" und "Alle Elemente auswählen" schnell eine komplette Dokumentation zu Ihrem gesamtenProjekt generieren.

Sie können auch den Detailliertheitsgrad der Dokumentation definieren, d.h. welche Informationen für die einzelnen Elemente in der Dokumentation inkludiert werden sollen. Wenn Sie z.B. das Kontrollkästchen für Hierarchiediagramme aktivieren, erhalten Sie einen besseren Überblick über Klassendefinitionen.

UModel® 2012 fügt in allen Ausgabeformaten zur einfachen Navigation im Dokument Links hinzu. Links zu den generierten Quellcodedateien werden auch in die Projektdokumentation inkludiert.

	Zum Vergrößern anklicken

In der HMTL-Dokumentation bilden Hyperlinks, die an Elemente in Ihrem Projektdiagramm angehängt wurden, Links zum entsprechenden Diagramm in der Dokumentation. In der Abbildung unten sehen Sie die Browser-Ansicht eines Hyperlink in einem Paketdiagramm, mit dem das entsprechende Klassendiagramm für das Paket geöffnet wird.

UModel-Projektdokumentation in Textverarbeitungsprogrammformaten enthält ebenfalls Links, über die ein Benutzer schnell Informationen zu einem bestimmten Thema findet.

Bei Auswahl der Option "Index" wird eine Zusammenfassung des Dokuments hinzugefügt, die Links enthält, über die Sie zu den wichtigsten Abschnitten navigieren können.

	Zum Vergrößern anklicken

Mit Hilfe des vordefinierten Dokumentationsdesigns von UModel können Sie auch das Aussehen der Projektdokumentation festlegen und die Schriftart und -größe für jeden einzelnen Textblock definieren.

Stylesheets zur Erstellung individuell gestalteter Projektdokumentation

Wenn Sie noch mehr Anpassungen an Ihrer Dokumentation vornehmen müssen, können Sie mit Hilfe eines mit Altova StyleVision® 2012 erstellten SPS Stylesheets eine komplett benutzerdefinierte Dokumentation für Ihr UML-Projekt generieren.

Die mit UModel mitgelieferten Beispieldateien enthalten u.a. ein fertiges Beispiel-Stylesheet, das Sie entweder unverändert oder als Ausgangsbasis für Ihr eigenes Design verwenden können. Über ein Stylesheet können Sie Bilder wie z.B. Ihr Firmenlogo sowie Kopf- und Fußzeilen oder Textblöcke mit Standardtext in Ihre UML-Projektdokumentation integrieren.

Auf einem Stylesheet basierende Dokumentation kann auch im PDF-Format ausgegeben werden und bietet Unterstützung für alle Optionen, die im UModel-Dialogfeld "Dokumenation generieren" auf den Registern "Inkludieren" und "Details" zur Verfügung stehen. Die Benutzeroberfläche von StyleVision, auf der auch Farbkodierung verwendet wird, enthält Eingabehilfenfenster zum Anzeigen, Bearbeiten und Zuweisen von Stil- und Layout-Eigenschaften der einzelnen Elemente in Ihrem Design.

Stellen Sie Ihre eigenen Software-Entwicklungsprojekte schneller fertig, indem Sie Projektdokumentation mit UModel® 2012 generieren. Downloaden Sie jetzt eine kostenlose 30-Tage-Testversion!