Fachbücher

doculine Archiv

Service

Aktuelle Artikel und Nachrichten rund um die technische Dokumentation finden Sie im Nachfolgemagazin der doculine news, den transline tecNews

Dialogorientierte elektronische technische Dokumentation in SGML/XML

Artikel erschienen in
Ausgabe Februar 2000

Von Robert Schnurer

Inhaltsübersicht:

• SGML/XML in Bewegung
• Dialogorientierte technische Dokumentation
• Metafile for Interactive Documents (MID)
• Eine MID-basierte Lösung in SGML
• Fazit
• Literatur

XML wie auch SGML schreiben im Gegensatz zu HTML keine feste Menge an Elementen vor. Beide Auszeichnungssprachen lassen sich durch Wahl geeigneter Markierungen anwendungsspezifisch definieren, um so flexibel verschiedenen Problemfeldern gerecht zu werden. So werden derzeit nicht nur im Bereich des Electronic Commerce unterschiedlichste XML-basierte Entwürfe entwickelt. Auch bei der DaimlerChrysler Aerospace AG (DASA), Geschäftsbereich Militärflugzeuge, wurde eine XML-kompatible SGML-Anwendung zur Erfassung dialogorientierter technischer Dokumentation implementiert.

SGML/XML in Bewegung

Die Ausgabe eines Dokuments auf unterschiedlichen Medien wird sich je nach gewähltem Medium ändern. Dabei darf es jedoch nicht zu einem Informationsverlust führen. SGML/XML basieren auf dem Konzept der Trennung des Informationsgehalts eines Dokuments von seiner Präsentation, wobei mit Hilfe von frei wählbaren Markierungen („Markups“) Struktur und Daten eines Dokuments beschrieben werden können.

Genauer gesagt ist SGML (Standard Generalized Markup Language) eine standardisierte, von Computern und Menschen lesbare Auszeichnungssprache und beschreibt einen Weg, wie Elemente definiert werden und wie sich die Beziehungen der Elemente in einer bestimmten Dokumentenklasse darstellen. Auf diese Weise kann für die Lösung eines bestimmten Problems (z.B. Erstellung einer standardisierten Vorlage für Firmenberichte) eine Menge von SGML-Elementen und deren Beziehungen untereinander definiert werden. Diese so genannte Document Type Definition (DTD) legt dann die SGML-Anwendung fest.

Es haben sich nun im Laufe der Zeit, u.a. um durch die gegebene Offenheit von SGML einem Wildwuchs an unterschiedlichen SGML-Anwendungen entgegenzuwirken, international standardisierte Dokumentstrukturen gebildet. Beispiele hierfür sind im Bereich der Luftfahrt AECMA Spec 1000D oder ATA 100.

Mit Entwurf der Auszeichnungssprache XML (Extensible Markup Language), die im November 1996 als neuer Standard im Web-Umfeld vorgestellt wurde, kam Schwung in diesen Bereich. Die XML-Sprache sollte weder die HTML-Einschränkungen noch die SGML-Komplexität haben. Die Lösung war eine echte Untermenge von SGML, welche die selten genutzten Konstrukte von SGML nicht beinhaltet, aber gleichzeitig flexibel genug ist, um den unterschiedlichsten Anforderungen des Webs (wie z.B. Heterogenität und Erweiterbarkeit) gerecht zu werden. SGML wurde also soweit abgemagert, dass ein verständlicher und einfach zu verwendender Mechanismus entstand.

Die hohe Akzeptanz von XML lässt den Schluss zu, dass sich dieser Standard zum zukünftig wichtigsten Format für Daten und Dokumente herausbilden wird. XML bietet hierbei praktisch keinerlei technologische oder konzeptionelle Neuheit, sondern ist lediglich eine SGML-konforme Sprache zur Definition unterschiedlichster Dokumentklassen. Aber alleine die Tatsache der Akzeptanz einer solchen Standardfamilie führt dazu, dass eine Vielzahl von Anwendungsfeldern in den Blickwinkel von XML rücken und damit einer standardisierten und zugleich Web-fähigen Lösung zugeführt werden. Als Beispiele seien nur folgende genannt:

Einige Beispiele für XML-Lösungen

Bei der DaimlerChrysler Aerospace AG (DASA), Geschäftsbereich Militärflugzeuge, wurde auf analoge Weise eine SGML-Anwendung zur Erfassung dialogorientierter technischer Dokumentation, d.h. Dokumentation mit anweisendem und abfragendem Charakter wie z.B. Funktionsprüfungen, spezifiziert und als IETD (Interaktive Elektronische Technische Dokumentation) implementiert. Hierbei wurde darauf geachtet, dass die Lösung zugleich XML-kompatibel ist.

Dialogorientierte technische Dokumentation

Neben der klassischen beschreibenden technischen Dokumentation (z.B. Wartungshandbücher) stellen Fehlersuche bzw. Diagnose wie auch Funktionsprüfungen einen wichtigen Baustein im Rahmen von Instandsetzung und Reparatur dar und bieten sich geradezu an, um in Form einer IETD bereitgestellt zu werden. Es handelt sich dabei um Dokumentationen mit anweisendem und abfragendem Charakter, so dass eine Dialogfunktion zur Kommunikation zwischen dem Retrieval-System und dem Nutzer notwendig ist, d.h. diese Art der technischen Dokumentation sollte im Dialog durch Anzeige bzw. Abfrage der Einzelanweisungen erfolgen.

Die Notwendigkeit, den jeweiligen Prüfvorgang auch nach der Durchführung wieder nachvollziehen zu können, erfordert bei der Nutzung einer interaktiven elektronischen Dokumentation, dass der Prüfvorgang mit den auftretenden Fehlersymptomen, den durchgeführten Prüfschritten, den Zwischenergebnissen und den erfolgten Eingaben protokolliert werden kann. Denn dadurch hat der Nutzer nach erfolgter Fehlersuche bzw. Funktionsprüfung die Möglichkeit, sich die einzelnen durchgeführten Schritte anzeigen zu lassen.

Folgendes Beispiel zeigt vereinfachend einen Prüfablauf in tabellarischer Form, wie er klassischerweise auf Papier bereitgestellt wurde. D.h. das Prüfproblem lag in den meisten Fällen als binärer Entscheidungsbaum vor, der dann im Laufe der Zeit auf Basis des gesammelten Erfahrungswissens komplettiert wurde.

Beispiel eines Prüfablaufs in tabellarischer Form

Metafile for Interactive Documents (MID)

Bei MID (Metafile for Interactive Documents) handelt es sich um einem Vorschlag für einen internationalen Standard, der auf SGML (ISO 8879) und HyTime (ISO/IEC 10744) basiert und eine Methode spezifiziert, um Multimedia-Informationen von Autoren- in Nutzungssysteme zu transportieren. Die Entwicklung von wurde vom Naval Air Warfare Center – Aircraft Division, St. Inigoes, Md, initiiert und von der U.S. Navy gefördert.

Diese SGML-Anwendung liefert Sprachkonstrukte, um das Verhalten und die Ablauflogik im Datenbestand eindeutig zu formulieren, und erlaubt somit die Entkopplung von Datenbestand und Präsentationssoftware. Auch hier sind Details der Formatierung nicht Bestandteil des Dokumentes.

In einem MID-Dokument existieren somit Auszeichnungsmöglichkeiten für gängige Elemente, die in einer grafischen Oberfläche vorkommen (Menüleiste, Schaltknöpfe, Eingabefelder, Textfelder, Pop-ups usw.), prozedurale Sprachmöglichkeiten (Skripte, Variablen, If-then-else-Anweisungen usw.), aber auch dokumentspezifische Markierungen wie Paragraphen und Listen, die hier jedoch eine untergeordnete Rolle spielen.

