Einsatz von SGML/XML in der technischen Dokumentation
FrameMaker gibt es in zwei Varianten: "FrameMaker" für die Erstellung/Bearbeitung von FrameMaker-Dateien und "FrameMaker with SGML" für die Erstellung/Bearbeitung von Dokumenten in der Dokumentenbeschreibungssprache SGML (Standard/Structured General Markup Language; HTML, HyperText Markup Language, ist letztlich lediglich eine spezifische Ausformung von SGML). Seit Version 7 werden beide Varianten in einem Paket verkauft, so dass beim Kauf noch keine Vorentscheidung fallen muss, ob ich FrameMaker als "traditionelles" Layoutprogramm oder als Editor für SGML-Dateien verwenden möchte.
Von den Vordenkern der technischen Dokumentation wurde bis ungefähr Ende der 90er Jahre des letzten Jahrhunderts SGML eine großartige Zukunft innerhalb der technischen Dokumentation vorausgesagt, weil in den Arbeitsergebnissen Inhalt und Layout komplett voneinander getrennt sind und somit der Wiederverwertung der Inhalte in ganz anderen Dokumenten und/oder Medien keine Hürden entgegen stehen. Zwischenzeitlich ist SGML ein wenig in den Hintergrund getreten, dafür ist die vereinfachte Variante, XML (eXtended Markup Language) auf die Bühne getreten, um die Versprechungen, die in Zusammenhang mit dem dann doch zu komplexen SGML gemacht wurden, einzulösen.
Zu diesem Thema entwickelte sich in einer Mailingliste die folgende kurze Diskussion, die den aktuellen Stand wohl recht treffend beschreibt. (Bitte beachten Sie, dass SGML/XML nicht grundsätzlich abgelehnt wird, die Bewertung sich auf die typischen Aufgaben in der technischen Dokumentation und die heute, Mai 2004, verfügbaren Werkzeuge bezieht.)
Anfrage (eines bei einem Hersteller angestellten Redakteurs)
wir denken darüber nach, für die Erstellung von Technischer Dokumentation (Broschüren, Datenblätter, Betriebsanleitungen) künftig XML einzusetzen, um die gemeinsame Nutzung von Daten in den verschiedenen Publikationen zu vereinfachen. Die Nutzung in Intranet und Internet ist zunächst nicht in unsere Überlegungen einbezogen.
Nachdem wir in einem Crash-Kurs einen ersten Einblick in die XML-Welt bekommen haben, beschleichen uns jedoch so langsam gewisse Zweifel, ob überhaupt der Aufwand, der offenbar mit dem Einsatz von XML verbunden ist, angesichts unseres Dokumentationsumfangs (ca. 70 Publikationen, Gesamtumfang ca. 1800 Seiten pro Sprache, 2 Redakteure) gerechtfertigt ist.
Daher möchte ich versuchen, über diese Mailingliste Kontakt zu solchen Kollegen aufzunehmen,
|
Antwort 1 (von uns)
Persönlich denke ich, Sie sollten genau prüfen, welche Vorteile Sie sich von einer Umstellung erwarten (zwingende Vorteile) und erwünschen (optionale Vorteile). Als nächstes stellt sich dann die Frage, welche anderen Lösungen es vielleicht gäbe. Schon zu SGML-Zeiten war ich immer sehr interessiert an dem Thema, musste aber immer wieder feststellen, dass es sich für unsere Anforderungen nicht lohnt (was logischer Weise auch mit der Auftragsstruktur zusammen hängt). XML hat daran nichts verändert.
> um die gemeinsame Nutzung von Daten in den
> verschiedenen Publikationen zu vereinfachen.
Nach meiner Erfahrung liegen da unheimlich viele Pferdefüße vergraben. In Theorie sieht das wunderbar aus, in Praxis ist es mit Automatismen recht bescheiden, weil irgendwelche Details dann doch Handarbeit erfordern. Wenn ich die Daten vorab schon so detailliert aufbereiten will, dass die Wiederverwendung dann unter allen Umständen möglich ist, würde ich häufig mit dem Erstexemplar erst fertig, wenn auch die letzte Wiederverwendung umgesetzt ist … Das Problem ist das Konzept und die Strukturierung, nicht die Technologie, mit der ich dann Konzept und Struktur umsetze.
Antwort 2 auf Antwort 1 (ebenfalls von einem Dienstleister)
Da haben Sie mir richtig aus der Seele geschrieben! Genau so isses. Für uns als Dienstleister wird es noch sehr lange dauern, ehe wir auch für den Kunden attraktive Ergebnisse auf XML-Basis anbieten können. XML steckt nach wie vor in der anwendungstechnischen Steinzeit.
Nachtrag (April 2005)
Ein Jahr später entspann sich in derselben Mailingliste noch einmal die
Diskussion um den Einsatz von XML in der kleinen Redaktion (die keine
unternehmensweiten Lösungen mit einer Vielzahl von beitragenden Mitarbeitern
sucht). Es beteiligte sich auch ein XML-Experte aus dem Hamburger Raum, der
vehement für XML auch in kleinen Redaktionen warb — unter anderem mit
Vorteilen im Übersetzungsprozess, wobei die tatsächlich benannten Vorteile
auch mit "konventionellen" Mitteln erreichbar sind, siehe
FrameMaker-Dateien effektiv übersetzen.
Auch auf Nachfrage blieb der XML-Experte ein konkretes Beispiel aus der
Praxis schuldig, bei dem XML in der kleinen Redaktion mit Gewinn eingesetzt
worden wäre (oder bei dem auch nur theoretisch ein Vorteil für XML bestehen würde).
Quelle
>> Deutschsprachige Mailingliste fuer Technische Redakteure: t-allgem
>> An- und Abmeldung über 
Mailinglisten
InvitationWare
- Invitation (Englisch): Einladung
- Invitation for tender: Ausschreibung
Die Informationen auf www.transcom.de sind InvitationWare: Einerseits sind Sie eingeladen, sie zu nutzen. Andererseits, wenn die Informationen auf diesen Seiten Ihnen geholfen haben oder die Tipps und Programme für Sie nützlich sind, dann erinnern Sie sich doch an Transcom, wenn Sie mal wieder einen Auftrag in einem unserer Fachgebiete zu vergeben haben — und senden uns eine Einladung zum Angebot. Rufen Sie uns an oder senden uns eine E-Mail.