Doc-O-Matic
 
Zum Vergrössern anklicken

Im Projekt Manager kann man die Quellcode- und Dokumentationsdateien, Graphik- und Inkludeverzeichnisse, Konfigurationen, Module und Ausgabedateien verwalten. Doc-O-Matic analysiert C++, C++.Net, VB.NET, C#, Delphi, JavaScript, ASP.NET, JSP, MATLAB und Java Sourcedateien und VStudio Solutiondateien, VB.NET, VC++.NET, Makefile, Borland Delphi und Borland C++Builder Projektdateien.

Unterteilen Sie Ihr Projekt in mehrere Module und Doc-O-Matic erzeugt getrennte Hierarchien für jedes Modul. Für jedes Ausgabeformat kann man mehrere Konfigurationen anlegen.

Zum Vergrössern anklicken

Nachdem Ihr Sourcecode analysiert wurde werden alle Namensräume (Packages), Klassen, Mitglieder, Variablen, Enums, Structs, Funktionen und Dateien in einer übersichtlichen Struktur im Contents Manager dargestellt. Verschiedene Icons kennzeichnen Eigenschaften der einzelnen Symbole wie zB Ihren Dokumentationsstatus. Um die Symbole zu ordnen werden automatisch Gliederungsebenen eingefügt. Zusätzliche Gliederungsbenen können für Namensräume, Module und Methoden eingefügt werden und Symbole und Themen können sortiert werden.

Mit Hilfe des visuellen Contents Designers kann die Anordnung der Symbole durch draggen und droppen verändert werden. Mit Hilfe der Kontrollkästchen neben den Symbolen kann jedes Symbol einzeln für jede Ausgabe separat oder generell für alle Ausgaben ausgewählt werden. Es kann bestimmt werden welche Symbole ins Inhaltsverzeichnis aufgenommen werden.

Zum Vergrössern anklicken

Die QA Ansicht (Qualitätskontrolle) identifiziert jene Teile des Dokumentationsprojektes, die spärlich dokumentiert sind. Diese Ansicht vermittelt schnell einen Eindruck davon, wie gut die aktuelle Dokumentation ist, unabhängig davon, wie groß das Projekt ist. Sie können bestimmen, welche Kriterien für eine positive Qualitätskontrolle erfüllt sein müssen. Dokumentieren Sie Ihren Quellcode, fügen Sie zusätzliche Informationen hinzu und schreiben Sie Ihre Online Hilfe und Handbücher im integrierten Editor mit Hilfe der QuickDoc und AutoDoc Features.

Zum Vergrössern anklicken

Im Editor werden die bereits existierenden Kommentare, die aus dem Sourcecode extrahiert wurden dargestellt. Doc-O-Matic versteht und interpretiert: Kommentare im Textformat (keine Tags für Tabellen, Listen, Überschriften und Abschnittsüberschriften), in C# XML, in JavaDoc und einfache HTML Formatierungen. Doc-O-Matic versteht die gängigsten Überschriften für einzelne Kommentarteile und weist den nachfolgenden Text den jeweiligen Abschnitten zu.

Im Editor können Sie Tabellen, Listen, Bilder, Farben, Abschnitte, Absatz und Zeichenformatierungen einfügen und die Rechtschreibung im gesamten Projekt überprüfen. Sie können Ihren Themen einen Titel geben, manuell Schlüsselwörter hinzufügen, Kommentare für andere Symbole kopieren und Flags hinzufügen.

Sie können die gesamte Firmendokumentation Broschüren, Readmedateien und grosse Hilfesysteme die aus tausenden von Themen bestehen, schreiben. Die Online Hilfe, das Handbuch und alle Tutorials von Doc-O-Matic sind mit Doc-O-Matic geschrieben.

Zum Vergrössern anklicken

Fügen Sie zusätzliche Teile wie z.B Klassenhierarchien, Berichte und Überblicksseiten zu Ihrer Dokumentation hinzu. Im Class Hierarchy View können Sie die Klassenhierarchie anzeigen und neu anordnen. Das Layout kann manuell durch Ausschliessen einzelner Klassen und Verschieben von Klasse angepasst werden. Sie können eine andere Darstellungsart (von oben nach unten) andere Schriftarten und einen anderen Stil für Linien anwenden und Schatten zeichnen. Sie können die Graphiken von Ihrer Klassenhierarchie in jedem Ausgabeformat hinzufügen. Doc-O-Matic erzeugt automatisch Imagemaps für die Graphiken, sodass alle Klassen automatisch verknüpft werden. Für Module werden getrennte Klassenhierarchien angezeigt.

Zum Vergrössern anklicken

Erstellen Sie im Reports View Berichte, in denen Sie Informationen über Symbole (Titel, Typ, Zeilennummern, Dokumentationsstatus QA Meldungen) und Kommentare (Beschreibungen und Datum) verwenden. Drucken Sie die Berichte als mehrspaltige Tabellen oder in Absätzen. Fügen Sie automatisch verknüpfte Berichte in allen Ausgabeformaten hinzu.

Zum Vergrössern anklicken

Verwenden Sie verschiedene Konfigurationen, Dokumentationsvorlagen und die Settings um alle sechs Ausgabeformate an Ihre Vorstellungen anzupassen. Folgende Ausgabeformate sind verfügbar: Browser gestützte Hilfe (Web Hilfe) HTML Help, MS Help 2, WinHelp, PDF und XML. In den Settings werden allgemeinen Einstellungen und die Einstellungen aller Konfigurationen auf verschiedenen Tabs angezeigt. In jeder Konfiguration werden alle Einstellungsseiten in einem hierarchischen Baum angezeigt. Sie können verschiedene Konfigurationen für jedes Ausgabeformat hinzufügen und dafür die unterschiedlichen Vorlagen, die in der Installation enthalten sind, verwenden.