Features

Zusammenfassung

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)

Feature-Übersicht

Feature-Matrix

	Professional	SRC	Express	Author*
Programmiersprachen und Eingabeverarbeitung
Sprachgruppe I: C/C++, C++/CLI, C#, Delphi, VB.NET
Sprachgruppe II: IDL, ASP.NET, Java, JavaScript, JSP, MATLAB, PHP
Unterstützung für Quellcodekommentare
Unterstützung für XML Dokumentationsdateien
Unterstützung für externe Dokumentation
Unterstützt Dateien und Bezeichner in Unicode
Unterstützung für externe Unicode-Dokumentation
Master Projekte und externe TOC Dateien
Übersetzungsverzeichnis für Ausgabe in anderen Sprachen
Anpassbare Quellcode Parser Konfiguration
Erweiterte C++ Parser Funktionen (System Includes, prototyplose Funktionen, Setter/Getter Konvertierung, Macro Expandierung)
Namesbereich-Layout Konfiguration
Erweiterte Pascal Parser Funktionen (Implementation Sektion Parsen, System auto-using)
Unterstützung für bedingte Definitionen
Code Skipping
Grundlegende Kommentarfindungskonfiguration (Kommentartoken, Kommentarposition, Listen, Mauern, etc)
Erweiterte Kommentarverarbeitung (Dreifachslash Kommentare, Parameterlistenbeschreibung, Ignorierte Zeilen, Kommentarausschlusstokens)
Konfiguration von Themenverarbeitungsoptionen (Leere Themen, Auto-Combine Überladungen, Vererbte Dokumentation, Multi-Position Konfiguration)
Automatischer Text Einstellungen (automatische Snippets, automatischer Text für undokumentierte Symbole)
Unterstützung für XML Doc, JavaDoc und natürliche Kommentare
Grundlegende Abschnittskonfiguration (Typänderung und Starterstringänderung)
Erweiterte Abschnittskonfiguration (hinzufügen, löschen, Starter-Delimiter-Konfiguration, Leerzeichenverarbeitung)
Integrierte Editorkonfiguration
Farbeinrichtung
Managementfunktionen
Content Designer für Inhaltsverzeichnisdesign und individuelle Themenselektion
Visuelle Kontrolle über Exportstatus für individuelle Themen
Projektmanager
Symbol- und Themenfilterung
Projekt-Import-Werkzeug für Teamentwicklung
QuickDoc
Dokumentation-Verschiebungs-Werkzeug
Berichtemanager
Qualitätssicherungsmanager
Klassenhierarchieanzeige
Codeübersetzungsmatrixeditor
Einfaches Projektkonfigurationstool
Editor und Hilfeschreiben
Vollständig visueller WYSIWYG Editor
Standard Textverarbeitungsfunktionen einschliesslich fett, kursiv, unterstrichen, nichtproportional, tiefgestellt und hochgestellt
Farbkonfiguration mit Farbnamen
Listen, Tabellen, Bilder, geprüfte Links, Codeblöcke, Überschriften, Absatzausrichtung
Schnelle Themenerzeugung und Navigation
Einfaches Bildmanagement
Schnelle Editorfunktionen wie "Link folgen"
Bedingter Text mit Abschnitten
Snippets
Text Variablen
Live Rechtschreibüberprüfung und projektweite Rechtschreibüberprüfung
Automatisches Formatieren von Text Variablen
Text Labels
Bedingter Text mit Text Labels
Automatische Formatierung, Ersetzung und Textauszeichnung mit Text Labels
Generelle Ausgabefunktionen
Automatisch generierte Navigationstabellen
Automatisch generierte Navigationseiten
Vollautomatisches Verknüpfen innerhalb von Projekten und zu externen Projekten
Automatisch generierte Symbolübersichten
Berichte
Glossar
Lokale Klassenhierarchien
Klassenhierarchie für das Projekt
Klassenhierarchie für alle Module
Visueller Inhaltsverzeichnisdesigner
Module für die Unterteilung von Projekten
Projektdatenbanken für Verknüpfungen zwischen Projekten
Automatisches Verknüpfen und Verknüpfungspseudonyme
Automatisches Einfügen von Snippets in alle Themen
AutoDoc Funktionen
Automatische Exportmengenselektion basierend auf Symboltypen (Klasse, Typ, Funktion, ...)
Automatische Exportmengenselektion basierend auf Elementsichtbarkeit (public, protected, private)
Automatische Exportmengenselektion basierend auf Dokumentationstatus
Erweiterte Exportmengenselektion (Themen Status, Themenversionsinformation)
AutoDoc Ordnerkonfiguration
AutoDoc Seitentextkonfiguration
Konfiguration der Navigationsbeschreibung
Beschränkung der Navigationsbeschreibungslänge
Konfiguration des Navigationstabellenlayoutes
Erweiterte Elementtabellenkonfiguration (vererbte Elemente, Subkategorien, Sichtbarkeitstypenkombination, Überladungen)
Erweiterte Dateiabschnittskonfiguration
Konfiguration der Indikatorbilder
Konfiguration der Vorgabetitel (Seitentitel, Inhaltstitel, Indextitel)
AutoDoc Titelkonfiguration
Automatische Indexgenerierung
Erweiterte Indexkonfiguration
Indexvorsilbenentfernung
Erweiterte Optionen für Navigationsabschnitte und Zusatzinformationsabschnitte (Benennung, Deklarationstext, Tabellenlayout)
Automatisches Erzeugen der Zusammenfassung
Automatische Generierung des Deklarationssourcecodes
Konfiguration von Optionen für Deklarationsquellcode und Syntaxhervorhebung
Multi-Sprach-Syntaxausgabe
Funktionsrumpfausgabe
Rumpfausgabe für Dateien
Lokale graphische Klassenhierarchien
Textklassenhierarchien
Konfiguration für Layout und Design der graphischen Klassenhierarchien
Projektdatenbanken für automatisches Verknüpfen zwischen Doc-O-Matic Projekten
Automatisches Verknüpfen
Erweiterte Auto-Linkeroptionen (minimale Wortlänge, verbotene Wörter)
Automatische Verknüpfungspseudonyme
Themen Flags
Automatische Qualitätssicherungsprüfungen (Dokumentations Status, Parameterbeschreibung, Parameternamen, Rückgabewertbeschreibung)
Spezielle Ausgabeerzeugungsschritte
HTML, HTML Hilfe, Help 2, Help 3, Web Help
Grundlegende Datei- und Verzeichnisoptionen (Ausgabepfad, Dateinamen)
XHTML konforme Ausgabe, HTML 4.01 optional
Zusätzliche HTML-Ausgabe Dateioptionen (spezielle Dateibenennung, Vorlagedateien, zusätzliche Dateien, Frames, spezielle Willkommen-Seite)
Section Reihenfolge und Überschriftenkonfiguration
Erweiterte Abschnittsausgabeoptionen (automatische Tabellenkonfiguration, Navigationslinks und Sectionkonfiguration)
Zusammenklappbare Sections
Register-Abschnitte
Volle Kontrolle über das Layout und die Formatierung
Seiten Kopf- und Fusszeilenkonfiguration
Themen Pfade
Erweiterte Ausgabeoptionen (Willkommen-Seite, Inhaltsverzeichnis, Index, Copy Links, ...)
Dynamisch expandierendes Inhaltsverzeichnis
Spezielle Headerinformation
HTML-Seiten Kodierung
Grosse Bilder und Hoverglanzlicht-Bilder
Spezielle Suchseitenintegration
HTML Dateivorlage zur einfachen Integration in bestehende Layouts
PDF
Anpassbare PDF Ausgabe
Doppelseitiger Druck
Wasserzeichen
Hyperlinks innerhalb und ausserhalb des Dokuments
Section Reichenfolge und Überschriftenkonfiguration
Erweiterte Abschnittsausgabeoptionen (automatische Tabellenkonfiguration, Navigationsverknüpfungen und Abschnittskonfiguration)
Volle Kontrolle über das Layout und die Formatierung
Seiten Kopf- und Fußzeilenkonfiguration
Volle Kontrolle über automatische Seitennummerierung und Themennummerierung
Erweiterte PDF Funktionen (Lesezeichen, Titelseite, Copyright Seite, Inhaltsverzeichnis, Nummerierung, Index, Kapitelregister)
Graphik für die Titelseite
Thementitelkonfiguration
Erweiterte Ausgabeoptionen (Bildauflösung, Ausgabebilder, Flag-Anzeige)
Windows Hilfe
Grundlegende Datei- und Verzeichnisoptionen (Ausgabepfad, Dateinamen)
Section Reihenfolge und Überschriftenkonfiguration
Erweiterte Section Ausgabeoptionen (automatische Tabellenkonfiguration, Navigationsverknüpfungen und Abschnittskonfiguration)
Volle Kontrolle über das Layout und die Formatierung
Erweiterte Optionen
XML
Grundlegende Datei- und Verzeichnisoptionen (Ausgabepfad, Dateinamen)
Kodierung
Strukturoptionen
Tagoptionen
Support
Support Forum für Doc-O-Matic Benutzer
Support Forum für Kunden
Kundensupport via Email

