Standardisierung in der Produktdokumentation
In diesem Artikel klären die Handbuch Experten die wichtigsten Fragen bezüglich der Standardisierung der Produktdokumentation.
Was ist Standardisierung der technischen Redaktion?
Unter Standardisierung der Technischen Dokumentation versteht man die einheitliche Verarbeitung und Ausgabe von Technischen Inhalten. Dies reicht von der Entwicklungsdokumentation bis hin zur Gebrauchsanweisung/ Bedienungsanleitung.
Die Standardisierung der Technischen Dokumentation kann zum Beispiel mit Hilfe eines Redaktionssystems erfolgen. Hier können Sie 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 realisiert werden. Eventuell wollen Sie Ihre Technische Dokumentation aus verschiedenen Gründen standardisieren. Die Handbuch Experten haben für Sie zusammengetragen, was alles zur Technischen Dokumentation zählt.
Im folgenden Artikel beantworten die Handbuch Experten die grundlegenden Fragen zur Standardisierung der Technischen Dokumentation.
Was ist für die Standardisierung der Dokumentation nötig?
Wenn Sie Ihre Technische Dokumentation 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:
- Zielgruppenanalyse,
- Layout und Schreibstil festlegen,
- Redaktionshandbuch erarbeiten,
- Festgelegte Prozesse, um die benötigten Informationen von den Entwicklern/ Konstrukteuren verständlich zu Dokumentieren.
In welche Bereiche ist die Standardisierung der Dokumentationsabteilung eingeteilt?
Die Standardisierung der Technischen Dokumentation ist mehrschichtig. Sie beinhaltet Inhalt, Struktur und Layout der Dokumente.
Um die Inhalte zu standardisieren, sollten die Bezeichnungen vereinheitlicht 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 Merkmale definiert werden, wie z. B. aktiver Schreibstil, kurze Sätze usw. Achten Sie außerdem auf zielgerichtete Formulierungen ohne Füllwörter und inhaltslose Redewendungen.
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. Die Handbuch Experten bieten Ihnen die Möglichkeit, aus einer all-umfassenden Produktanleitung die Bestell-spezifische Anleitung automatisch generieren zu lassen.
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.
Warum ist die Standardisierung der Technischen Dokumente wichtig?
Grundsätzlich spart eine standardisierte Technische Dokumentation Zeit und Kosten. Wenn Sie Ihr Produkt z. B. aktualisieren und sich nur Technische Daten ändern die Anwendung aber gleich bleibt, können einzelne Teile der Gebrauchsanweisung schnell und einfach angepasst werden. Es ist also nicht unbedingt nötig, ein gänzlich neues Handbuch für die neue Produktversion zu erstellen. Allerdings müssen Sie dann darauf achten, dass die Distribution der neuen Inhalte reibungslos funktioniert.
Zudem wird die Übersetzbarkeit der Dokumente durch einen standardisierten Satzbau und eine wiederkehrende Wortwahl deutlich optimiert.
Der positive Aspekt dabei ist, dass Sie mit standardisierten Vorgehensweisen nicht nur Kosten senken. Sie können damit auch die Qualität Ihrer Technischen Dokumentation steigern. Denn wenn Sie das "Wie?" definiert haben, können Sie sich voll und ganz auf das "Was?" konzentrieren.
Für wen lohnt sich eine Standardisierung der Technischen Doku
Die Standardisierung Ihrer Technischen Dokumentation ist sinnvoll, wenn:
- Ihr Produkt ein Baukastenprodukt ist,
- Immer den gleichen Grundstock hat,
- Einen langen Lebenszyklus mit regelmäßigen Aktualisierungen hat,
- Sie Ihr Unternehmen fit für die "Industrie 4.0" machen wollen.
Nicht für jedes Unternehmen ist die Standardisierung in allen Bereichen und allen Varianten ratsam. Wenn jedes Ihrer Produkte von Grund auf verschieden ist, dann ist auch die jeweilige Dokumentation verschieden. Hier ist es hinreichend schwierig, einen umfassenden Standard zu entwickeln. Jedoch kann es durchaus sinnvoll sein, einzelne Teile der Technischen Dokumentation zu standardisieren. Ein einheitlicher Sprachstil ist beispielsweise produktunabhängig und kann Diskussionen über Formulierungen vermeiden. Aber auch das Layout anhand Ihrer unternehmensspezifischen Richtlinien sowie eine grobe "Standard-Gliederung" Ihrer Dokumente können Ihnen bei der Erstellung und Ihren Kunden beim Lesen der Dokumente bereits dabei helfen, sich schnell zurechtzufinden.
Worauf ist bei der Standardisierung der Produktdokumentation zu achten?
Die Standardisierung muss zielgruppengerecht erfolgen. Wenn Sie als Hersteller verschiedene Zielgruppen haben, z. B. Laien und fachkundige Personen, dann müssen die Standards, die Sie setzen, der jeweiligen Zielgruppe entsprechen.
Wenn Formatvorlagen oder Dokumentenvorlagen standardisiert sind, sollten diese auch durchgehend angewendet werden. Nur so kann sich die positive Wirkung entfalten und einen Mehrwert generieren. Eine unternehmensweite Akzeptanz der Standardisierung ist also unabdingbar.
Kein Mitarbeiter sollte bei standardisierten Lösungen noch "sein eigenes Süppchen kochen". Auch wenn vorherige Projekte dem aktuellen Projekt ähnlich sind, sollte die Dokumentation auf keinen Fall einfach kopiert und dann nur angepasst werden. Erstellen Sie basierend auf den entwickelten Standards eine neue Dokumentation für jedes separate Projekt.
Nutzen Sie den Ertrag der Standardisierung
Die Standardisierung der Technischen Dokumentation ist vielschichtig und aufwendig.
Eine vollständige Standardisierung, nur um zu standardisieren, ist nicht empfehlenswert. Dennoch sollten Sie in Betracht ziehen, einzelne Teile Ihrer Technischen Dokumentation zu vereinheitlichen. Denn, wenn das "Wie?" geklärt ist, können Sie sich auf das "Was?" konzentrieren.
Die Auswirkungen der Standardisierung sind weitreichend. Nicht nur Kosteneinsparungen und die Erhöhung Ihrer Qualität sind möglich, es kann unter anderem auch der Erstellungsprozess Ihrer Dokumente automatisiert werden.