Standardisierung von Anleitungen

Die Standardisierung der technischen Dokumentation kann zum Beispiel mit Hilfe eines Redaktionssystems erfolgen. Hier kann man als Redakteur zunächst alle Inhalte unabhängig vom späteren Layout und Verwendungszweck erstellen. Am Ende werden Ihnen die Inhalte gemäß der definierten Struktur in vorher festgelegten und entsprechend vorbereiteten Formaten ausgegeben.

Die Standardisierung kann aber auch ohne ein Redaktionssystem, z. B. in Word- oder InDesign-Dokumenten realisiert werden.

Dokumentationen werden in den unterschiedlichsten Sprachen benötigt

Was ist für die Standardisierung der technischen Dokumentation nötig?

Wenn Sie Ihre Dokumente, wie Betriebsanleitung und co. standardisieren wollen, sind gegebenenfalls Schritte vor der eigentlichen Standardisierung nötig. Prüfen Sie vor Beginn dieses Projekts, welche der folgenden Punkte für Sie relevant sind:

In welche Bereiche ist die Standardisierung der technischen Dokumentation eingeteilt?

Die Standardisierung umfasst den Inhalt, die Struktur und das Layout der Dokumente.

Um die Inhalte zu standardisieren, sollte eine einheitliche Terminologie im Unternehmen verwendet werden. Dies bedeutet, Sie legen fest, wie der jeweilige Dokumententyp, der Anwender, Nutzer und das jeweilige Produkt bezeichnet werden. Hinzu kommt die Vereinheitlichung des Schreibstils. Hier sollten klare Regeln definiert werden, wie z. B. aktiver Schreibstil, kurze Sätze und vieles mehr. Achten Sie außerdem auf zielgerichtete Formulierungen ohne Füllwörter, da dies kein Mehrwert für den Anwender bietet.

Herausforderungen, wenn man keine festgelegte Terminologie einsetzt:

  1. Missverständnisse – Eine inkonsistente Terminologie, die zu Missverständnissen führt, bedeutet ebenfalls, dass der Empfänger mehr Zeit darauf verwenden muss, den Text zu lesen und zu verstehen.
  2. Negativer Eindruck – Wenn ein Unternehmen nicht genau festgelegt hat, wie Dienstleistungen oder Produkte bezeichnet werden, kann es Kunden schwerfallen, ein Vertrauensverhältnis zum Unternehmen aufzubauen.
  3. Höherer Aufwand der Mitarbeiter – Terminologie wird häufig zum Gegenstand interner Diskussionen zwischen den Abteilungen, die vermieden werden können, wenn ein für alle Mal festgelegt wird, wie ein Produkt oder eine Sache bezeichnet werden soll.
 

Bei Bedarf schlagen wir Werkzeuge vor, mit denen Sie die Terminologie optimal in Ihrem Unternehmen nutzbar machen. Sprechen Sie uns hierzu direkt an.

Jetzt Kontakt aufnehmen

Rufen Sie uns unter +49 7136 / 2973910 an oder schicken Sie uns eine Anfrage

Vorteile für eine unternehmensweite einheitliche Terminologie:

  1. Bessere Qualität – Eine einheitliche Kommunikation trägt zu einem positiven Kundenerlebnis bei, stärkt die Marke und schafft Kundenloyalität. Das erfordert Dokumente hoher Qualität, und auch hier spielt die konsistente Terminologie eine zentrale Rolle.
  2. Zeitersparnis und höhere Effizienz – Wenn Terminologie systematisiert wird, können Autoren/Redakteure weit schneller Texte erstellen. Zudem nehmen die Übersetzung und die interne Korrektur weniger Zeit in Anspruch.
  3. Finanzieller Vorteil – Mit einer festgelegten Terminologie sparen man Geld. Ein wesentlicher Faktor dabei ist, dass die Übersetzungskosten sinken werden. Durchgehend konsistente Quelltexte führen schnell zu mehr 100% Matches aus dem Translation Memory (Übersetzungsdatenbank), welche weniger kosten als neue Wörter.

 

Für die Standardisierung der Struktur sollten die Anforderungen der relevanten Regelwerke und intern definierte Strukturen erfasst und umgesetzt werden. Eine durchgehend einheitliche Struktur erlaubt eine Modularisierung der Inhalte. Mit der Modularisierung geht im Weiteren auch die Möglichkeit zur Automatisierung von Dokumenten einher.

 

Redaktionsleitfaden

Ein Redaktionsleitfaden ist ein unternehmensinterner Standard. Er regelt die Konsistenz und Qualität der Produktdokumentation und ermöglicht deren effiziente Erstellung.

Viele Unternehmen haben heute bereits Redaktionsleitfäden im Einsatz, die gängige Regeln für verständliche und übersetzungsgerechte Dokumentation enthalten. Dennoch sieht man immer wieder, dass die Qualität der erstellten Dokumentationen nicht dem Standard entspricht. Häufige Ursachen sind:

Bei der Vereinheitlichung sollte auch das Layout für alle Varianten, die Sie ausgeben möchten, nach Ihren CI/CD-Richtlinien angepasst werden. Wenn Ihre Dokumente stets den gleichen Gestaltungsregeln folgen, trägt das maßgeblich zum Erkennungswert Ihres Unternehmens bei.