(*) Als reines Hilfe-Authoring-Tool hat Doc-O-Matic Author keine Quellcode-Dokumentationsfunktionen. Diese Funktionen sind in der Tabelle mit gekennzeichnet.

Bildschirmfotos

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.

Was Benutzer sagen

Building the API documentation with Sandcastle took about 30 minutes on my virtual machine. Building the same documentation with Doc-O-Matic on the same machine took 3 minutes. Jesper Högström, CapableObjects Doc-O-Matic was an essential component of Delphi 2007's tremendously improved help system experience. Markus and his team were instrumental in making our documentation content more useful and accessible and Doc-O-Matic made building our help content fast and easy. Nick Hodges, Delphi Program Manager - CodeGear Doc-O-Matic has made the tedious process of generating help documentation for our product lines a breeze. It has literally saved us hundreds of hours when generating our online help I don't know what we would do without it. Kirk Stowell, President and CEO - codejocksoftware Game development becomes increasingly harder as the size of the projects and the required content grows bigger. One area we've been improving internally is our software documentation for our core libraries. After reviewing other freeware and commercial documentation programs, we decided to use Doc-O-Matic because of the great job it does extracting documentation from our code, the ability to switch between many different output formats, and the professional looking documentation that it produces. The amount of options available in Doc-O-Matic makes it easy to customize our documentation to fit our needs. Michael Kelley - Rockstar San Diego Doc-O-Matic is a superb, well-supported product - and it has steadily improved with each release. We've used the product since version two and toolsfactory has been openly receptive to feature requests and very responsive and tech-support inquiries. Some of our C++ libraries contain hundreds of source files and classes - but Doc-O-Matic handles them with aplomb. Doc-O-Matic is indispensable. Jim Henderson, President - Innovative Integration

