Features

Softwareentwicklung wird immer komplexer, daher ist ein verlässliches Programm, das die Anfertigung einer Dokumentation erleichtert und diese immer am aktuellen Stand hält, unentbehrlich. Softwareentwickler, die um ein gutes Produkt bemüht sind, brauchen eine Online Hilfe und druckbare Dokumente sowohl für die Benutzer der Software als auch für das Entwicklerteam.

Diese Arbeit kann erleichtert werden, wenn man ein Programm verwendet, das die Dokumentation in vielen leicht zugänglichen Formaten von nur einer Textquelle erzeugt.

Doc-O-Matic Facts

Die Verwendung von Doc-O-Matic hat folgende Vorteile:

• Die Dokumentation ist immer aktuell und am neusten Stand.
• Doc-O-Matic unterstützt viele der meistverwendesten Programmiersprachen.
• Doc-O-Matic passt sich Ihrer Art Quellcode zu dokumentieren an und unterstützt XML Doc und JavaDoc.
• Mit Doc-O-Matic kann man sowohl Quellcodedokumentation als auch Anwenderhilfe verfassen.
• Doc-O-Matic erzeugt leicht zugängliche Ausgabeformate, die an die jeweiligen Bedürfnisse angepasst werden können.
• Doc-O-Matic stellt Ihnen Vorlagen zur Verfügung mit deren Hilfe Sie Hilfe im Stil von Visual Studio und MSDN Hilfe und Delphi VCL Hilfe erstellen können.
• Doc-O-Matic unterstützt Sie bei der Verwaltung Ihres Quellcodes mit einem Werkzeug zur graphischen Darstellung von Klassenhierarchien einem flexiblen Werkzeug zur Erstellung von Berichten und einem graphischen Tool zur Qualitätssicherung der Dokumentation.
• Doc-O-Matic erzeugt Quellcodedokumentation und Anwenderhilfe in Browser basiertem HTML, HTML Help, Help 2, Help 3, Windows Hilfe, PDF und XML.
• Doc-O-Matic ist ein Tool das aus einer Quelle verschiedene Ausgaben erzeugt.
• Doc-O-Matic ist ein selbständiges Windows Programm mit einem benutzerfreundlichen Oberläche.
• Doc-O-Matic stellt einen Kommandozeilenkompiler zur Verfügung, womit Doc-O-Matic leicht in einen automatische Erzeugungsprozess integriert werden kann.

Doc-O-Matic wird in allen Arten von Industrien eingesetzt, von Halbleiterherstellern bis zu Spieleentwicklungsfirmen. Lesen Sie mehr in der Sektion Was Kunden sagen.

Das Fact-Sheet können Sie hier herunterladen: Fact Sheet (PDF)

Der Inhaltsmanager ist der Hauptarbeitsbereich für das Dokumentationsmanagement, die Gestaltung des Inhaltsverzeichnisses und das Hilfescheiben.

Für Quellcode-Projekte zeigt der Inhaltsmanager alles Namensbereiche, Module, Klassen, Members, Variablen, Enums, Strukturen, Funktionen und Dateien in einer wohlgeordnet strukturten Themenhierarchie an. Die unterschiedlichen Icons repräsentieren verschiedene Symbolarten und Themenstati. Die Markierungsfelder neben den Themen stellen eine Kontrollmöglichkeit für die Ausgabe des Themas zur Verfügung. Die automatische Themenhierarchie ist sehr weitreichend anpassbar mit Optionen für Ordner für Symbole in Modulen, Namensräumen und erweiterten Member-Ordnern. Doc-O-Matic stellt ausserdem Funktionen zum Sortieren von Symbolen und Themen zur Verfügung. Zusätzlich können Themen per Drag-und-Drop manuell verschoben werden.

Der Editor zeigt Themen an und macht sie editierbar. Er stellt gewohnte Textverarbeitungsfunktionalität einschliesslich Listen, Tabellen Live-Rechtschreibprüfung zur Verfügung und unterstützt fortgeschrittene Funktionen für die Wiederverwendung von Text wie zum Beispiel Schnipsel. Beim Schreiben von Quellcodedokumentation liest und schreibt Doc-O-Matic native Kommentare (solche, die keine Tags benötigen), XML Doc und JavaDoc.

Die Funktionen für das Hilfeschreiben schliessen Themen, Abschnitte, Schnipsel, Labels, Links, Bilder, Index, Flags und vieles mehr ein. Jede Ausgabekonfiguration - von denen ein Projekt einen beliebige Anzahl haben kann - definiert seine eigene Auswahl von Themen, welche Abschnitte exportiert werden sollen und in welcher Reihenfolge. Auf diese Weise können verschiedene Ausgaben erzeugt werden, indem nur eine Einstellung geändert wird.

Die QA-Ansicht hilft beim Identifizieren von Bereichen in der Dokumentation, bei denen noch Arbeit nötig ist. Sie hilft einen schnellen Eindruck von der Vollständigkeit der Dokumentation zu erhalten, auch in sehr grossen Projekten. Während der Ausgabeerzeugung kann Doc-O-Matic Warnungen in verschiedenen Detailstufen ausgeben.

Klassenhierarchien werden automatisch während der Ausgabeerzeugung generiert und können in der Dokumentation benutzt werden. Doc-O-Matic erzeugt Klassenhierarchien für das gesamte Projekt und für einzelne Module des Projekts sowie für jede einzelne Klasse.

Berichte sind ein sehr vielseitiges Feature zum Erzeugen von zusätzlichem Inhalt. Mit Berichten erzeugen Sie zum Beispiel einfache und Mehrfachwort-Glossare, Themenlisten sowie QA bezogene Information. Berichte sind ein mächtiges Werkzeug, um eine Gruppe von Themen basieren auf einer Reihe von Kriterien auszuwählen und Tabellen gefüllt mit bestimmten Eigenschaften dieser Themen (z.B. Titel oder ein bestimmter Abschnitt) zu drucken.

Der Projektmanager verwaltet Quellcode-, Themen- und Ausgabedateien, Include-Pfade und Bildpfade, Konfigurationen, Projektdatenbanken und Module. Er stellt ausserdem Funktionen zum Verwalten von Module-Definitionen zur Verfügung. Module machen es möglich, ein Projekt in mehrere Teile zu teilen und Doc-O-Matic getrennte Themenhierarchien für jeden Teil erzeugen zu lassen.

Jeder Aspekt von Eingabebearbeitung, editieren und Ausgabegenerierung in Doc-O-Matic ist extrem anpassbar. Die Einstellungsansicht stellt eine Schnittstelle zu all den verschiedenen Optionen sowohl für generelle Projekteinstellungen als auch ausgabespezifische Einstellungen zur Verfügung. Jedes Projekt kann einen nicht begrenzte Anzahl an Ausgabekonfigurationen enthalten, die das Look-and-Feel sowie die Funktionen der erzeugten Ausgabe bestimmen. Die Einstellungsansicht listet alle Einstellungsseiten in einem hierarchischen Baum.