Bessere Review-Prozesse in der Technischen Redaktion

Veröffentlicht: 27.11.2019 Aktualisiert: 22.08.2022

In der Technischen Redaktion entsteht Inhalt natürlich nicht aus dem Nichts. Im Idealfall entsteht er parallel zum Produkt und enthält somit Änderungen in Aufbau und Funktion so schnell wie möglich. Dafür muss die Redaktion die heimischen Gefilde verlassen und Informationen von Personen außerhalb der eigenen Abteilung einholen, mit ihnen Inhalt abstimmen, abnehmen lassen und das meist über mehrere Ebenen. Strenge Deadlines zur Veröffentlichung verleihen diesem Konstrukt darüber hinaus noch weitere Komplexität. Und genau diese gilt es zu beseitigen. Ich habe bereits auf der tekom Jahrestagung darüber gesprochen und möchte natürlich auch unseren Blog-Lesern bessere Review-Prozesse nicht vorenthalten.

Bessere Review-Prozesse in der Technischen Redaktion

Braucht man Reviews überhaupt?

Grundsätzlich sind 4, 6 oder 8 Augen immer besser, um Fehler oder Missverständnisse auszumerzen, aber die Technische Dokumentation hat abgesehen davon auch Anspruch auf Vollständigkeit, Verständlichkeit und Verlässlichkeit. Kunden erwarten das vollkommen zurecht. Um allein diese Anforderung zu erfüllen, müssen sich Technische Redakteure mit Fachpersonen abstimmen. Nur so kommen die richtigen Infos in die Technische Doku. Oft sind Freigabeprozesse im Unternehmen auch einfach vorgeschrieben, um genau diese Punkte zu garantieren oder um einen unternehmensweiten kontinuierlichen Verbesserungsprozess zu gewährleisten. Man kommt um Reviews in der Technischen Dokumentation grundsätzlich also nicht herum. Der Ablauf ist dabei immer ähnlich: Inhalt wird erstellt, es gibt ein Review für Verbesserungen, danach kommt noch eine Freigabe und die Produktion wird gestartet.

Das Problem mit Review-Prozessen

So schön wie gerade beschrieben ist die Welt meistens aber doch nicht. Oft ist Leuten nicht klar, für was sie in der Dokumentationserstellung eigentlich zuständig sind. Reviews oder Freigaben sind darüber hinaus auch in vielen Fällen mehrstufig und dadurch sehr komplex. Deadlines sind unklar oder der Zeitpunkt der Übersetzung nicht eindeutig definiert. All diese Unklarheiten bedeuten einen Verwaltungsaufwand für die Technische Redaktion.

Eine ganz besonders drückende Frage ist: Wie wird der Prozess denn umgesetzt? Drucken Sie vielleicht noch Inhalt aus, um ihn Kollegen vorzulegen und erhalten daraufhin handschriftliche Notizen zurück? Oder sind es kommentierte PDF-Dateien, die sie per E-Mail verschicken? Praktisch ja „digital“ und damit modern genug und „quasi kein Aufwand“ für Sie? Ob digital oder nicht - in beiden Fällen handelt es sich um eine Zettelwirtschaft, die die Technische Redaktion stemmen muss. Da müssen Excel-Dateien helfen, um den Status im Prozess, Deadlines, Reviewer, Teamleiter, Freigaben bis hin zur Übersetzung händisch mitverfolgen zu können. Kommentare, Änderungsvorschläge und dergleichen, die im Prozess ganz sicher anfallen, müssen ebenfalls händisch auf den Inhalt im Redaktionssystem übertragen werden. An dieser Stelle können Infos besonders leicht unter den Tisch fallen und werden dann in der Freigabe vermisst. Herkömmliche Review-Prozesse verschlingen Zeit und sind fehleranfällig!

Wie können Review-Prozesse besser werden?

Technische Redakteure verwalten Inhalt in professionellen Redaktionssystemen wie unserem SCHEMA ST4. Diese Systeme unterstützen Redakteure bei vielen ihrer häufigsten Aufgaben. Warum dann nicht auch hier? Sollte man Review-Prozesse nicht auch über Redaktionssysteme stemmen können? Konkret hieße das: Inhalt verlässt das Redaktionssystem nicht, Aufgaben und Prozesse werden darin abgebildet und automatisiert. Aber ganz besonders wichtig: Kollegen außerhalb der Technischen Redaktion können damit arbeiten, auch Feedback verlässt das System an keiner Stelle und wird auch nicht vom zugehörigen Inhalt getrennt. Dadurch würden sowohl der Verwaltungsaufwand, als auch die Fehleranfälligkeit bisheriger Review-Prozesse ausgemerzt werden. Das Redaktionssystem verwaltet und speichert alle Abläufe, Änderungen und Versionen rückverfolgbar und vollständig. Sie bräuchten dadurch keine Excel-Tabellen mehr.