Die folgende Abbildung stellt vereinfachend die Grundstruktur eines MID-Dokumentes dar. Es besteht aus einem Eingangsskript, das bestimmt, wo die Abarbeitung des Dokumentes beginnt, und einem Pool, der alle Dokumentationsanteile beinhaltet. In diesem Beispiel ist es eine Folge von verketteten und zum Teil gekapselten Infocontainern. Man kann sich bildlich einen Infocontainer als einen Bildschirminhalt vorstellen, der wiederum aus Teilfenstern und z.B. Buttons mit einer bestimmten Funktionalität besteht.

Grundstruktur eines MID-Dokuments

Durch die Datenaufbereitung werden die SGML-Tabelle und die MID-Konstrukte im gleichen Dokument abgelegt. Das bedeutet, dass auch im Rahmen einer IETD-Anwendung für den Ausdruck die leicht auf Papier lesbare Tabellenform verwendet werden kann und für die Anzeige am Bildschirm die Dialogform. Der generierte Bildschirminhalt für den beispielhaft gezeigten Tabellenausschnitt würde sich wie folgt darstellen:

Aus Tabelle generierter Bildschirminhalt

Im Gegensatz zur papierorientierten Dokumentation ist damit auch die Möglichkeit gegeben, vom Nutzer dynamisch während der Abarbeitung des Prüfablaufes Werte abzufragen und je nach Eingabe den weiteren Prüfablauf zu steuern. Wichtig ist hierbei, dass es sich dabei nicht um eine spezifische Funktionalität des elektronischen Nutzungssystems handelt, sondern dass lediglich der SGML-Datenbestand interpretiert, dargestellt und in Form von Funktionalitäten umgesetzt wird – die gleiche Vorgehensweise also wie bei allen XML-Standardisierungsbemühungen. Damit ist natürlich der Grundstein gelegt für eine echte messtechnische Schnittstelle, d.h. die Werteingabe erfolgt nicht mehr durch den Nutzer, sondern durch das getestete System selbst.

Steuerung des Prüfablaufes am Bildschirm

Fazit

Dialogorientierte technische Dokumentation stellt eine ideale IETD-Anwendung dar, da gerade hier im Gegensatz zur klassischen papierorientierten Form das erreichbare Rationalisierungspotenzial erheblich ist.

Der dargestellte Ansatz verbindet die einfache tabellarische Eingabe von binären Entscheidungsbäumen mit modernen Ansätzen, wie sie derzeit bei allen XML-basierten Entwürfen für verschiedenste Anwendungsplattformen zum Einsatz kommen. Dieser Ansatz ermöglicht dem technischen Autor in seiner gewohnten Arbeitsumgebung, interaktive dialogorientierte Fehlersuchabläufe bzw. Funktionsprüfungen zu formulieren oder komplette Diagnosesysteme zu programmieren, ohne Skript- oder Programmiersprachen zu beherrschen.

Zugleich wird auf eine bereits bestehende SGML-Anwendung zurückgegriffen, diese jedoch auf die notwendigen Funktionalitäten abgemagert – der gleiche Grundsatz also, der auch zur XML-Entwicklung führte. Desweiteren ist mit diesem flexiblen Ansatz bei voller SGML/XML-Konformität eine außerordentliche IETD-Funktionalität erreichbar, die bis hin zur Integration von messtechnischen Schnittstellen reicht.

Literatur

Tolksdorf, R.: XML und darauf basierende Standards: Die neuen Auszeichnungssprachen des Web. In: Informatik Spektrum. Dez. 1999, S. 407-421.

Farsi, R.: XML. In: Informatik Spektrum. Dez. 1999, S. 436-438.

MID: What's New?
http:navycals.dt.navy.mil/mid/midnew.html

MID – The Metafile for Interactive Documents.
http://navycals.dt.navy.mil/mid/mid.html

* URL ist inzwischen nicht mehr verfügbar, daher wurde dieser externe Link deaktiviert.

Letzte Änderung: 31.10.2005 | Presse-Service | Disclaimer
© doculine Verlags-GmbH, ein Unternehmen der transline Gruppe