Mal ganz praktisch: Standardisierung von Dokumenten

Standardisierung – das Thema ist ein Klassiker im Repertoire der Technischen Dokumentation, aber ist heute so aktuell wie nie. Warum wir zu dieser Einschätzung kommen und wie das mit dieser Standardisierung eigentlich funktioniert ist das Thema dieses Beitrags.

Wenn wir den Auftrag bekommen, bei der Standardisierung der Technischen Dokumentation zu unterstützen, lassen wir uns üblicherweise mehrere aktuelle Dokumente zeigen und analysieren diese hinsichtlich verschiedener Kriterien. So können wir uns einen guten Überblick darüber verschaffen, wo bereits ein einheitliches Vorgehen zu erkennen ist und wo es noch Optimierungspotenzial gibt. Lassen Sie uns doch mal ein paar kleine Beispielszenarien betrachten, um das Thema aus verschiedenen Perspektiven zu veranschaulichen.

Einheitliche Struktur gibt Halt

Nehmen wir an, ein Kunde kauft mehrere verschiedene, aber vergleichbare Produkte „Bick“, „Brick“ und „Brack“ von demselben Hersteller. Bei der Suche nach einer bestimmten Information wird er in der Dokumentation von „Bick“ fündig. Auch in der Dokumentation von „Brick“ findet er die Infos – aber nicht an der gleichen Stelle wie bei „Bick“. Die Suche dauert also länger. Und auch in der „Brack“-Dokumentation ist die Information zwar vorhanden, aber wiederum unter einer anderen Überschrift und an anderer Stelle zu finden.

So geht es besser:
Hätte der Kunde nur ein Produkt gekauft, wäre das vielleicht gar nicht aufgefallen, aber im Vergleich zeigt sich: Ein einheitlicher Dokumentaufbau unterstützt nachhaltig beim Umgang mit der Dokumentation und dem Produkt.

Für die Technische Redaktion selbst ergibt sich ebenfalls ein Vorteil: Bei einer standardisierten Dokumentstruktur stellt sich die Frage, wo eine Information bei der inhaltlichen Bearbeitung einsortiert werden muss, kaum noch. Die Erstellung der Dokumentation geht auf diese Weise reibungsloser von der Hand.

Der individuelle Stil des Autors – hier lieber nicht

Die oben schon erwähnte Dokumentation zu „Brick“ wurde von Moofy erstellt, der spricht die Leserschaft gerne mit „Sie“ an. Die Dokumentation von „Brack“ lag in der Verantwortung seiner Kollegin Maisy. Sie formuliert gerne unpersönlicher mit Infinitivkonstruktionen.

Moofy weiß – zum Glück, denkt er – von diesem Unterschied. Deshalb ändert er jedes Mal, wenn er Textzeilen aus den Anleitungen seiner Kollegin übernimmt, die entsprechenden Stellen noch ab, damit sein Dokument konsistent in der Formulierung ist. Beide wundern sich regelmäßig darüber, wie hoch die Übersetzungskosten für ihre Dokumente sind …

So geht es besser:
Formulierungsmuster für bestimmte Anwendungsbereiche wie Handlungsanweisungen können etwa in einem Redaktionsleitfaden festgehalten werden. Und wer mit einem Component-Contentmanagement-System (CCMS) wie SCHEMA ST4 arbeitet, hat dann schnell ein Inventar von Textbausteinen oder Topics angesammelt, die immer wieder wiederverwendet werden können und die sich aufgrund der standardisierten Formulierungsmuster auch gut miteinander kombinieren lassen. Und die, einmal übersetzt, auch keine weiteren Übersetzungskosten verursachen.

Wer A sagt, soll nicht B sagen

Außerdem verwendet Moofy für einen fachlichen Sachverhalt einen bestimmten Ausdruck A, während Maisy für den gleichen Sachverhalt meist eine ebenfalls nicht unübliche, aber andere Formulierung B wählt. Das hat sogar schon zu Nachfragen geführt, ob mit der Beschreibung A dasselbe gemeint sei wie mit der Beschreibung B.

So geht es besser:
So pointiert gegenübergestellt ist klar, dass solch eine Vorgehensweise nicht optimal ist. Trotzdem passieren Fälle wie diese in einem wenig standardisierten Umfeld immer wieder. Was lässt sich dagegen tun? Beispielsweise lassen sich erlaubte und verbotene Ausdrücke in einer Terminologie-Verwaltung festlegen. Das erleichtert eine einheitliche Nutzung von Fachbegriffen, verbessert die Verständlichkeit und Übersetzbarkeit der Texte.

Next Level: Standardisierung durch Vernetzung

Das nächste Projekt von Moofy und Maisy ist die Dokumentation einer neuen Produktvariante. Vieles bleibt hinsichtlich Funktion und Bedienung gleich, deshalb verwenden sie eine Kopie einer bisherigen Dokumentation als Grundlage.

