Konsistenz in der Technischen Dokumentation

(Auszug aus "DITA - Der neue Standard für Technische Dokumentation" von Johannes Hentrich)

Konsistenz ist ein wesentliches Qualitätsmerkmal von guter Technischer Dokumentation. Konsistenz ist kein Selbstzweck, sondern dient dazu, Nutzern von Technischer Dokumentation die Aufnahme von Informationen so leicht wie möglich zu machen. Wird ein Nutzer beispielsweise am Anfang eines Dokuments mit einem neuen Begriff vertraut gemacht, so kann er in einem konsistenten Dokument davon ausgehen, dass der Begriff genau in derselben Weise verwendet wird, wenn er an weiteren Stellen im Dokument aufgeführt wird. Ist jedoch ein Autor „kreativ“, so wird es für den Nutzer sehr schwierig zu erkennen, welche unterschiedlichen Begriffe das Gleiche meinen. Damit wird vom Nutzer wesentlich mehr Lernaufwand gefordert, als notwendig wäre. Hier wird vom Nutzer ein Lernen verlangt, das für ihn in keinerlei Weise nützlich ist, das heißt, er erhält kein Wissen, das für die eigentliche Bedienung des Produkts notwendig ist.

Obwohl die Bedeutung von Konsistenz jedem Technischen Redakteur wohlbekannt ist, weiß auch jeder Technische Redakteur, wie schwierig es manchmal sein kann, die gewünschte Konsistenz in die Praxis umzusetzen. Die Gründe dafür sind vielfältig:

• Mehrere Technische Redakteure arbeiten zu unterschiedlichen Zeitpunkten und vielleicht auch an unterschiedlichen Orten an der Technischen Dokumentation.
• Trotz Festlegungen zur Konsistenz gibt es zu viel Spielraum für Eigeninterpretationen.
• Gleiche oder ähnliche Informationen für unterschiedliche Dokumente werden häufig parallel nebeneinander neu entwickelt.
• Bei der Produktion für unterschiedliche Ausgabemedien gabelt sich früher oder später der Bearbeitungsweg, sodass an den einzelnen Ausgabemedien separat weitergearbeitet wird.

Zudem kann unter Umständen die Redaktionsumgebung nur schwer oder schwerfällig die Erstellung von konsistenten Dokumenten unterstützen.

In der Technischen Dokumentation kann auf mehreren Ebenen eine konsistente Vorgehensweise angewendet werden. In den folgenden vier Abschnitten werden die Bereiche vorgestellt, bei denen eine konsistente Anwendung häufig versagt:

• Terminologie
• Formulierungsmuster
• Strukturierung von Informationen
• Layout

Terminologie

Eine der ersten Regeln, die ein Technischer Redakteur lernt, lautet: Gleiche Dinge sind stets gleich zu benennen. Dies bedeutet oft die Abkehr von der „kreativen“ Art des Schreibens, das heißt, möglichst viele unterschiedliche Worte für einen Sachverhalt zu finden.

Wie im oberen Abschnitt bereits erwähnt wurde, sorgt eine einheitliche, das heißt konsistente Terminologie dafür, dass der Nutzer einmal Gelerntes wiederverwenden kann. Auch entscheidet die Verwendung einer konsistenten Terminologie darüber, ob in elektronischen Medien mit ihren Suchmöglichkeiten die Inhalte auch tatsächlich gefunden werden können.

Für den Technischen Redakteur bieten sich etliche Vorteile, wenn er mit einer konsistenten Terminologie arbeitet. So braucht er sich nicht jedes Mal wieder neu zu überlegen, wie bestimmte Bestandteile eines Produkts zu benennen sind. Arbeitet sie mit einer Terminologieliste oder -datenbank, kann sie bequem auf alle Begriffe zurückgreifen, die sie für die Dokumentation eines Produkts benötigt. Liegt eine solche Terminologieliste vor, können auch Übersetzungen viel schneller und effizienter erstellt werden. Mit einer Übersetzung einer Terminologieliste wird damit meist mehr als nur ein Grundgerüst für die weitere Übersetzung geschaffen.

Obwohl ein Dokumentationsstandard wie DITA die Verwendung von konsistenter Terminologie unterstützt, kann er keine Methode bieten, die überprüft, ob die Terminologie tatsächlich konsistent verwendet wird. Mit DITA können die Begriffe, die für eine Terminologieliste oder -datenbank vorgesehen sind, gekennzeichnet und dann bei Bedarf über eine Referenz in ein Topic eingefügt werden.

