xml

XML-basierte Standards für die technische Dokumentation – Teil 1

Die Veränderungen, die die Welt der technischen Kommunikation in den vergangenen 20 Jahren überrollt hat, sind mit dem Sektor der Maschinenbauer (Sondermaschinenbau) nur teilweise in Berührung gekommen, da diese meist an den traditionellen Systemen zur Redaktion und Übersetzung der technischen Dokumentation hängen. Die Gründe für nicht erfolgte Veränderungen in diesem Bereich liegen sicher nicht in der fehlenden Weitsichtigkeit: Wenn die deutschen Hersteller international als die technologisch fortschrittlichsten gelten, ist dies darauf zurückzuführen, dass sie besser und vor den anderen die Bedürfnisse eines immer leistungsstärkeren und anspruchsvolleren Produktionsbereichs erkannt haben. Die wirklichen Gründe liegen allenfalls in einer fortlaufenden und blitzschnellen Evolution der Technologie und der Anpassungsfähigkeit an den Markt, was in der Produktion und Installation von Turn-Key-Lösungen  zum Ausdruck kommt, die auf den Nutzer zugeschnitten gebaut werden.

Auch wenn also praktisch keinem technischen Büro entgangen ist, dass durch die Verwendung eines CCMS-Systems vermieden werden kann, dass dieselben Inhalte wiederholt geschrieben werden, dass durch den Einsatz eines CAT-Tools Kosten für Übersetzungen eingespart und die Terminologie vereinheitlicht werden kann, und dass mit dem Gebrauch von optimierter Software zur Redaktion von Anleitungen bessere Leistungen in Bezug auf Grafik bzw. Aufbau der Unterlagen erreicht werden können, geschieht es jedoch häufig, dass von keiner dieser Verbesserungen Gebrauch gemacht wird.

Nicht nur die Leistungsfähigkeit dieser Systeme ist aufgrund der Schwierigkeit, kurzfristig eine befriedigende technologische Standardisierung zu erreichen, unbefriedigend ausgefallen. Es stellte sich auch die große Hürde, zu entscheiden, welche Systeme gemeinsam zur Anwendung kommen sollten – ganz abgesehen von den Kosten zum Erwerb der Lizenzen für die Schulung des Personals, dessen Aufgabe es ist, die Unterlagen zu überprüfen. Wenn im Bereich der Übersetzungssoftware die Wahl nicht so schwierig war (SDL und Across teilen sich allein fast den gesamten Markt), ist die Auswahl im Bereich CCMS und Redaktionssoftware fast unbegrenzt. Nachdem schließlich eine Entscheidung getroffen wurde, stellt sich dann die Frage, wie die Dokumentation verwaltet werden kann.

Nach diesen Abwägungen braucht man sich nicht zu wundern, wenn viele Hersteller zur Erstellung eines neuen Handbuches das einer ähnlichen Maschine abändern, bis zuletzt Änderungen vornehmen (manchmal bis zum Tag vor der offiziellen Abnahme), die Abschnitte markieren, die zu übersetzen sind und sie dann der Übersetzungsagentur schicken, mit der sie gerade zusammenarbeiten. Dabei setzen sie dann diese unter Druck, um die Übersetzung so schnell wie möglich zu erhalten, weil der Auftraggeber der Maschine diese sonst nicht annimmt.

Dieses System, das die TEKOM und wir für mittelalterlich halten, das jedoch von den kleinen Maschinenherstellerbetrieben (zumindest kurzfristig) als das einzig mögliche gehalten wird, ist dazu verdammt, von XML-basierten Standards weggefegt zu werden.

DITA war ein Standard, der bereits die Arbeitsweise in der technischen Dokumentation geprägt hat, aber in vielen Bereichen inzwischen als überholt angesehen wird. Der neueste Standard iiRDS geht in den Bereich Industrie 4.0.

Gehen wir heute erst einmal auf den älteren Standard ein, der die technische Redaktion beeinflusst hat. Was ist DITA XML? Es handelt sich dabei um einen Standard, der keinen Eigentümer hat und auf alle Formate angewendet werden kann und weder eine besondere Software noch besondere Lizenzen benötigt. Mit diesem Standard werden Texte von der Grafik, dem Seitenlayout und den Übersetzungen gelöst – und alles auf völlig transparente Art. Mit DITA XML können austauschbare Formulare mit unterschiedlichen Anwendungsmöglichkeiten verfasst werden. Per Mausklick wird der Unternehmensstil geändert, oder ein neues Layout ausgewählt. Wie man sieht: XML – und nicht nur DITA – sind layoutunabhängig und bieten dadurch große Flexibilität.

DITA basiert auf Topics, die eine klare und einheitliche Struktur haben. Somit hat dieser Standard auch eine neue Arbeitsweise geprägt: DITA kann auch als Redaktionsleifaden und Schreibmethode betrachtet werden.

Die Topics sind unterteilt in:

  • Konzept
  • Arbeitssequenz
  • Referenzen

Jede Topic-Art hat einen anderen Aufbau und andere stilistische Eigenschaften. So können auch mehrere technische Redakteure nach dem gleichen Arbeitsprinzip arbeiten. Dank eines gleichen Arbeitsprinzips und eines Leitfadens können Unternehmen ihre technische Redaktion intern und extern mit gleichen Kriterien schreiben lassen. Wie schon gesagt – DITA ist nicht nur ein Standard, sondern eine Arbeitsmethode, die Grundlage war und ist für topic- oder knotenbasiertes Schreiben nach Funktionsdesign und Redaktionsleitfaden.

DITA hat die technische Redaktion stark beeinflusst. Neue Methoden wurden entwickelt und dienten als Grundlage für die neuen XML Standards und Technologien. Heute gehen wir den Trend unsere Informationen nicht nur gedruckt oder in Online Help-Systemen zu veröffentlichen. Heute stehen wir vor der Herausforderung, unsere Inhalte auch auf digitalen Plattformen zu übermitteln. Die Maschinen agieren immer mehr mit den Menschen und genau darüber möchten wir in unserem nächsten Blog sprechen.

Wenn Sie weg wollen von der traditionellen Redaktion hin zur modularen technischen Dokumentation, kontaktieren Sie uns unter: info@because-germany.com

Diesen Artikel teilen

Share on facebook
Share on xing
Share on twitter
Share on linkedin
Share on print
Share on email

Schreibe einen Kommentar