Sie stellen fest, dass die Technischen Daten an allen Stellen angepasst werden müssen: Alles wird schneller und leistungsfähiger. Die neuen technischen Daten erhalten sie von der Fachabteilung als Excel-Export aus dem Produkt-Informations-System (PIM). Und dann machen sie sich daran, im Variantendokument mit Strg-F die alten Werte zu suchen und durch die neuen zu ersetzen …

So geht es besser:
In einem optimierten Arbeitsumfeld müssen Moofy und Maisy die neuen Technischen Daten nicht mühsam kopieren. Über eine Anbindung der PIM-Software (Produktinformationsmanagement) an ihr Redaktionssystem werden die Daten direkt übernommen und referenziert. Die Gefahr von Tippfehlern wird minimiert und es wäre maximal sichergestellt, dass an allen Stellen dieselben Daten erscheinen (Single Source of Truth).

Aus einem Guss

Lassen Sie uns zum Abschluss noch einen Blick auf das Endprodukt der Dokumentation werfen. Moofy und Maisy mussten in unseren Beispielszenarien jeweils mit eigenen Word-Dateien arbeiten und hatten nur wenige Vorgaben zum Aussehen des Dokuments. Entsprechend haben beide an unterschiedlichen Stellen immer wieder längere Zeit darüber gegrübelt, wie sie bestimmte Inhalte umsetzen könnten, und entsprechend unterscheiden sich auch ihre Ergebnisse.

So geht es besser:
Eine standardisierte Vorgabe für Layout und Design hat auch hier eine mehrfache Funktion: Für die Kund:innen ist sie ein Ausdruck von Professionalität und schafft einen Wiedererkennungswert. Für die Technische Dokumentation intern befreit sie die Redakteur:innen von der Notwendigkeit, sich mit formalen Details beschäftigen zu müssen, indem sie eine Lösung vorgibt und deren Umsetzung möglichst einfach ermöglicht.

Die Einrichtung einer solchen Vorgabe lässt sich auf verschiedene Weise realisieren – das kann eine gut umgesetzte und mit den benötigten Formatvorlagen ausgestattete Dokumentvorlage sein oder im Rahmen eines CCMS ein standardisiertes Layout, das – beispielsweise auch abhängig von Dokumenttyp oder Ausgabekanal – immer ein einheitliches Erscheinungsbild garantiert und dabei Corporate-Design-Vorgaben automatisch berücksichtigt.

Fazit

Das Thema Standardisierung ist sehr vielfältig. Verbesserungen können daher an ganz verschiedenen Stellen ansetzen. Wir haben in unseren Beispielen einen kurzen Blick geworfen auf:

• Die Standardisierung auf Makro-Ebene durch einen einheitlichen Aufbau
• Die Standardisierung auf Mikro-Ebene in Bezug auf Inhaltsformulierung und Terminologie
• Die Weiterführung dieser Methode durch Vernetzung vorhandener Tools
• Die Standardisierung von Layout und Design

Nur der Vollständigkeit halber: Damit ist Vollständigkeit noch lange nicht erreicht. Ebenfalls wichtig: Standards. Hier brauchen Sie das Rad nicht neu zu erfinden. Es gibt bereits etliche Richtlinien und Normen, die bewährte und sinnvolle Vorschläge in Richtung Standardisierung geben; angefangen vom tekom-Leitfaden für regelbasiertes Schreiben oder der Norm IEC/IEEE 82079-1 zur Erstellung von Nutzungsinformation bis hin beispielsweise zur DIN 1450 zur Leserlichkeit von Schrift. Welche der vielen Vorschläge dann aber für Ihren Kontext sinnvoll sind, muss auf Ihre Anforderungen abgestimmt werden. Bei der Konzeption und Abwägung der verschiedenen Aspekte bieten wir Ihnen gerne unsere Unterstützung an.

Am Ende des Prozesses steht dann eine Dokumentation, die nicht einfach nur nach außen hin ein durchdachtes und hochqualitatives Bild zeigt. Die Standardisierung bietet die Chance, die beteiligten Prozesse effizienter zu gestalten und nicht zuletzt auch Kosten bei der Erstellung und Übersetzung einzusparen. Ein extremes Beispiel für Standardisierung haben wir vor einiger Zeit hier erzählt: Durch neue Dokumentkonzepte, Standardisierung, Layout- und Prozessoptimierung konnte unser Kunde in kürzester Zeit 180.000 Euro für zwei Produktfamilien einsparen.

Standardisierung ist also weit mehr als nur ein Qualitätsmerkmal – sie ist ein bedeutender wirtschaftlicher Erfolgsfaktor für Ihre Technische Dokumentation – und die Basis für alle zukünftigen Digitalisierungsschritte. Vom digitalen Informationsaustausch, etwa über den Standard iiRDS, bis hin zur Weiterverarbeitung durch Künstliche Intelligenz: ohne Standardisierung funktioniert das nicht. Sie bildet das Fundament für moderne Dokumentationsprozesse.

Wie zu Beginn gesagt: Standardisierung ist heute so aktuell wie nie.