Wissen Sie, womit Franz Kafka sein Geld verdiente? Der Schriftsteller verfasste unter anderem im Jahr 1909 eine „Unfallverhütungsmaßregel für Holzhobelmaschinen“. Damals wie heute ist verständliches Formulieren eine Kernkompetenz des Technischen Redakteurs. Mit zunehmender Komplexität der zu beschreibenden Technologien und dem ver­stärkten Einsatz digitaler Tools haben jedoch weitere Anforderungen in der Technischen Redaktion an Bedeutung gewonnen. Und auch Subject Matter Experts, d. h. Fachkräfte, beispielsweise aus Entwicklung, Fertigung oder Service, die Dokumentationsaufgaben erfüllen, stehen vor neuen Herausforderungen.

Vielfältige Software-Unterstützung für ausgebildete Technische Redakteure

Die Technische Redaktion ist ein weit entwickeltes Gebiet: Speziell ausgebildete Redakteure greifen heute auf zahlreiche redaktionelle Methoden und Software-Tools zurück, um An­forderungen wie Modularisierung, Standardisierung und Wiederverwendung von Informationen effizient und flexibel zu erfüllen. Redaktionssysteme vereinfachen die Strukturierung von Inhalten sowie das Management von Versionen, Varianten und Übersetzungen. Technische Redakteure sind Experten in der Auswahl und Nutzung der redaktionellen Methoden und Werkzeuge. Als „Wissensarchitekten“ bereiten sie komplexe Informationen verständlich und medienneutral auf, veredeln diese und machen sie für unterschiedliche Publikationen nutzbar.

Neue Herausforderungen für Subject Matter Experts in der Technischen Dokumentation

Ob Zusammenhänge korrekt dargestellt, alle Problemfälle abgedeckt und Arbeitsabläufe optimal beschrieben sind, kann der Technische Redakteur in der Regel nicht endgültig bewerten. SMEs dienen daher von jeher dem Technischen Redakteur als Informationsquelle, prüfen in Korrekturläufen, ob Dokumente die fachlichen Bedarfe erfüllen und mussten schon immer selbst Dokumentationsaufgaben übernehmen. Diese sind unter anderem durch kürzere Innovationszyklen und veränderte Produktionsprozesse komplexer geworden. So müssen Dokumente wie Spezifikationen oder How-Tos im Entwicklungsprozess variantenreicher Produkte laufend angepasst werden und agile Ansätze in der Software-Entwicklung verursachen permanent Dokumentationsaufwand.

Wachsende Nachfrage nach Tools für SMEs

Innovative digitale Technologien halten auch in der Technischen Redaktion Einzug. So besteht in vielen Unternehmen der Wunsch, smarte Devices und Augmented-Reality-Anwendungen zur Vermittlung von Expertenwissen einzusetzen. Beispielsweise für Montageanleitungen oder Verfahrensanweisungen, die den Anwender Schritt für Schritt mit entsprechenden Visualisierungen durch seine Tätigkeit führen.

Hierzu müssen die zugrunde liegenden Texte mehr denn je Anforderungen hinsichtlich Struktur und Modularisierung erfüllen, wodurch die Nachfrage nach passenden Tools für SMEs zusätzlich steigt. Die von Vollzeit-Redakteuren genutzten Redaktionssysteme verfügen über die benötigten Funktionen, erfordern jedoch ein hohes Verständnis der redaktionellen Methoden. Der Fall, dass Nicht-Redakteure die Systeme nutzen, liegt nicht im Fokus der System-Hersteller und wird daher kaum berücksichtigt. SMEs im Gebrauch der Systeme zu schulen ist aufwendig und die Konfiguration der Systeme wird sehr komplex, wenn sie in eine fachlich orientierte Arbeitsumgebung integriert werden sollen. In diesem Zusammenhang wächst die Nachfrage nach Arbeitsumgebungen, die durch vorgegebene Strukturen die leichte Verständlichkeit der Inhalte unterstützen und effiziente Erstellungsprozesse gewährleisten. Wie lässt sich eine solche Arbeitsumgebung schaffen und in welchen Fällen ist der Einsatz von SMEs für redaktionelle Aufgaben sinnvoll?

Eine mögliche Lösung: Etablierte Systeme um redak­tionelle Methoden erweitern

Die Arbeitsumgebung für SMEs muss sicherstellen, dass Anwender Informationen wie beispielsweise Handlungsanweisungen oder Fehlersuchbäume im Bedarfsfall unkompliziert abrufen können und Zusammenhänge eindeutig vermittelt werden. Eine mögliche Lösung besteht darin, Systeme, in denen fachliche Informationen hinterlegt sind, um redaktionelle Methoden zu erweitern. Programme wie MS Sharepoint, genutzt zum gemeinsamen Arbeiten in Projektteams, oder die Product-Lifecycle-Management-Software Teamcenter, bieten rudimentäre Funktionen zur Verwaltung von Inhalten. Für Dokumentationsaufgaben lässt sich softwareseitig eine formular-basierte Erfassungsumgebung ergänzen, die sich an gelernte Grundstrukturen wie Absätze, Listen etc. anlehnt.

Die Oberfläche gibt dabei wesentliche Blöcke zur Sicherstellung einer vollständigen und verständlichen Doku­mentation vor. So können – ähnlich wie bei einem Web-Formular – beispielsweise Textfelder mit Hinweisen zu geforderten Inhalten und Schreibkonventionen dargestellt oder Dropdown-Menüs für die Eingabe zwingend benötigter Angaben genutzt werden. Die Wiederverwendung oder Ver­linkung von Inhalten erfolgt über bekannte Mechanismen wie Copy / Paste / Reuse. Metadaten werden strukturiert ergänzt und die Inhalte automatisch modularisiert. TANNER hat derartige Systeme bereits für verschiedene Kunden eingeführt.

Komplexes Know-How oder ständige Feedback-Schleifen: Wann SMEs selbst schreiben sollten

Die Bereitstellung redaktioneller Inhalte durch SMEs empfiehlt sich, wenn Inhalte stark im fachlichen Kontext verankert sind und die redaktionelle Aufbereitung einen geringeren Stellenwert besitzt. So bietet die formular-basierte Erfassungsumgebung beispielsweise bei der Dokumentation von Verfahren und Abläufen in der Pharmaindustrie Vorteile. Für alle Autoren gültige Regeln und die Wiederverwendung von Informationen bewirken, dass Gleiches immer gleich beschrieben wird und nicht-relevante Inhalte entfallen. Die Qualität der Dokumente wird systematisch erhöht. Anweisungen werden leichter verständlich; reduzierte Fehlerkosten und kürzere Einarbeitungszeiten für neue Mitarbeiter sind die Folge. Aktualisierungen lassen sich auch bei einer Vielzahl betroffener Dokumente unkompliziert durchführen.

Auch wenn Dokumentationen über Jahre kontinuierlich gepflegt werden und permanent fachliche Feedbacks ein­fließen, ist ein Redakteur als Schnittstelle häufig nicht zweckmäßig. Ein klassisches Beispiel sind Informationen, in die laufend Erfahrungen aus dem Feld einfließen, wie im Vertrieb oder Service. Eine übersichtliche Erfassungs­ober­fläche gewährleistet die zentrale Steuerung der Qualität sowie der Kommunikationsziele gegenüber dem Kunden.

Verbesserte Kommunikation zwischen SME und Technischer Redaktion

Das beschriebene Lösungsszenario für SMEs kann auch dann sinnvoll sein, wenn Technische Redakteure die Informationen verwerten. Bei größerem Dokumentationsaufwand, beispielsweise bei den schon erwähnten varianten­reichen Produkten, vereinfacht es die Zusammen­arbeit zwischen Technischem Redakteur und SME. Die Redakteure erhalten Input ohne Medienbruch und können durch den verringerten Recherche-Aufwand ihre volle Arbeitskraft darauf verwenden, Inhalte bestmöglich zu veredeln und beispielsweise in Form von Apps, E-Learnings, Filmen oder Animationen aufzubereiten. Für die Fachexperten verringert sich der Arbeitsauf­wand in der Dokumentation ebenfalls, da sie durch eindeutige Regeln wissen, welche Informationen sie bereitstellen müssen und der Korrekturbedarf sinkt. Beide Berufsgruppen können so ihr Expertenwissen für die Erstellung qualitativ hochwertiger Dokumentationen optimal einsetzen.

Grafik Subject Matter Experts