SGML/XML-Dokumentationen
Strukturierte Dokumentformate
SGML und XML sind sog. strukturierte Dokumentformate. In solchen Dokumenten werden neben dem textlichen Inhalt auch Zusatzinformationen in Form von Elementen und Attributen eingefügt, ähnlich wie dies auch in der "Internet-Sprache" HTML der Fall ist. Hierbei können die Namen der Elemente und Attribute frei gewählt und auf den gewünschten "Zweck" abgestimmt werden. Die Namen sowie die Abfolge der Elemente wird in einer "Regel", der DTD (Document Type Definition) gespeichert. Mit Hilfe eines Programms, dem sog. Parser, wird die regelkonforme Erstellung des Dokuments geprüft.
Zusatzinformationen
Nach dieser Prüfung können mit Hilfe von weiteren Programmen die Zusatzinformationen ausgewertet werden. Da in den SGML/XML-Quelltexten zunächst keine Layoutinformationen enthalten sind, kann so z.B. ein (teil-)automatisiertes Formatieren der Dokumente durchgeführt werden. Dies führt gegenüber dem manuellen Layouten zu einer Zeit- und somit Kostenreduzierung, außerdem erhält man in jedem Fall ein durchgängig einheitliches Erscheinungsbild. Für die Umsetzung in ein vorgegebenes Layout stehen verschiedene Möglichkeiten zur Verfügung. Stichworte sind hier DSSSL/XSL-FO, FOSI und FrameMaker+SGML. Über diese bzw. ähnliche Programmierungen können die Quelldokumente auch z.B. in HTML für Online-Hilfen oder in Präsentationen für das Intra- oder Internet umgewandelt werden - man spricht in diesem Fall von Single-Source-Publishing.
Kundennutzen
In der Anwendung besteht mit den vorgenannten Dokumentformaten z.B. die Möglichkeit, dass die Einzeldokumente verschiedener Maschinen (oder Geräte) in einem einzigen großen Dokument abgelegt sind, wobei Textpassagen, die in den diversen Einzeldokumenten identisch sind, nicht redundant gespeichert sind. Um nun ein bestimmtes Einzeldokument auszugeben, wird ein (frei konfigurierbarer) Filter auf das große Gesamtdokument gelegt und es kann exakt die gewünschte Dokumentation ausgefiltert werden. Hierdurch lässt sich sogar die gesamte Revisionierung in einem einzigen Dokument realisieren. Durch die Vermeidung von Redundanzen ist die Dokumentation äußerst konsistent und Übersetzungskosten können leichter gesenkt werden.
Wir sehen unsere Aufgabe darin, aus der Erstellung der Technischen Dokumentation mit strukturierten Dokumentformaten und den (kundenspezifischen) Zusatzinformationen einen möglichst großen Nutzen für den Kunden zu ziehen - SGML/XML darf keinesfalls zum Selbstzweck werden. Ein weiterer Vorteil von SGML/XML ist eine größtmögliche Zukunftssicherheit der damit erstellten Dokumente: SGML ist als ISO-Standard ISO 8879:1986 verabschiedet worden, XML ist eine W3C Empfehlung. Die Texte sind plattform- und herstellerunabhängig abgelegt. Diese Vorteile alleine rechtfertigen aber aus unserer Sicht noch nicht die Umstellung der kompletten Technischen Dokumentation auf dieses Format.
Vielmehr können durch die genannten Techniken die heutigen, durch die Varianten- und Modellvielfalt entstandenen Probleme bei der Dokumentationserstellung gelöst werden. Die mehrfache und somit zeit- und kostenintensive Pflege gleicher Texte gehört endlich der Vergangenheit an.
Einsatzbereiche
SGML wird bereits seit längerer Zeit bei großen Industrieunternehmen aus der Luftfahrt- und der Automobilindustrie eingesetzt. Hier ist auch das einfache und einheitliche Einbinden der Dokumente von Zulieferern ein Thema. Durch Eigenentwicklungen haben wir die Anwendung von SGML/XML seit einigen Jahren auch bei mittelständischen Unternehmen ermöglicht, wo die Kosten traditionell eine wesentlich größere Bedeutung haben als in der Großindustrie.
Setzen Sie sich mit uns in Verbindung. Wir präsentieren Ihnen gerne, wie Sie durch den Einsatz von strukturierten Dokumentformaten Zeit und Kosten bei der Dokumentationserstellung sparen können. Außerdem können Sie einfach und schnell zielgruppenspezifische Dokumentationen erzeugen und haben ein enorm leistungsfähiges Werkzeug für ein Variantenhandling zur Verfügung.
Aufgrund unserer Erfahrung in der Erstellung von Dokumentationen mit strukturierten Dokumentformaten haben wir unser eigenes Redaktionssystem DART entwickelt.
