Reviews - wertvolles Feedback oder lästige Pflicht?

Wie Sie gute Kommentare zur Verbesserung Ihrer Technischen Dokumentation bekommen

von A2 Doku GmbH
0 Kommentare
Foto: Pexels/Vanessa Garcia

Foto: Pexels/Vanessa Garcia

Die Arbeit eines technischen Redakteurs ist niemals wirklich abgeschlossen. Ist die Dokumentation erstellt, beginnt der Review-Prozess, in dem das fachliche Feedback zu den Entwürfen eingeholt wird. Dieser Artikel gibt Tipps, wie man gute Review-Kommentare erhält, mit denen es sich optimal weiterarbeiten lässt.

Technische Redakteure recherchieren, bauen die Dokumentation auf, strukturieren sie und stellen die Informationen für den Nutzer bereit. Das Ergebnis wird von Reviewer in den Fachabteilungen kommentiert. Doch nicht immer haben die Kommentare die gewünschte Qualität, und oft genug kommt das Feedback spät.

Nicht selten wird der Review-Prozess als lästige Pflicht gesehen. Zu Unrecht, denn die dabei investierte Zeit ist enorm wertvoll für die Qualität der Dokumentation. Ziel eines Reviewprozesses sollte es sein, die Dokumentation für die Nutzer besser und verständlicher zu machen.

Vielfach prüfen Entwickler oder Konstrukteure die technische Dokumentation, weil sie die Experten für das beschriebene Produkt sind. Sie können dem Technischen Redakteur sagen, ob ein Sachverhalt technisch korrekt beschrieben ist. Wird ein bestimmtes Feature tatsächlich eingesetzt oder wurde es entfernt? Wie wirkt das Informationsangebot in der Dokumentation auf den Nutzer? Ist alles Wichtige beschrieben oder fehlt etwas? Auch diese Fragen sollten die Fachleute bei ihren Kommentaren berücksichtigen.

Gutes Feedback für guten Workflow

Gutes Feedback erkennt man daran, dass es nachfolgenden Beteiligten ihre Aufgaben leicht macht. Es hat sich bewährt, Änderungen in den zu überprüfenden Dokumenten gut sichtbar herauszustellen.

Tipps zum Kommentieren:

  • Nutzen Sie die Änderungsverfolgung
  • Versionieren Sie Kommentare
  • Setzen Sie Kommentarwerkzeuge in den Tools sinnvoll ein
  • Formulieren Sie Kommentare knapp und sachlich
  • Formulieren Sie Kommentare nicht als Fragen

So können sich alle involvierten Abteilungen darauf konzentrieren, gute Kommentare abzugeben oder diese umzusetzen. Auch eine kurze E-Mail mit klaren Anweisungen zum Kommentieren ist hilfreich.

Organisatorisch lassen sich die Wege zu einem guten Reviewprozess ebnen. Bei fast allen Projekten ist wenig oder gar keine Zeit für die Überprüfung der Dokumentation durch Fachabteilungen eingeplant. Gutes Projektmanagement dagegen berücksichtigt von vornherein eine angemessene Zeit für die Reviewschleifen. Dies optimiert die Abläufe für alle Beteiligten - vor allem aber verbessert es die Dokumentation.

0 Kommentare:

captcha

Geben Sie den Prüfcode im darüberliegenden Bild hier ein.

Jetzt teilen: