In spaetestens drei Jahren muessen Beschreibungen standardisiert sein

SGML: Die sanfte Revolution der technischen Dokumentation

14.05.1993

Wer dringend Ueberblick ueber eine Benutzeranleitung benoetigt, weil sein Computer gerade den Statuscode F47 anzeigt und heftig blinkt, weiss es zu schaetzen, wenn das Inhaltsverzeichnis wie gewohnt vorne in der Benutzeranleitung zu finden ist. Dass man es dann auf den Seiten 236 bis 243 vor dem Glossar des zentimeterstarken Werkes findet, laesst sich eventuell noch verkraften; dass es ueberhaupt vorhanden ist, ist durchaus nicht selbstverstaendlich.

Dem strukturellen Aufbau einer jeden technischen Dokumentation sollte deshalb Bedeutung beigemessen werden. Dies gilt insbesondere fuer Dokumentationen, die im Gefahrenfall benoetigt werden.

Normen muessen verstanden und eingehalten werden

Die Beschreibung der Struktur einer Dokumentart (Document typ description, DTD) auf Papier, wie sie zum Beispiel DIN 820 fuer die Dokumentart DIN-Norm darstellt, wirkt aber nur begrenzt. Sie wird von Autoren gelesen, verstanden und beruecksichtigt (oder auch nicht), muss kontrolliert werden, zum Beispiel in der Normenpruefstelle, und ist deshalb prinzipiell als mehr oder weniger fehlerhaft beziehungsweise unvollstaendig zu klassifizieren.

Der Umfang von Dokumentationen fuer technische Geraete nimmt staendig zu. Die Papierdokumentation eines Flugzeuges wiegt heute mehr als das Flugzeug selbst. Die Forderung, Beschreibungen in Zukunft elektronisch zu verarbeiten, wird immer lauter erhoben. Sie ist um die DTD-Faehigkeit zu ergaenzen, um so die Vollstaendigkeit jeder Dokumentart und damit des Dokuments zu garantieren.

Daneben wird die Austauschbarkeit von elektronischen Dokumenten verlangt. Die Vielfalt der Textsysteme bedeutet auch eine Menge von Datenformaten. Konvertierungsroutinen schaffen keine Abhilfe, sondern eine unueberschaubare Zahl von Softwareprodukten und Versionen.

Ein einheitliches Austauschformat fuer technische Dokumente ist dringend notwendig, aber nur durchsetzbar, wenn es auf Druck der Anwender der Textsysteme zu nationaler und internationaler Standardisierung kommt. Es muss die Uebertragung von Dokumenteninhalten und -strukturen ermoeglichen.

Die einzelnen Elemente eines Dokuments, zum Beispiel das Inhaltsverzeichnis, muessen in Datenbanken gezielt ablegbar, ansprechbar und anzeigbar sein.

An diesem Punkt soll das Austauschformat Standard Generalized Markup Language (SGML) greifen. Es wurde bereits 1986 von der International Standards Organization (ISO) als Norm ISO 8879 verabschiedet. Der Standard erlaubt es, praktisch beliebig komplexe Dokumentstrukturen abzubilden.

Er beschreibt, wie sich sogenannte Tags, die Markierungen fuer Dokumentelemente wie das Inhaltsverzeichnis, die in den normalen Text des Schriftstuecks eingefuegt werden, definieren lassen.

Ueber eine vorgegebene Grammatik wird der Zusammenhang zwischen solchen Elementen dann zusammen mit den Elementdefinitionen in einer DTD fuer einen bestimmten Dokumenttyp festgelegt.

Solche DTDs wurden mittlerweile bereits von verschiedenen Organisationen fuer technische und nichttechnische Dokumentationen aller Art fixiert. Die bekannteste SGML-Aktivitaet duerfte die Initiative Computer Acquisition and Logistics Support (Cals) des US-amerikanischen Verteidigungsministeriums sein (vgl. Abbildung 1, Seite 35).

Ein festgelegter Standard beschreibt darin, wie zukuenftig jegliche technische Dokumentation fuer amerikanisches Militaergeraet zu erfolgen hat. Der Cals-Standard ist umfangreich und umfasst im Kern eine DTD auf Basis der hoeheren Dokumentensprache SGML sowie Festlegungen fuer Elemente von Dokumenten. Die Elemente schliessen Text, Grafik etc. ein (vgl. Abbildung 2, Seite 35).

