Korrekturlesen und Review von technischer Dokumentation
Was sind Reviews?
Bei der Erstellung von technischer Dokumentation sind Reviews - auf deutsch etwa: Korrektur lesen - ein wesentlicher Bestandteil der Qualitätssicherung. Bei diesem Arbeitsschritt werden die Inhalte auf fachliche und sprachliche Richtigkeit überprüft. Ein Review sollte nicht von dem Technischen Redakteur durchgeführt werden, der die Inhalte erstellt hat, sondern von einem Kollegen oder einer Kollegin.
Bis zur Fertiggestellung einer Gebrauchsanleitung oder eines anderen Informationsproduktes werden oft mehrere Reviews von unterschiedlichen Beteiligten durchgeführt. Beispiele:
- fachlicher Review: Sind alle Inhalte technisch und logisch korrekt und aktuell?
- sprachlicher und Layout-Review: Sind alle sprachlichen Regeln eingehalten, zum Beispiel gemäß Orthografie, Redaktionsleitfaden oder Terminologiemanagement? Sind Umbrüche korrekt?
Reviews mit MS Word® o.ä.
Bei der Arbeit mit Schreibprogrammen wie MS Word® oder DTP-Programmen wie Adobe InDesign® werden zum Korrekturlesen bzw. für Reviews oft PDF-Dateien verwendet. Folgender Ablauf ist sehr geläufig:
- Das Word-Dokument o.ä. wird in ein PDF-Dokument konvertiert.
- Das PDF-Dokument wird per E-Mail an den Korrekturleser gesendet.
- Der Korrekturleser fügt ggf. Kommentare in das PDF-Dokument ein.
- Der Korrekturleser sendet das PDF-Dokument mit seinen Kommentaren per E-Mail an den Technischen Redakteur zurück.
- Der Technische Redakteur setzt die Kommentare ggf. im Word-Dokument o.ä. um.
- Falls der Technische Redakteur Rückfragen zu Kommentaren hat oder falls weitere Korrekturläufe bzw. Reviews erforderlich sind, geht der Prozess entsprechend weiter ...
- Wenn das Informationsprodukt keine Fehler mehr enthält, erteilt der Korrekturleser seine Freigabe.
Dieser Ablauf kann sehr unübersichtlich werden, wenn zum Beispiel ...
- mehrere Korrekturleser beteiligt sind
- Korrekturleser unterschiedlich schnell ihre Kommentare senden
- Korrekturleser sich auf veraltete Informationen beziehen
- Kommentare unklar sind und Rückfragen erfordern
- Kommentare sich auf unterschiedliche Sprachen des Informationsproduktes beziehen
- Kommentare auf unterschiedlichem Wege eingereicht werden, zum Beispiel direkt als E-Mail-Text
- Kommentare sich widersprechen
Hinzu kommt, dass unter Umständen die ganze Korrekturlese-Historie eines Projektes nachvollziehbar archiviert werden muss: Wer hat wann welchen Kommentar getätigt? Wurde ein Kommentar auch wirklich umgesetzt? Wenn ja, wann und von wem? ... Diese Informationen später aus allen E-Mails und PDF-Dokumenten herauszusuchen, kann äußerst aufwändig sein.
Reviews mit dem Redaktionssystem DoX CMS
Wesentlich entspannter und effizienter gestaltet sich der Ablauf mit dem browserbasierten Redaktionssystem DoX CMS. Für Korrekturleser wird vorab im Redaktionssystem einmalig ein Benutzerkonto mit den relevanten Berechtigungen eingerichtet. (Dabei kann übrigens ein automatisches Ablaufdatum für das Benutzerkonto angegeben werden.) Der weitere Ablauf sieht dann wie folgt aus:
- Der Technische Redakteur weist direkt im Redaktionssystem dem Korrekturleser eine Aufgabe zu.
- Als Notiz können Angaben zum Auftrag gemacht werden, zum Beispiel eine Bearbeitungsfrist.
- Der Korrekturleser wird automatisch per E-Mail über die neue Aufgabe informiert.
- Der Korrekturleser loggt sich im Redaktionssystem ein.
- In einer Übersicht werden ihm alle Module angezeigt, die auf ein Korrekturlesen warten, siehe Abb. 1 unten.
- Der Korrekturleser öffnet ein Modul und kann direkt im Redaktionssystem seine Kommentare eingeben, ähnlich wie in einem PDF-Dokument, siehe Abb. 2 unten.
- Alle Kommentare und Rückfragen werden im Redaktionssystem mit Datum, Uhrzeit und Autor protokolliert und sind leicht nachvollziehbar.
- Wenn alles erledigt oder in Ordnung ist, ändert der Korrekturleser den Status des Moduls.
- Der Technische Redakteur (und/oder ein anderer Beteiligter) wird automatisch per E-Mail informiert.
Abbildungen
Vorteile und für das Korrekturlesen relevante Funktionen von DoX CMS
- Korrekturlesen kann direkt und vollständig im Redaktionssystem DoX CMS erledigt werden.
- Es ist keine gesonderte Software erforderlich.
- Es braucht nichts installiert zu werden, Korrekturleser können spontan im Redaktionssystem arbeiten.
- Korrekturleser werden automatisch per E-Mail über neue Aufgaben informiert.
- Alle Beteiligten werden automatisch über bestimmte Statusänderungen von Modulen informiert.
- Es brauchen keine E-Mails manuell versendet zu werden.
- Korrekturleser brauchen sich nicht aus Dokumenten herauszusuchen, was sie korrekturlesen sollen, sondern sie bekommen vom Technischen Redakteur gezielt Module zugewiesen. Nur diese werden den Korrekturlesern angezeigt.
- Im Redaktionssystem ist alles protokolliert und nachvollziehbar.
- Die Berechtigungen von Korrekturlesern können flexibel eingerichtet werden.
- Benutzerkonten von Korrekturlesern können mit einem automatischen Ablaufdatum versehen werden.

Danke für Ihr Interesse an DoX CMS.
Was sind Ihre Bedürfnisse für Ihre technische Dokumentation?
Sehr gern überlegen wir in einem Gespräch mit Ihnen, ob und wie DoX CMS Sie bei der Erstellung von Gebrauchsanleitungen, Software-Dokumentation und anderen Informationsprodukten unterstützen kann.