This tool is absolutely fantastic! There's no doubt in my mind that Doc-O-Matic is the best documentation tool on the planet. I should know, because I've probably used just about all of them. Doc-O-Matic's model is far superior to most models for help authoring (such as that of RoboHelp) which require a lot of labor-intensive manual work that has nothing to do with content development. And compared to the help tools with similar code parsing models (NDoc, Doxygen, etc.), Doc-O-Matic is absolutely matchless in features and flexibility. Bruce Denham - Schlumberger Doc-O-Matic continues to prove invaluable in our documentation process. It allows us to document our work in a natural and readable fashion, and the graphical interface lets us stay completely in control of the whole process. The level of customer support is also excellent. I have no hesitation in recommending this software to anyone who is thinking about in-line documentation for their code. Jason G Doig, Principal Engineer - Sony Computer Entertainment Europe R&D We used Doc-O-Matic to produce documentation for a brand new code base and had great results. We documented approximately 1000 API functions and data types for a new project. Without Doc-O-Matic there is no way we would have been able to produce such a nice and complete set of documentation for our customers and have it ready immediately. Before Doc-O-Matic we produced documentation manually, and not only did it take a long time, but the documentation was often out of date just because it was so tedious to make updates. I have looked over the past several years for a decent way to automate our documentation, and evaluated several other products, but Doc-O-Matic is the first product I found that I consider to be really useable, and fully customizable to to my needs for appearance of the output. Speaking of customizable output, Doc-O-Matic is so flexible I was able to configure it to produce output that had nearly the same format as we were producing manually before. Another feature that I really like is how well it reads comments out of the box, and how easy it is to configure it to read any commenting style. Our developers just followed a very simple commenting format for each function in order to allow Doc-O-Matic to produce complete documentation for the function. Our developers like it too because now the API documentation is in one place - the source code. Doc-O-Matic saved me weeks of work in producing this first set of documentation for our new project, and I expect this to keep paying off in the future as I will be able to generate a complete set of documentation for each future release with very little additional work. Joe Kroesche - Conexant Systems, Inc.