In Deutschland hat sich der Arbeitskreis Elektronische Speicherung und Handhabung von Dokumenten (ESHD) im DIN-Ausschuss Normenpraxis schon fruehzeitig mit der Standardisierung von Normen beschaeftigt. Er hat in Zusammenarbeit mit dem Normenausschuss fuer Bibliothekswesen und Dokumentation (NABD) mittlerweile die Norm DIN V 33900 veroeffentlicht. Sie umfasst DTDs fuer DIN-Normen, Werknormen und allgemeine Festlegungen, die fuer andere DTDs Verwendung finden. Im zugehoerigen DIN-Fachbericht 27 ist sie naeher erlaeutert (vgl. Abbildung 3, Seite 35).

Die Normreihe DIN V 33900 ist grundsaetzlich so aufgebaut, dass sich jederzeit weitere DTDs aufnehmen und standardisieren lassen. ESHD und NABD setzen sich aus Vertretern namhafter potentieller Nutzer und unterstuetzender DV-Spezialisten zusammen. Darunter sind AEG, Bosch, Cap Debis SHE, DIN, IBM, Interleaf, Mercedes-Benz, MID-Heidelberg, SEL, Siemens, VDE, ZGDV. Das Bundesministerium fuer Wirtschaft unterstuetzt die Arbeiten.

Daneben befinden sich in Deutschland noch andere SGML-Anwendungen in der Entwicklung oder bereits im Erprobungsstadium. So erarbeitet die Dasa fuer den neuen vierstrahligen Airbus A340 eine SGML-basierte Dokumentation. Diese Aktivitaet kommt einer Forderung der Air Transport Association (ATA) entgegen. Deren Standard ATA- 100 regelt den Informationsaustausch zwischen Flugzeugherstellern und Fluglinien auf Basis einer SGML.

Noch staerker wird sich die neue Vorschrift der amerikanischen Umweltbehoerde Environmental Protection Agency (EPA) auf die Verbreitung des SGML-Standards in Deutschland auswirken. Die Regelung besagt in Ergaenzung zum Luftreinhaltungsgesetz, dass spaetestens bis 1996 saemtliche Dokumentationen eines in den USA zugelassenen Fahrzeugs im SGML-Standard vorliegen muessen. Die Automobilbranche muss also weltweit bereits in den naechsten zwei bis drei Jahren den SGML-Standard einfuehren.

Editoren fuer den SGML-Standard

Die Mitglieder der SGML-User-Group tauschen bereits heute regelmaessig Informationen und Erfahrungen zu diesem Thema aus. Die praxisgerechte Anwendung des SGML-Standards haengt davon ab, ob SGML-Editoren verfuegbar sind.

Erste Hersteller wie Agfa, Arbortext, Datalogics, DEC, Interleaf und Xerox bieten bereits mehr oder weniger vollstaendige SGML- Editoren an, andere Hersteller wie Frame haben dies angekuendigt. Ein solches Tool ist in der Lage, Dokumente entsprechend den Vorgaben in der DTD zu pruefen und auszutauschen.

Es braucht zunaechst einmal WYSIWYG-Faehigkeit. Ausserdem sollte es unbedingt in der Lage sein, beliebige DTDs flexibel zu verarbeiten. Erste Editoren hatten beispielsweise die Cals-DTD fest kodiert, andere DTDs waren aber nicht verarbeitbar. Ein weiteres Qualitaetsmerkmal eines SGML-Editors ist die kontextsensitive Arbeitsweise. Bei jeder Texteingabe wird sofort die Zulaessigkeit von Elementen im Kontext geprueft.

So kann zum Beispiel in einer DTD festgelegt sein, dass es in einem Kapitel kein Unterkapitel geben darf. Der kontextsensitive Editor wird in diesem Fall den Versuch der Eingabe eines Unterkapitels sofort abweisen.

Erste Modelle konnten hier lediglich durch einen von der Eingabe des Dokumentes getrennten Prueflauf mittels eines Parsers Fehler feststellen.