Für DITA macht es keinen Unterschied, ob einzelne Begriffe, einzelne Sätze oder ganze Absätze gekennzeichnet werden, damit sie zu einem späteren Zeitpunkt wiederverwendet werden können. Der Mechanismus, der verwendet wird, ist stets derselbe. Inhalte wiederverwenden mit Maps und conref gibt detailliert Auskunft über den in DITA verwendeten Mechanismus.

Somit besteht nach wie vor die Aufgabe eines Technischen Redakteurs darin, eine Terminologieliste aufzubauen und zu pflegen und zu entscheiden, wann ein Begriff aus der Terminologieliste in die Technische Dokumentation eingefügt werden muss.

Mit DITA ändert sich allenfalls die Mechanik, das heißt, wie Begriffe für eine Terminologieliste gekennzeichnet werden müssen und wie sie wieder aus einer Terminologieliste in ein Topic eingefügt werden können. Eine entsprechende Redaktionsumgebung kann der Technische Redakteur bei der Umsetzung dieser Mechanik unterstützen.

Formulierungsmuster

Nicht nur mit einzelnen Begriffen, die konsistent über ein Dokument hinweg verwendet werden, ist dem Nutzer geholfen, sondern auch mit ganzen Satzstrukturen und -mustern. Sind Handlungsanweisungen oder Resultate stets nach dem gleichen Muster aufgebaut und formuliert, so unterstützt dies die Nutzer dabei, Informationen schneller aufnehmen und anwenden zu können.

Betrachtet man sich die Informationen genauer, die beispielsweise in einer Bedienungsanleitung notwendig sind, so lassen sich praktisch für alle Informationseinheiten Formulierungsmuster definieren, die sich wiederverwenden lassen. Wie bei der Verwendung von konsistenter Terminologie liegen sowohl für den Nutzer als auch für einen Technischen Redakteur die Vorteile auf der Hand. Sind Formulierungsmuster erst einmal definiert, müssen diese nicht immer wieder neu entwickelt werden. Und auch bei der Übersetzung ergeben sich ähnliche Vorteile wie bei der Verwendung von konsistenter Terminologie.

Wie bereits im vorherigen Abschnitt beschrieben, unterscheidet sich der Mechanismus zur Wiederverwendung von Informationen – handelt es sich nun um Begriffe oder Formulierungsmuster – bei DITA nicht. Mit einem Standard wie DITA wird nur ein Mechanismus zur Wiederverwendung von Informationen bereitgestellt. Wie die Formulierungsmuster aussehen sollen oder welche Formulierungsmuster es zum Beispiel für einen Topictyp „Aufgabe“ geben soll, ist mit DITA nicht festgeschrieben. Dies muss unabhängig von DITA festgelegt werden, beispielsweise in einem Redaktionsleitfaden.

Strukturierung von Informationen

Wesentlich für einen Nutzer von Technischer Dokumentation ist, wie Informationen strukturiert sind. Strukturierungsmethoden wie das Information Mapping™ und das Funktionsdesign tragen diesem Bedürfnis Rechnung. Sie liefern als Ergebnis strukturierte Inhalte, die vom Nutzer leicht erfasst werden können.

Mit dem Topic als zentrale Informationsstruktur und den Topictypen als Ausprägungen für die möglichen Informationstypen gibt DITA ein Grundgerüst vor, wie Informationen zu strukturieren sind. Betrachtet man die Struktur der Topictypen im Einzelnen, wird man feststellen, dass die Grundgerüste der einzelnen Topictypen sehr einfach gestrickt sind, und damit zunächst einmal kaum die strengen Vorgaben liefern, die in der Technischen Dokumentation häufig notwendig sind. Beispielsweise sind im Topictyp „Aufgaben“ nur Elemente für die einzelnen Schritte einer Handlungsanweisung vorgeschrieben. Elemente, die definieren, welche Voraussetzungen gegeben sein müssen, damit eine Aufgabe ausgeführt werden kann, oder die Definition eines Ziels einer Aufgabe sind ebenso optional wie die Ergebnisbeschreibung einer Aufgabe.

DITA definiert also nur in einem sehr geringen Maße, wie die Inhalte in einem Topictyp erstellt werden müssen. In der Praxis sind diese Vorgaben für einen Technischen Redakteur zu unspezifiziert, als dass sie den Erstellungsprozess eines Topics unterstützen könnten.

