Standardisierung in der technischen Redaktion

Standardisierung in der technischen Redaktion, schneiderdokumentation.de

Standardisierung und Modularisierung

Die Standardisierung in der technisches Dokumentation

Kosten einsparen und die Qualität erhöhen. Das erwarten die meisten Unternehmen, wenn sie ihre technische Dokumentation (oder zumindest Teile davon) standardisieren lassen möchten.
Doch was bedeutet überhaupt der Begriff „Standardisieren“? Was bringt mir das als Unternehmer? Schließlich müssen oder zumindest sollten die Dokumente hohen Qualitätsanforderungen genügen. Ist eine Bedienungsanleitung immer gültig, sobald sie einmal standardisiert wurde? Wie läuft so etwas überhaupt ab? Fakt ist: Ohne eine vernünftige Standardisierung und Strukturierung besteht durchaus die Gefahr, dass ein Unternehmen Geld und Zeit verliert.

Sinnvoll: Ein Redaktionsleitfaden

Bevor der Technische Redakteur überhaupt mit der Standardisierung, beispielsweise mit einer Bedienungsanleitung oder eines Handbuches beginnt, erstellt er (falls noch nicht vorhanden) zunächst einmal einen Redaktionsleitfaden. Dieser enthält die gängigsten Regeln für eine verständliche und – wenn nötig – übersetzungsgerechte Dokumentation.

Diese Regeln können sich beispielsweise nach der tekom-Leitlinie „Regelbasiertes Schreiben“ richten. Bei größeren Unternehmen mit mehreren Niederlassungen oder bei Konzernen gelten diese Regeln übrigens in den meisten Fällen unternehmensweit.

Bei der Erstellung dieses Leitfadens gilt es, sowohl die produktseitigen als auch die rechtlichen oder norminativen Anforderungen an die jeweilige Dokumentation zu beachten (siehe zum Beispiel die CE-Kennzeichnung).
Genauso wichtig ist aber auch, die Zielgruppe, an die sich diese Dokumentation richten soll, auch deren Arbeitsweise zu berücksichtigen. Also: wer benötigt welche Information und wie muss ich diese Person überhaupt ansprechen?
Außerdem muss festgelegt werden, was eigentlich genau standardisiert werden soll. Das Dokument, das Layout oder die Struktur oder alles zusammen?

Wie werden Inhalte nun sinnvoll standardisiert? 

Standardisierung der Struktur
Hier gilt es eine gewisse Vorsicht walten zu lassen, denn es gibt sowohl norminative als auch juristische Vorgaben wie genau eine Struktur auszusehen hat. Zudem sollte definiert werden, wie die einzelnen Bausteine überhaupt auszusehen haben. Das ist dann besonders wichtig, wenn beispielsweise ein Redaktionssystem zum Einsatz kommen soll. Durch eine standardisierte Struktur wird außerdem die Vollständigkeitsprüfung enorm erleichtert.

Standardisierung der Inhalte
Inhalte zu standardisieren hat durchaus große Vorteile für ein Unternehmen. Durch die „einheitliche Sprache“ wird beispielsweise die Textverständlichkeit gesteigert, was gerade bei Bedienungsanleitungen (oder auch bei Handbüchern) enorm hilfreich sein kann. Allerdings sollte im Redaktionsleitfaden (siehe oben) festgehalten werden, wie diese Sprache auszusehen hat, insbesondere dann, wenn mehrere technische Redakteure an einem solchen Dokument arbeiten. Sonst besteht nämlich die Gefahr, dass jeder der Redakteure dem Inhalt seine eigene Note aufdrücken will, was wiederum zu einem sprachlichen Chaos führen kann.

Standardisierung des Layouts
Ebenso wie die Inhalte und deren Struktur sollte auch das Layout standardisiert werden. Zum einen, um natürlich die Corporate Identity nach außen zu zeigen. Zum anderen, weil es besser aussieht, wenn alles einheitlich ist. Als Beispiel sei ein Handbuch genannt, das auch den Online Hilfen gleicht. Zudem erleichtert das auch den Zugriff auf die benötigten Daten. Der Nutzer weiß dadurch intuitiv, wo er nachzuschauen hat.

Welche Vorteile hat eine Standardisierung?

Einmal standardisiert kann beispielsweise eine Bedienungsanleitung immer wieder für ein bestimmtes Gerät oder eine Maschine zur Hand genommen werden und muss nicht jedes Mal neu erstellt werden. Das spart enorme Kosten. Standardisierte Informationen können außerdem medienübergreifend immer wieder verwendet werden. Das spart wiederum auch Kosten bei einer eventuellen Übersetzung.
Auch die Zeitersparnis ist ein großer Faktor: Einmal standardisiert läuft der Prozess zur Erstellung einer Dokumentation immer einheitlich ab.

Doch Achtung! Sobald sich beispielsweise nur ein Bau- oder Bedienteil ändert, muss auch die Bedienungsanleitung komplett neu überarbeitet werden.

Eine Standardisierung kann, wenn sie richtig gemacht wird, durchaus einiges zur Qualitätssteigerung beitragen. Durch die einheitliche Terminologie werden unter anderem Missverständnisse vermieden, beispielsweise bei der Bestellung von Ersatzteilen. Außerdem können gewisse Sicherheitsrisiken minimiert werden. Die Verwendung von einheitlichen Satzbausteinen – wie in der Standardisierung üblich – erleichtert zudem die Übersetzung in die verschiedensten Sprachen. Das spart, wie bereits im Absatz oben angesprochen, Kosten ein.

Standardisierung ja oder nein?

Standardisierung lohnt sich definitiv für solche Produkte, die in großen Massen gefertigt werden und sozusagen ein „Dauerbrenner“ sind.
Wird ein Teil ausgetauscht oder kommen neue Funktionen hinzu, muss die Bedienungsanleitung zwar überarbeitet, aber nicht komplett neu verfasst werden.  Ein weiterer Vorteil: Dank der Standardisierung ist beispielsweise ein problemloser Datenaustausch möglich, sowohl in den Abteilungen untereinander als auch mit anderen Unternehmen.
Eine standardisierte Dokumentation kann so, wenn mit einem entsprechenden Redaktionssystem gearbeitet wurde, auch von Maschinen gelesen werden, was unerlässlich für Industrie 4.0 und Internet of Things ist.

Anders sieht es im Sondermaschinenbau aus, beziehungsweise bei Einzelanfertigungen. Dort lohnt eine Standardisierung nicht, denn jedes gefertigte Teil funktioniert dort anders. Manchmal nur ein wenig, manchmal komplett.
Allerdings sollte man bei der Standardisierung auch nicht aus den Augen verlieren, dass eine Anleitung immer noch die Sprache des Nutzers sprechen muss und nicht in “fachchinesisch“ verfasst sein sollte.

Wenn Sie in Ihrem Unternehmen eine Standardisierung der technischen Dokumentation anstreben sprechen Sie uns gerne an!

Im zweiten Teil des Artikels wenden wir uns dann der Modularisierung zu, die untrennbar mit der Standardisierung verbunden ist.

 

, , , , ,

Empfohlene Beiträge

Kategorien

Menü