Zum Inhalt springen
ms. – Marcel Schuler
Technische Redaktion

Was ein Dokumentations-Audit zutage fördert.

Fast immer dasselbe – und fast immer mehr, als dem Haus lieb ist.

Symbolbild: eine Checkliste mit Lupe

Die drei häufigsten Funde

Dubletten. Dieselbe Beschreibung in vier Dokumenten, in drei Fassungen, mit zwei unterschiedlichen Werten.

Waisen. Dokumente, für die sich niemand zuständig fühlt und die seit Jahren niemand geöffnet hat.

Lücken. Genau die Handgriffe fehlen, die der Support am häufigsten erklärt.

Wie ich vorgehe

Ich nehme eine Stichprobe aus dem Bestand, lese sie wie ein Anwender und prüfe sie dann gegen die Anforderungen: Normen, Zielgruppen, Auffindbarkeit. Dabei entsteht keine Note, sondern eine Liste – geordnet nach Risiko und Aufwand.

Parallel sehe ich mir an, wie die Dokumente entstehen. Oft liegt das eigentliche Problem nicht im Text, sondern im Ablauf: Wer schreibt, wer prüft, wer merkt, dass etwas veraltet ist?

Was dabei herauskommt

Ein Befundbericht, der sagt, welches Dokument welches Risiko trägt – und womit man anfängt, wenn nur zwei Wochen Zeit sind.

Geprüft wird gegen IEC/IEEE 82079-1 (alle Anleitungen), DIN EN ISO 20607 (Maschinen), die Maschinenverordnung (EU) 2023/1230, die ab 20. Januar 2027 gilt, und den tekom-Leitfaden zu Sicherheits- und Warnhinweisen.

So sehen zwei Befundzeilen aus

Betriebsanleitung Presse P40, Kapitel 6

Fund: Warnhinweis zum Quetschen nur im Sicherheitskapitel, nicht am Schritt „Werkzeug wechseln“.

Risiko: hoch – schwere Verletzung möglich.

Aufwand: gering, ein Baustein.

Empfehlung: Warnhinweis nach SAFE vor Schritt 3 einfügen.

Wartungsheft und Datenblatt P40

Fund: Anzugsmoment der Klemmschrauben zweimal beschrieben, mit 25 und 30 Nm.

Risiko: mittel – falscher Wert führt zu Schäden an der Maschine.

Aufwand: gering, Wert klären und an einer Stelle führen.

Empfehlung: als Nachschlage-Baustein anlegen, beide Dokumente darauf verweisen.

So entsteht aus der Stichprobe eine Liste, die sich abarbeiten lässt: oben, was ein Risiko für Menschen trägt und wenig Aufwand kostet, unten, was warten kann.

Was Sie dafür bereitlegen sollten

  • Drei bis fünf typische Dokumente, keine Schmuckstücke
  • Die häufigsten Supportfragen der letzten Monate
  • Wer heute schreibt und freigibt
  • Welche Normen für Ihr Produkt gelten
  • In welchen Sprachen übersetzt wird
  • Wo die Dokumente tatsächlich benutzt werden

Passt dazu

Was nach dem Befund kommt, steht unter Topic-based Writing in der Praxis und Single Source of Truth, praktisch gedacht. Der häufigste Einzelfund betrifft die Platzierung der Warnhinweise.

Sollen wir einmal hineinschauen?

Ein Audit ist der günstigste Teil des Ganzen – typisch drei bis fünf Tage, zum Festpreis – und der, nach dem Sie wissen, ob sich der Rest lohnt.

Zur Technischen Redaktion   Gespräch vereinbaren