Modularisierung von technischer Dokumentation
Warum ein Redaktionssystem? Ohne Modularisierung ist die Erstellung von Produktdokumentationen in den meisten mittelständischen Unternehmen oder in großen Konzernen kaum vorstellbar. Trotz Qualitätssicherung der einzelnen Dokumentationsbausteine kommen jedoch immer wieder kritische Rückmeldungen von Endkunden im In- und Ausland über die Qualität der Dokumentation.
Der Grund hierfür liegt nahe: Vor lauter Einzelteilen wird das Ganze oft nicht gesehen. Eine Dokumentation kann in Deutsch oder in Fremdsprachen mehrere Hundert Seiten umfassen. Das entspricht einer großen Anzahl an Informationsbausteinen, die unterschiedliche Autoren über Jahre verfasst haben. Bei Übersetzungen sind sogar deutlich mehr Einheiten und Urheber beteiligt, da die Basiseinheiten von Translation-Memory-Systemen einzelne Segmente (i. d. R. Sätze) sind. Nicht selten ist der Wiederverwendungsanteil dieser Bausteine in der Dokumentation recht hoch. Es kann durchaus vorkommen, dass bei einem Handbuch von 500 Seiten nur 50 neu erstellt bzw. geändert und dass daraus sogar nur 20 Seiten übersetzt werden. Die Qualitätssicherungsprozesse bleiben jedoch voll auf diese 50 bzw. 20 Seiten fokussiert, obwohl der Endkunde das komplette Handbuch von 500 Seiten bewertet.
Welche Probleme können zu Unstimmigkeiten im ganzen Dokument führen?
Sie betreffen:
- die Terminologie,
- die Formulierungen,
- den Informationsgehalt,
- die Informationsstruktur und manchmal auch
- das Layout.
Die Terminologie eines Unternehmens ist nie in Stein gemeißelt. Es kommen neue Begriffe und Benennungen hinzu. Einzelne Benennungen als „erlaubt“ oder „verboten“ festzulegen, ist ein fortwährender Prozess. Manche Begriffe, die sich beispielsweise auf bestimmte Produkte, Funktionen oder Produktionsverfahren beziehen, sind überholt und müssten eigentlich aus älteren Informationsbausteinen verschwinden. Daneben beeinflussen neue Normen oder gesetzliche Bestimmungen die verwendete Terminologie.
Schreibregeln betreffen verschiedene Merkmale von Texten: Fachtermini, Syntax, Satzlänge, Anweisungsstil, Aufbau von Softwaremeldungen usw. Diese Regeln wachsen und ändern sich mit der Zeit. Dadurch entsprechen ältere Bausteine nicht immer den aktuellen Vorgaben.
Aus verschiedenen Gründen ist der Informationsgehalt immer kritisch. Der Autor erstellt sein Modul zu einem bestimmten Zeitpunkt und versucht dessen Inhalt relativ neutral zu formulieren, damit es in möglichst vielen Dokumentationen einsetzbar ist. Er verwendet beispielsweise für manche Teile einen allgemein gehaltenen Oberbegriff wie „Motor“ anstatt „Gleichstrommotor“. Wenn ein Autor dieses Modul später für die Dokumentation einer speziellen Maschine oder Anlage verwendet, ist es eventuell inhaltlich nicht mehr zutreffend. Das ist insbesondere der Fall, wenn bei anderen Modulen eine deutlich präzisere Terminologie verwendet wird, wenn die Übersetzung eines Unterbegriffs andere Stammwörter bedingt (Anzeige = display; LED-Anzeige = LED display, Tankanzeige = fuel gauge) oder wenn die Software oder Maschine Funktionen und Eigenschaften besitzt, die zu den allgemein gehaltenen Formulierungen nicht mehr kompatibel sind. Mit solchen Situationen wird der Übersetzer immer wieder konfrontiert. Er hat nicht jedes Mal die Möglichkeit gegenzusteuern, wenn er aus Kostengründen vorhandene Übersetzungen ungeprüft übernehmen muss.
Ein weiterer Aspekt problematischer Modulinhalte betrifft die sog. referenziellen Informationen. Bei seiner Erstellung bezog sich das Modul auf eine konkrete Situation. Etwa die Beschreibung eines Ablaufs, den Einbau einer Komponente oder die Durchführung eines Arbeitsschrittes. Dabei stellt der Autor einen Bezug auf Komponenten, Eigenschaften, räumliche Positionen, Arbeitsabläufe, Risiken usw. her, die in anderen Modulen dokumentiert sind. Sobald Bezugselemente aus diesen weiteren Modulen fehlen oder aufgrund des Zusammenhangs eine andere Bedeutung annehmen, stimmt der Informationsgehalt des Moduls nicht mehr. Das kann zu Fehlhandlungen führen.
Schließlich kann die Informationsstruktur der Arbeit mit Modulen zum Opfer fallen. Besonders bei der Verwendung älterer Informationsbausteine können abweichende Informationsstrukturen vorkommen. Etwa bei „Warnung – Voraussetzung – Schritte – Ergebnis“ anstatt „Voraussetzung – Warnung – Schritte – Ergebnis“.
Gesamtdokument am Ende prüfen
Eines steht fest: Ohne Endprüfung des Gesamtdokuments (Original oder Übersetzung) besteht das Risiko, dass trotz akkurater Prüfung aller einzelnen Module das Gesamtergebnis fehlerhaft ist. Die Gefahr hängt von verschiedenen Faktoren ab wie dem Anteil an wiederverwendeten Modulen (oder Übersetzungen), dem Alter wiederverwendeter Bausteine oder dem Grad der „Produktneutralität“ der Informationen.
Aus Zeit- und Kostengründen ist es natürlich schwer oder gar unmöglich, jedes Mal komplette Dokumentationen zu prüfen. Das gilt besonders dann, wenn der Wiederverwendungsanteil aus dem Redaktionssystem relativ hoch ist. Hier müsste man zwischen maschinenprüfbaren Aspekten wie die Einhaltung einer bestimmten Terminologie und manuell prüfbaren Aspekten unterscheiden. Die maschinell prüfbaren Aspekte lassen sich gut einschränken und im Gesamttext systematisch umsetzen. So kann man etwa 10 bis 20 Schlüsselbegriffe festlegen, die immer auf Konsistenz oder Kontext zu prüfen sind. Das betrifft u. a. Oberbegriffe, die nicht zu jeder Dokumentation passen oder verfahrensabhängige Benennungen, die je nach Zusammenhang unterschiedlich eingesetzt werden sollen. Einige formelle Aspekte wie der Gebrauch der Aktivform für Befehle oder eine maximale Satzlänge lassen sich ebenfalls halbautomatisch prüfen.
Die Prüfung anderer inhaltsbezogener Aspekte ist leider nicht automatisierbar. Bei Produktfamilien oder bestimmten Produktionsmethoden (z. B. Einsatz von Attributen, Variablen) kann es reichen, repräsentative Gesamtdokumente ein- bis zweimal im Jahr eingehender zu prüfen.
Schließlich besteht immer die Möglichkeit, den Übersetzer heranzuziehen, der gewissermaßen die Qualitätskontrolle der Ausgangsdokumentation durchführt. Er müsste allerdings die Prüfung des gesamten Texts unter Verwendung von Translation Memorys als expliziten Auftrag erhalten.
Fazit
Wir leben in einer Zeit, in der die Dokumentation einen wachsenden Stellenwert erhält und für die Kundenzufriedenheit wichtig ist. Eine regelmäßige Prüfung von Gesamtdokumenten ist daher für die Qualität der gelieferten Dokumentation unabdingbar.
