ISA Dialog Dokumentator
Automatische Analyse und Dokumentation Ihrer Dialoge und Module
Dokumentation von Programmen
Die Dokumentation von Anwendungen ist für jedes Projekt wichtig – bei größeren
Projekten sogar unerläßlich. Sie ermöglicht den schnellen Überblick ebenso wie den
detaillierten Einblick in die Implementation von Programmen.
Oft wäre es schon während der Entwicklung wünschenswert, einen Überblick über
die Zusammenhänge von programminternen Strukturen zu erhalten. Dokumentationen
von Programmquellen werden jedoch i.d.R. erst nachträglich erstellt. In jedem Fall ist
die Vollständigkeit der Dokumentation sicherzustellen.
ISA Dialog Dokumentator – IDD
Dialog Manager-Anwendungen können nun automatisch dokumentiert werden.
IDD analysiert und dokumentiert Struktur und Implementierung von Dialogen und
Modulen anhand der definierten Skripte.
Zum Nachschlagen generiert IDD einerseits eine Dokumentation in druckbarer
Form – komplett mit Inhalts-verzeichnis, Gliederung des Dialoges oder Moduls
in Kapitel und Unterkapitel. Weiterhin ausführliche Querverweise, auch über
Modulgrenzen, Darstellung der Modellhierarchie und Index hinweg.
Außerdem erstellt IDD eine Dokumentation, mit der Entwickler online arbeiten können.
Die Möglichkeiten von Online-Dokumenten, Zusammenhängen via Hypertextlinks
nachzugehen, umfangreiche Suchmechanismen zu nutzen, Notizen zu hinterlegen etc.
können so optimal von allen Entwicklern genutzt werden.
Das Konzept
Der IDD analysiert Ihre Skripte und dokumentiert sie in verschiedenen Kapiteln:
Attribute und Ressourcen
Dieses Kapitel beinhaltet neben den Attributen und Ressourcevarianten auch
Applikationsobjekte verteilter Anwendungen, importierte Module, Funktionen,
Formate und Records.
Defaults, Modelle, Instanzen, Timer
werden hier mit den jeweiligen Attributen beschrieben. Querverweise erlauben es,
Verbindungen in der Objekthierarchie nachzuvollziehen.
Regeln
Sämtliche Regeln werden, nach Ty-pen sortiert, in den einzelnen Abschnitten beschrieben.
Modellhierarchie
Defaults und Modelle werden auf die jeweils von ihnen abgeleiteten Modelle und Instanzen
hin analysiert.
Für die Ausgabe kann dann zwischen verschiedenen Formaten gewählt werden:
Ausgabe als Textdatei
Diese Textdatei kann mit Textedi-toren weiterbearbeitet werden – wahlweise als RTF-,
LaTeX- oder ASCII-Datei.
Ausgabe als HTML-Datei Diese Datei kann in einem Browser angezeigt werden.
Verfügbarkeit
IDD ist eine Option, die grundsätzlich als Erweiterung der Entwicklungsumgebung
des ISA Dialog Managers verfügbar ist.
Derzeit ist IDD auf den folgenden Plattformen lieferbar:
Microsoft Windows
Unix
VMS
Bitte erfragen Sie ggf. die Verfügbarkeit von weiteren Plattformen. |
