Semcon Doku.Info - Fachportal für Technische Dokumentation

Fachportal für Technische Dokumentation

Review Technischer Dokumentation leicht gemacht

Was bedeutet Review von Technischer Dokumentation? Elke Grundmann erläuterte in ihrem Vortrag auf der tekom-Herbsttagung 2011 verschiedene Review-Möglichkeiten und die Vorteile, welche das Redaktionssystem Author-it für Reviews in globalen Teams bietet.

Was bedeutet Review von Technischer Dokumentation?

Technische Dokumentation muss verständlich und fehlerfrei sein. Um diese Qualität sicherzustellen, müssen die Dokumente auf unterschiedliche Typen von Fehlern überprüft werden:

  • technische und inhaltliche Fehler
  • juristische Fehler
  • Layoutfehler
  • Übersetzungsfehler
  • Verständlichkeit und Klarheit

Wer ist am Review beteiligt?

An einem Review sind oft mehrere Personen in unterschiedlichen Rollen beteiligt:

  • Ein Autor verfasst die Inhalte.
  • Ein Projekt- oder Qualitätsmanager legt fest, welche Personen zu welcher Zeit das Review durchführen.
  • Konstrukteure oder Entwickler prüfen auf technische und inhaltliche Fehler.
  • Endanwender oder Personen aus dem Systemtest überprüfen die Verständlichkeit und Klarheit.
  • Germanisten sind für korrekte Grammatik und Rechtschreibung zuständig.

In der Regel muss ein Review neben der „eigentlichen“ Arbeit erledigt werden. Diese oft ungeliebten Aufgaben bedeuten daher zusätzlichen Aufwand, der nur selten in der Projektkalkulation berücksichtigt wird.

Wie wird ein Review durchgeführt?

Review mit Review-Meeting

Der Qualitätsmanager legt fest, wer am Review teilnehmen soll, wann es beginnen und wann es enden soll. Der Autor schickt ein eindeutig identifizierbares Dokument an die Review-Teilnehmer. Die Reviewer notieren Fragen, Anmerkungen und Korrekturvorschläge und diskutieren diese in einem Review-Meeting. Der Autor ändert das Dokument entsprechend dem Protokoll des Review-Meetings.

Vorteil: Die direkte Diskussion der Änderungswünsche macht weitere Absprachen überflüssig.

Nachteil: Alle am Review beteiligten Personen müssen sich gleichzeitig treffen, was bei global arbeitenden Teams oft sehr schwierig zu organisieren ist.

Review per E-Mail und Kommentarfunktion

Der Autor verschickt die Dokumente als Word- oder PDF-Dokument an die Reviewer, die Reviewer fügen ihre Änderungswünsche als Kommentare an oder sammeln ihre Anmerkungen in einem gesonderten Dokument und senden diese an den Autor zurück. Der Autor analysiert die verschiedenen Anmerkungen, diskutiert diese, wenn nötig, mit den Reviewern und ändert das Dokument entsprechend.

Vorteil: Die am Review beteiligten Personen können die Dokumente zeitlich verteilt und unabhängig prüfen.

Nachteil: Der Autor muss Anmerkungen, die sich widersprechen, mit den Reviewern diskutieren und die Ergebnisse in das jeweilige Dokument manuell übernehmen.

Online-Review

Der Autor stellt das Dokument online zur Verfügung und die Reviewer ergänzen ihre Änderungswünsche zentral an einer Stelle. Der Autor übernimmt anschließend die Änderungen.

Vorteil: Alle Anmerkungen werden an einer Stelle gespeichert. Die anderen Reviewer können diese Änderungswünsche sehen und gegebenenfalls kommentieren.

Nachteil: Alle Reviewer müssen online arbeiten.

Wie kann man den Review-Prozess optimieren?

Mit den herkömmlichen Techniken ist es nicht möglich, nur einzelne geänderte Topics zu überprüfen. Außerdem kann mit dem Review erst begonnen werden, wenn das komplette Dokument fertiggestellt ist. Oft müssen aber nur geänderte Teile und nicht ein ganzes Dokument überprüft werden. Oder es wird gewünscht, dass die Erstellung von Dokumentation durch kontinuierliche Reviews begleitet wird.