Da die Informationsstruktur in einem Topic von DITA nur in einer sehr schwachen Weise vorgegeben wird, ist auch hier die Konsistenz nicht automatisch gesichert. Somit sind weitere Hilfsmittel notwendig, wie beispielsweise ein aus dem Funktionsdesign resultierender Redaktionsleitfaden oder eine Methode, wie das Information Mapping™, über die definiert werden kann, wie Inhalte konsistent erstellt werden sollen. Solche erstellten Inhalte, die wiederverwendet werden sollen, können in DITA gekennzeichnet und somit dem Mechanismus zur Verwendung von Inhalten zur Verfügung gestellt werden.

Darüber hinaus ist die Wiederverwendung ganzer Topics in DITA von zentraler Bedeutung. Über Maps können Topics für unterschiedliche Dokumente und unterschiedliche Medien zusammengestellt werden. Die einmal erstellten und zentral gespeicherten Topics sorgen bei einer Mehrfachverwendung dafür, dass sich in den erstellten Dokumenten der entsprechenden Medien die gleichen Informationen befinden. Damit wird ein Maß an Konsistenz erreicht, das zu erreichen in der Praxis häufig einen erheblichen Aufwand bedeutet, wenn nicht mit DITA gearbeitet wird.

Layout

Wenn es um Konsistenz in der Technischen Dokumentation geht, treten in der Praxis die geringsten Schwierigkeiten bei der Einhaltung eines konsistenten Layouts auf. Häufig werden Satzprogramme wie zum Beispiel FrameMaker verwendet, mit denen Masterdokumente definiert werden, in denen der Satzspiegel, die Position der Kopf- und Fußzeilen, die verwendeten Absatzformate, die verwendeten Schriften usw. definiert werden können. Damit wird sichergestellt, dass die erstellten Dokumente zumindest optisch ähneln.

Schwieriger wird es, ein konsistentes Layout zu handhaben, wenn man mit einfachen Textverarbeitungsprogrammen arbeitet. Zwar bieten diese inzwischen auch zahlreiche Funktionen für die Layoutgestaltung an, jedoch reichen diese bei Weitem nicht an die Funktionen von professionellen Layout- beziehungsweise Satzprogrammen heran. Dass dennoch so zahlreich Textverarbeitungsprogramme in der Technischen Dokumentation verwendet werden, liegt häufig daran, dass zum einen Textverarbeitungsprogramme zur Erstellung von Dokumenten, wie zum Beispiel Briefen, bereits vorhanden sind, und zum anderen, dass mit ihnen der Austausch von Dokumenten leichter fällt, sei es mit Entwicklern oder Mitarbeitern in anderen Ländern. Allerdings wird dann die Einhaltung eines konsistenten Layouts tatsächlich zu einem echten
Problemfall.

Die Konsistenz des Layouts ist sowohl bei Textverarbeitungs- als auch bei Satzprogrammen gefährdet, wenn neue Inhaltselemente hinzukommen, wenn für neu hinzugekommene Inhalte neue Formen der Auszeichnung oder wenn neue Formatierungen gefunden werden müssen. Hier ist häufig ein schleichender Prozess der „Aufweichung“ des Layouts zu beobachten bis hin zur Haltung „Hauptsache die Inhalte sind drin“.

Wie die Praxis zeigt, ist die Weiterentwicklung von Dokumenten und deren Layout, wenn beispielsweise neue Inhaltselemente aufgenommen werden müssen, eher die Regel als die Ausnahme. Bei DITA wird diesem Tatbestand daher auch große Bedeutung beigemessen. Mit dem Mechanismus der Spezialisierung wird dafür gesorgt, dass neue Elemente nur nach vorgegebenen Regeln erzeugt werden können. Eine Ad-hoc-Einführung neuer Elemente ist damit nicht möglich. Mit dem DITA Open Toolkit wird dafür gesorgt, dass die neuen Elemente auch verarbeitet werden können. Gibt es noch keine Formatierungsanweisungen für die neuen Elemente, so werden die Formatierungsanweisungen der Elemente herangezogen, die als Basis für die Spezialisierung dienten.

Somit bietet DITA als Gesamtpaket, das heißt, die DITA DTDs und das DITA Open Toolkit, eine Umgebung, die dafür sorgt, dass ein konsistentes Layout, sei es für Print- oder Online-Dokumente, praktisch automatisch erzeugt wird. Da der Produktionsmechanismus nicht so ohne weiteres ausgetrickst Werden kann, bleibt er im Gegensatz zu vielen anderen Elementen in der Technischen Dokumentation vor „kreativen“ Ideen häufig verschont.

  

<< zurück

vor >>