Überarbeitung von Dokumenten anhand eines Doku-Checks

Um zu prüfen, ob eine Dokumentation den zutreffenden Regularien und anderen Anforderungen entspricht, kann ein Doku-Check enorm hilfreich sein.

Er ermöglicht, je nach Detailtiefe, einen guten Überblick über die Punkte, die von der Technischen Redaktion verbessert werden müssen. Gerade wenn er zusätzlich explizite Handlungsempfehlungen gibt, wie die Optimierung genau erfolgen soll.

Wenn man einen solch umfangreichen Doku-Check vorliegen hat, steht nun die Überarbeitung der Dokumentation an. Hier empfiehlt sich ein konzeptionelles und strukturiertes Vorgehen à la PDCA-Zyklus (Plan - Do - Check - Act).

Planen

Der erste Schritt ist natürlich die Planung. Dadurch entsteht der Überblick, welche Änderungen vorgenommen werden sollten und diese können kategorisiert werden.

Sollte Ihr Doku-Check anhand von Stichproben erstellt worden sein, ist es hilfreich, wenn Sie von die einzelnen Optimierungshinweise auf das gesamte Dokument anwenden.
Sie sollten genau prüfen, welche Informationseinheiten Sie ändern möchten und wie und durch wen diese im Einzelfall umgesetzt werden sollen. Je genauer und klarer festgelegt wird, wie die Überarbeitung durchgeführt werden soll, um so besser kann dies dokumentübergreifend - auch von mehreren Redakteuren - überarbeitet werden.

Wenn Sie rechtliche oder normative Vorgaben an Ihre Dokumentation haben, müssen Sie diese ggf. im Team besprechen. Denn wenn Sie z. B. in einer Konformitätserklärung festhalten, dass Sie sich an bestimmte Vorschriften und Normen gehalten haben, müssen diese auch in der Benutzerinformation umgesetzt werden. Gerade bei Normen und Richtlinien kann es sein, dass Sie auf Input anderer Abteilungen angewiesen sind. Wenn Sie direkt bei der jeweiligen Anpassung notieren, welche Ansprechpartner oder Abteilungen für den Informationsfluss nötig sind, können Sie später zügig an den Anpassungen arbeiten.

Halten Sie die zu ändernden Punkte am besten schriftlich fest und prüfen Sie ggf. Redaktionsleitfaden oder ähnliche Anweisungen darauf, ob auch hier Anpassungen notwendig sind, um den Prozess optimal abzubilden.

So wissen Sie genau, was geändert wird und können die geeignete Reihenfolge für die Änderungen festlegen. Dadurch vergessen Sie nichts und müssen sich nicht mehrfach durch das Dokument arbeiten.

Schreiben

Wenn klar ist, wer welche Änderungen vornimmt, geht es an die Umsetzung. Je nach Umfang, Komplexität der Änderungen und dem zeitlichen Rahmen können die Anpassungen von einem Redakteur oder mehreren Redakteuren erledigt werden. Durch die Kategorisierung und Priorisierung können sich die Redakteure voll und ganz auf die Optimierung der Technischen Dokumentation konzentrieren.

Überprüfen

Lassen Sie das Dokument von einem anderen Redakteur hinsichtlich der Hinweise aus dem Doku-Check überprüfen. Ggf. muss bei inhaltlichen Änderungen auch nochmal ein Entwickler oder Konstrukteur das überarbeitete Dokument fachlich freigeben. Danach können Sie weitere Dokumente nach dem selben Vorgehen überarbeiten oder anpassen.

So verbessern Sie Schritt für Schritt die Qualität und Verständlichkeit aller Ihrer Dokumente und verleihen diesen ein einheitliches Look-and-Feel. Das kommt am Ende nicht nur Ihren Kunden zugute, sondern auch Ihnen. Sie können dadurch Anforderungen gerade ziehen, Ihr Haftungsrisiko senken und die Benutzerzufriedenheit erhöhen, was auch Supportzeiten senken kann.

Überprüfen Sie Ihre neuerstellten Dokumente in regelmäßigen Abständen nach diesem Vorgehen. Prüfen Sie zudem, ob Neuerungen an Normen oder Richtlinien auch an Ihren Dokumenten Anpassungen nach sich ziehen.

Korrigieren

Sollten Punkte beim Überprüfen auffallen, die nicht optimal gelöst sind, können Sie diese korrigieren, bevor Sie die angepassten Dokumente weitergeben. Auch bei Überarbeitungen sollte durch das 4-Augen-Prinzip möglichst viele vorhandene Fehler oder Unklarheiten ausgemerzt werden. Sie sollten auch bei neu erstellten Dokumenten prüfen, ob sie den neuen Anforderungen genügen und gleichzeitig vermeiden, dass alte Muster fälschlicherweise wiederholt werden. Dabei kann ein Redaktionshandbuch helfen, das mit allen Vorgaben (auch denen aus dem Doku-Check) zum Erstellen Technischer Dokumente versehen wird. Falls so ein Redaktionsleitfaden schon vorhanden ist, sollten Sie unbedingt prüfen, ob alle Änderungen an den entsprechenden Stellen eingefügt wurden.

Gerne können Sie auf unsere Erfahrung und Systematik setzen, wenn Sie Ihre Technische Dokumentation aktualisieren oder überarbeiten möchten.