Für technische Dokumentationen existieren verschiedene Normen, die zur Einhaltung zuvor beschlossener Qualitätsmerkmale beitragen. Sie halten etwa fest, wie im Bereich Technik Gebrauchsanweisungen aufgebaut sein sollen. Dabei gibt es eine Vielzahl von Richtlinien und Normen, die teilweise sogar produktspezifisch sind. Im Folgenden gehen wir jedoch auf vier der wichtigsten ein, um Dir einen Überblick zu verschaffen.
Warum sollte man bei der technischen Dokumentation Normen einhalten?
Durch die Berücksichtigung von Normen beim Erstellen von technischen Dokumentationen kann man eine konstant hohe Qualität und Nutzungsfreundlichkeit dieser gewährleisten. Dies ist ebenfalls für die sichere Verwendung verschiedener technischer Geräte, Maschinen oder anderer Produkte entscheidend. Insbesondere in Industriebereichen wie der Automobilbranche hätten unverständliche oder ungenaue Gebrauchsanweisungen fatale Folgen. Doch auch für Unternehmen ergeben sich Vorteile, da sie auf die bereits bestehenden Richtlinien zugreifen können, anstatt interne Vorgaben konzipieren zu müssen.
Damit Normen überhaupt verwendet werden können, müssen sie jedoch zunächst erstellt werden. Dafür sind laut dem Deutschen Institut für Normung Ausschüsse zuständig, die gemeinsam einheitliche Regelungen erarbeiten. Die Einhaltung der Normen ist jedoch nicht automatisch rechtlich bindend. Dazu müssen sie zuerst in Gesetzen verankert werden.
Technische Dokumentationen – Top 4 Normen
Für technische Dokumentationen gibt es vielfältige Normen, die man berücksichtigen kann. Zusätzlich zu den allgemeineren Vorgaben gibt es zudem noch unzählige produktspezifische Normen. In der IT-Branche existiert etwa die ISO/IEC 18019:2004 für Software-Produkte. Auch für Medizinprodukte gibt es Vorgaben für die Dokumentation. Trotz der Vielfalt sind einige Regelungen jedoch besonders wichtig, weshalb wir sie genauer beleuchten werden.
Norm für die Erstellung technischer Dokumentationen (IEC/IEEE 82079-1)
Die IEC/IEEE 82079-1 ist die bedeutendste Norm im Zusammenhang mit technischen Dokumentationen. Sie hält allgemeine Anforderungen für die Erstellung von Bedienungsanleitungen fest. Dazu gehören Richtlinien für den Inhalt, den Aufbau und die Gestaltung. Dabei soll sie garantieren, dass Anleitungen für die Verbraucher:innen leicht verständlich und alle sicherheitsrelevanten Informationen enthalten sind.
Darstellung von Sicherheits- und Warnhinweisen (ANSI Z535.6)
Hierbei handelt es sich um eine ursprünglich amerikanische Norm, die aber auch für technische Dokumentationen in Deutschland Anwendung findet. Sie bezieht sich auf Sicherheits- und Warnhinweise und gibt vor, wie diese dargestellt werden sollen.
Regelungen für die Textübertragung (DIN EN ISO 17100)
In der DIN EN ISO 17100 hat man festgehalten, welche Anforderungen es in Bezug auf Übersetzungsdienstleister gibt. Auf diese Weise möchte man qualitativ hochwertige Übersetzungen für sämtliche Sprachen gewährleisten – von Englisch bis Mandarin. Dies ist insbesondere in Bezug auf Fachübersetzungen essenziell, bei welchen Übertragungsfehler weitreichende Folgen haben können. Zu den in der Norm berücksichtigten Aspekten gehören die benötigten Qualifikationen der Übersetzer:innen, wie die Übertragungsprozesse ablaufen sollen oder welche Maßnahmen für die Datensicherheit der Texte zu befolgen sind.
tekom-Leitlinie zum regelbasierten Schreiben
Dieser Leitfaden wurde von der Gesellschaft für Technische Kommunikation erstellt und dient als eine Art Anleitung für das Verfassen technischer Dokumentationen. Zu den Inhalten gehören unter anderem Regeln zur Textstrukturierung, für verständliche Formulierungen oder für das übersetzungsgerechte Schreiben. Der Leitfaden ist zwar keine Norm, bietet aber praktische Hilfen für die Texterstellung.
Wer muss sich bei der technischen Dokumentation an Normen halten?
Sobald die Einhaltung einer Norm oder spezifischer Richtlinien in Gesetzen (z. B. dem Produktsicherheitsgesetz) festgelegt ist, müssen Hersteller:innen sich an diese halten. Sie müssen dann gewährleisten, dass die vorgeschriebenen Dokumentationen vollständig und den Vorgaben entsprechend vorhanden sind. Nutzungsinformationen wie Gebrauchsanleitungen betrifft dies übrigens nicht nur im Deutschen. Sobald sie ein Produkt in einem anderen Land der EU vermarkten, müssen Hersteller:innen Anleitungen in weiteren Sprachen (z. B. Französisch) zur Verfügung stellen. Auch technische Redakteurinnen und Redakteure, die für das Verfassen der technischen Dokumentationen zuständig sind, halten sich an Normen.
Um bei technischen Dokumentationen die Vollständigkeit, Übersichtlichkeit und Verständlichkeit zu gewährleisten, gibt es einige Normen. Vier besonders wichtige haben wir Dir bereits vorgestellt, doch es gibt selbstverständlich noch einige weitere. Außerdem ist es aufgrund des internationalen Handels wichtig, Nutzungsinformationen wie Sicherheitsdatenblätter auch in andere Sprachen zu übertragen. Beim Übertragen müssen sie häufig an die sprachlichen Besonderheiten der jeweiligen Länder angepasst werden, was man Lokalisierung nennt. Wir unterstützen Dich bei der Textübertragung – in Standardzeit und im Express!
FAQs – Normen für die technische Dokumentation
Zu den besonders entscheidenden Normen gehören die IEC/IEEE 82079-1 und die ANSI Z535.6. Erstere enthält Anforderungen beim Verfassen von Gebrauchsanleitungen und Letztere bezieht sich auf Warn- und Sicherheitshinweise. Es existieren jedoch noch viele weitere solcher Leitlinien, die sich wie die Maschinenrichtlinie auch auf bestimmte Produktgruppen fokussieren können.
Sie standardisieren die Informationen und den Aufbau dieser Nutzungsinformationen. Überdies gewährleisten sie die Qualität der Anweisungen und tragen somit zu einer sicheren Verwendung von Produkten bei.
Dazu zählen unter anderem Montageanleitungen, Sicherheitsdatenblätter, Wartungsanleitungen oder Informationen zur Entsorgung eines Gerätes. Es geht bei diesen Hinweisen demnach insbesondere um die korrekte und sichere Verwendung eines Produktes. Möchte man hingegen Angaben zu den spezifischen Eigenschaften einsehen, findet man diese in der Produktbeschreibung.
Die bedeutendste ist die IEC/IEEE 82079-1, denn sie enthält allgemeingültige Anforderungen an die Erstellung von Nutzungsinformationen. Ebenfalls von großer Bedeutung ist der amerikanische Standard ANSI Z535.6, welcher für Warn- und Sicherheitshinweise gilt. Besonders hilfreich ist zudem der tekom-Leitfaden zum Erstellen technischer Dokumentationen. Je nach Produktkategorie und Branche gibt es weitere essenzielle Richtlinien.
Für die Übersetzungsbranche ist die DIN EN ISO 17100 von großer Bedeutung. Sie enthält unter anderem Angaben dazu, welche Qualifikationen Übersetzer:innen vorweisen können müssen. Doch auch Regelungen für das Projektmanagement oder den Übersetzungsprozess sind integriert. Benötigt man für Verträge oder andere offizielle Unterlagen eine Übertragung mit Beglaubigung, gelten für diese zudem weitere Regelungen.