Was muss ein XML-Redaktionssystem für bessere Review-Prozesse können?

Direkter Zugriff über den Browser

Zum Punkt „Kollegen außerhalb der Technischen Redaktion müssen mit dem Redaktionssystem arbeiten können“: Hier ist Minimalismus König. Für SCHEMA ST4 haben wir deshalb einen SlimClient, der über den Browser Zugriff zur Bearbeitung einzelner Aufgaben aus SCHEMA ST4 gewährt. Der SlimClient ist dabei auf die zu erledigende Aufgabe zugeschnitten.

Aufgabenanfrage im SCHEMA ST4 SlimClient

Fritz Meier kann in der Abbildung die Aufgabe annehmen und direkt den Text kommentieren oder die Anfrage ablehnen, woraufhin die Technische Redaktion informiert wird. Komplexer wird das Review für Fritz nicht. Wenn Fritz auf „Aufgabenanfrage annehmen“ klickt, öffnet sich der Inhalt zum Bearbeiten.

Texte im SCHEMA ST4 SlimClient kommentieren

Workflow-Management

Damit Aufgaben über ein Redaktionssystem gesteuert werden können, müssen diese auch definiert werden. In SCHEMA ST4 ist das ohne Programmieraufwand möglich. Workflows definieren Sie im Workflow Designer, einer nutzerfreundlichen Oberfläche zur Workflow-Erstellung in SCHEMA ST4. Sie stellen durch Workflows Gleise für Ihre Review-Prozesse, die ihre standardisierte, nachverfolgbare Einhaltung garantieren und somit Ihre Arbeit erleichtern.

Nach dem Start Ihrer Workflows werden diese durch eine Aufgabenübersicht leicht nachvollziehbar. Ausgelöste Workflows, Status, Bearbeiter und Deadlines sind alle darin zu sehen und werden bei der Durchführung automatisch aktualisiert. Auch eine Auswertung inklusive vollständiger Änderungshistorie ist möglich.

Aufgabenübersicht in SCHEMA ST4

Zeit für bessere Review-Prozesse!

Wir sind absolut davon überzeugt, dass sich Technische Redakteure nicht im gehobenen Maße mit Reviews oder Prozessen auseinandersetzen müssen. Eine entsprechende Unterstützung durch ein Redaktionssystem ist heute Stand der Technik. Integrieren Sie Ihre Fachkolleg*innen in Ihre Arbeit mit dem Redaktionssystem so lückenlos wie möglich, um Zeit und Nerven zu sparen und steigern Sie die Qualität Ihres Inhalts. Auf diesem Wege werden Ihre Redaktionsprozesse und Reviews komplett transparent und nachverfolgbar.

Über Maximilian Herrmann

Maximilian Herrmann studierte Kommunikation und Dokumentation (B. Eng.) an der Hochschule Aschaffenburg, wo er SCHEMA ST4 bereits kennenlernen durfte. Neben dem Studium leitete er zahlreiche Seminare mit verschiedenen Zielgruppen. Seit 2017 kombiniert er nun seine Seminarleitertätigkeiten, sein Studium und seine ST4-Kenntnisse als Trainer bei SCHEMA. Als Trainer begleitet er Kunden bei Einführungsprojekten, Standardtrainings und Workshops rund um Technische Dokumentation und SCHEMA ST4.

Andere Artikel von Quanos

Das könnte Sie auch interessieren

Harmonisierte Technische Kommunikation bei WEINIG

Zahlreiche Produkte, viele Dienstleistungen, weit gestreute Märkte und internationale Standorte – alles das sind Zeic…

Ran ans Budget

Viele Technische Redaktionen klagen, dass es ihnen schwerfällt, Ressourcen und Geld für wichtige Investitionen zu bek…

Semantik in der Technischen Dokumentation

Semantik geistert als Schlagwort immer wieder durch die Technikwelt. „Semantisches Web“ oder „semantisches Wissensman…