Durch Modularisierung von Dokumentation und durch klare Vorgaben an die jeweiligen Reviewer kann der Review-Prozess optimiert werden:

  • Ohne eine Modularisierung von Dokumentation sind die oben genannten Ziele nicht zu erreichen. Zusätzlich ist eine Arbeitsumgebung notwendig, mit der die einzelnen Module verwaltet und das Review dieser Module gesteuert werden kann.
  • Jeder Reviewer muss genau wissen, was überprüft werden soll. Für jeden der genannten Fehlertypen sind daher klare Vorgaben/Fragen an den Reviewer erforderlich wie bspw. „Ist die Reihenfolge der Schritte richtig?“, „Gibt es weitere Warnungen, die beachtet werden müssen?“, ...

Wie können Redaktionssysteme das Review unterstützen?

Nur mit einer geeigneten Toolumgebung ist es möglich, die gewünschten Verbesserungen zu erreichen. Das Redaktionssystem muss eine Modularisierung von Inhalten und einen modularen Review-Prozess unterstützen. Außerdem müssen alle Reviewer auf dieselbe Quelle zugreifen und dort ihre Prüfungen durchführen können. Der Autor muss die Änderungen der Reviewer aus dieser Quelle direkt ohne Abtippen übernehmen können.

Beispiele für geeignete Redaktionssysteme sind Adobe Technical Communication Suite und Author-it .

Adobe Technical Communication Suite (TCS)

Der Autor erstellt die Texte in FrameMaker und RoboHelp, generiert für das Review ein Tagged PDF und gibt dieses für die Kommentierung frei. Er schickt das Review-PDF entweder per E-Mail an alle Reviewer oder legt es auf einen Server, damit alle am Review Beteiligten untereinander die Änderungen einsehen können.

Die Reviewer können im PDF Texte ändern, löschen und ergänzen sowie Notizen einfügen. Dazu arbeiten sie mit der Werkzeugleiste „Kommentieren“ und „Markieren“ (Adobe Reader 9, Adobe Acrobat 9) beziehungsweise „Kommentar“ (Adobe Acrobat X).

Wenn das Review abgeschlossen ist, importiert der Autor die Kommentare mit Framemaker oder RoboHelp in die Quelldateien. Die Ergänzungen und Löschungen werden als Textänderungen dargestellt. Über eine Symbolleiste kann der Autor die Änderungen annehmen oder ablehnen.

Die Notizen werden in FrameMaker als Marken vom Typ „Kommentar“ angezeigt. In RoboHelp werden zusätzlich im Review-Fenster alle Kommentare aufgelistet.

Author-it Reviewer

Im browserbasierten Author-it Reviewer erstellt der Qualitätsmanager ein Formular mit den relevanten Review-Daten: welches Dokument soll geprüft werden, Start- und Endtermin sowie obligatorische und optionale Prüfer.

Die Autoren bearbeiten ihre Topics und setzen deren Freigabestand nach und nach auf „Review“. Damit wird der nächste Prozessschritt angestoßen.

Author-it sendet eine Nachricht an alle Reviewer. Diese können nun in einem herkömmlichen Webbrowser das Topic ändern und kommentieren. Alle Review-Teilnehmenden können gleichzeitig am gleichen Topic arbeiten. Sie sehen die Kommentare anderer und können zustimmen, widersprechen oder auf Kommentare antworten.

Der verantwortliche Autor erhält eine Nachricht, welches Topic fertig überprüft wurde. Er kann jetzt im Author-it Editor die Review-Kommentare akzeptieren bzw. ablehnen und eigene Textänderungen machen.

Je nach Freigabestand, der beim Sichern ausgewählt wird, geht das Topic in einen weiteren Review-Zyklus oder wird final freigegeben.

Vortragspräsentation (PDF)


03.11.2011
Elke Grundmann
Weitere Artikel von Elke Grundmann

Mit dem Artikel verknüpfte Schlagwörter:
Arbeitsprozesse Author-it Review Technical Communication Suite Vortrag

HTML Druckversion

Suche



Themenbereich:
Startseite
Aktuelles
Schlagwortverzeichnis
Autorenverzeichnis
Artikel
Arbeitsorganisation & -prozesse
DITA
English Articles
Grafik
Handbuch & Online-Doku
Open Source
Single-Source-Publishing
Sprache
Standards
Technisches Schreiben
Tools
XML
Service
FAQ
Literatur
Tipps & Tricks
Veranstaltungen
Vorträge & Präsentation