Alle Editoren leiden heute noch an der Unvollkommenheit des SGML- Standards. Layout-Informationen lassen sich nicht im SGML-Standard bearbeiten, sondern sind herstellerspezifisch und folglich bei jedem System anders einzugeben. Dies liegt daran, dass ein entsprechender Standard wie die Document Style Semantics and Specification Language (DSSSL, ISO-Norm DIS 10179) noch nicht verabschiedet ist.

Das SGML-Dokument ist zwar inhaltlich und strukturell vollstaendig und richtig erzeugbar, kann aber je nach Editor ein unterschiedliches Aussehen haben. Schriftarten koennen abweichen, Seitenumbrueche nicht mehr stimmen, wenn zum Beispiel im Editor A fuer das Inhaltsverzeichnis die Schrift Roman 10 Punkt und im Editor B die Schrift Times 8 Punkt angegeben sind. Solche Schoenheitsfehler sind aergerlich, zur Zeit noch nicht zu vermeiden, aber nicht katastrophal. Durch Absprachen lassen sie sich beheben.

1989 hat erstaunlicherweise die ISO quasi einen Konkurrenzstandard zu ihrer Norm SGML veroeffentlicht. Die Standard Office Document Architecture (ODA) mit dem Uebertragungsformat Office Document Interchange Format (Odif) waere im Prinzip der bessere Standard. Mit ihm lassen sich sowohl Struktur- als auch Layoutinformationen abbilden.

Noch fehlen Spezifikationen

Die Moeglichkeiten des Standards sind allerdings unvollstaendig ausgearbeitet. So sind die Elemente fuer Tabellen oder auch mathematische Formeln mit ODA nicht abgedeckt. Da nahezu jedes technische Dokument mindestens eine Tabelle enthaelt, laesst sich ODA folglich bis heute in der technischen Anwendung nicht einsetzen.

Bedingt durch die spaetere Verfuegbarkeit und den Entwicklungsstand von ODA, arbeiten momentan im wesentlichen Hochschulinstitute, etwa im Rahmen des Step-Projekts, an entsprechenden Editoren. Ob sich der Standard ODA etabliert oder ob sich die breite Basis der industriellen Entwicklungen von SGML-Editoren durchsetzt, muss sich noch zeigen.

Abzusehen ist aber, dass der Umfang und die Komplexitaet technischer Dokumentationen aller Art in den naechsten Jahren nicht geringer werden. Gesetzgeber und andere Regelsetzer werden immer staerker vorschreiben, wie Dokumente auszusehen haben. Die Signale fuer die Schluesselindustrien sind deutlich; die Auswirkungen auf alle Zulieferer absehbar.

SGML ist mit Sicherheit kein Allheilmittel. Die Editoren und Werkzeuge stecken noch in den Kinderschuhen, DTDs muessen noch entwickelt beziehungsweise ergaenzt werden. Nichtsdestoweniger ist die Zeit fuer SGML gekommen.

Der Standard wird sich in der Praxis bewaehren muessen und durch praktische Arbeit verbessert werden. Nur so sind die zukuenftigen Anforderungen in der technischen Dokumentation zu bewaeltigen, die Papierberge einzudaemmen und die komplexe Technik der Zukunft zu beherrschen.

*Diplomingenieur Ulrich Saelzer ist Leiter der Abteilung Geometrieverwaltung und technische Dokumente bei Cap Debis Engineering, Fellbach, und Obmann des DIN-Arbeitskreises Elektronische Speicherung und Handhabung von Dokumenten (ESHD) im Ausschuss Normenpraxis (ANP).

Abb. 1: Cals* Basisstandards

Eine grundlegende SGML-Aktivitaet ist die Initiative Computer-aided Acquisition and Logistics Support (Cals) des US- Verteidigungsministeriums. Der Standard wird durch mehrere militaerische Normen flankiert. Quelle: CAP Debis

Abb. 2: Beispiel einer Dokumentstruktur

Die Standard Generalized Markup Language (SGML) beschreibt zunaechst die allgemeine Dokumentstruktur. Quelle: CAP Debis

Abb. 3: SGML-Dokumenttyp-Definition (DTD)

Aus der SGML-Dokumentstruktur leitet sich die Dokumenttyp- Definition (DTD) mit der zwingenden Festlegung der Elemente eines Dokuments ab. Quelle: CAP Debis