Die wichtigsten Normen in der Technischen Dokumentation

In der heutigen Produkt- und Maschinenwelt geht oft nichts ohne Anleitung. Doch wo ist geregelt, wie sie aufgebaut und wie etwa Warn- und Sicherheitshinweise gestaltet sein sollten? Und wie lässt sich sicherstellen, dass Anlagenbauer digitale Zuliefererdokumentation unkompliziert zu einem Gesamtpaket zusammenfügen können? Für all dies gibt es Normen und Standards. Die wichtigsten stellen wir vor.

Ein Wort vorab: Von außen lässt sich nie sagen, welche Normen und Standards für eine Technische Redaktion relevant sind. Dies hängt von der Branche und dem Produkt ab. Hinzu kommen verschiedene nationale Standards, die je nach Zielmarkt gelten. Daher braucht es eine zuverlässige Normrecherche innerhalb des einzelnen Unternehmens.

Sie ist die zentrale Norm für Technische Redaktionen. IEC/IEEE 82079-1 bietet Standards zur Erstellung von Anleitungen für alle Produktarten. Neben generellen Anforderungen wie Konsistenz und Zielgruppenorientierung geht die Norm konkret darauf ein, wie Nutzungsinformationen gegliedert und gestaltet sein sollten. Sie enthält auch Anforderungen an Prozesse und gibt Hinweise zur Medienauswahl. Die aktuelle Auflage von 2019 berücksichtigt auch digitale Ausgabeformate. Ebenfalls neu in der Norm ist die Frage nach den Fähigkeiten, die ein Technischer Redakteur mitbringen sollte.

Neben allgemeinen Normen gibt es Standards, die sich an bestimmte Branchen richten. Eines der bekanntesten Regelwerke ist die ISO 20607:2019, die Anleitungen für den Maschinenbau in den Blick nimmt. Da von Maschinen ein hohes Risiko ausgehen kann, gelten gegenüber der ISO/IEEE 82079-1 zusätzliche und teilweise auch verschärfte Anforderungen. Sie ist eng verknüpft mit ISO 12100, der Norm zur Risikobeurteilung. Diese legt indirekt Anforderungen an die Inhalte der Betriebsanleitung fest.

Mit Softwaredokumentation beschäftigt sich gleich eine ganze Normengruppe: die ISO-Normen ISO/IEC 26511 bis ISO/IEC 26515. Die einzelnen Regelwerke richten sich an unterschiedliche Zielgruppen, enthalten also jeweils Standards für Redaktionsleitungen, Einkäufer von Redaktionsdienstleistungen und so weiter. Die beiden letzten Normen der Reihe richten sich an diejenigen, die die konkreten Anleitungen erstellen (ISO 26514) und an Redaktionen, die in agilen Teams arbeiten (ISO 26515).

Zum Thema Sicherheit und Warnungen bietet die Norm ANSI Z535.6 gute Grundlagen. Als amerikanische Norm wurde sie meist „für die speziellen Ansprüche des US-Markts“ verwendet, um hier die Rechtssicherheit zu erhöhen. Doch auch wir können uns für den europäischen Raum viel abschauen, wobei einiges schon in die neue Auflage der IEC/IEEE 82079-1 übernommen wurde.

Die Unterteilung der Warnhinweise in „Gefahr“, „Warnung“, „Vorsicht“ und „Hinweis“ sowie deren Farbgebung ist beispielsweise in dieser Norm geregelt. Ebenso, was diese Warnhinweise beinhalten sollen: das Signalwort, die Art der Gefahr, mögliche Folgen sowie die Vermeidung der Gefahr.

Für die Gestaltung von Sicherheitssymbolen sind zwei europäische Normen relevant. ISO 7010 bietet eine umfassende Auswahl an standardisierten Piktogrammen, zum Beispiel Warn- und Verbotszeichen. Wer eigene Symbole erstellen möchte, sollte ISO 3864 konsultieren. Diese Norm gibt grundlegende Hinweise zur Gestaltung von Sicherheitszeichen inklusive Farbwahl.

Diese Richtlinie erleichtert den Austausch von Technischer Dokumentation. Besonders wichtig ist das im Anlagenbau, denn dort werden Bauteile, Geräte und Maschinen unterschiedlicher Hersteller in komplexen Anlagen zusammengefügt. Diese Integration betrifft auch die Produktdokumentation. Die VDI-Richtlinie 2770 schafft dafür einen Rahmen und definiert standardisierte Dokumentationspakete, mit denen Hersteller ihre Unterlagen strukturiert an Anlagenbetreiber übergeben können. Diese wiederum können die Unterlagen im Anschluss leicht in ihre IT-Systeme integrieren.

Die tekom, der Branchenverband für Technische Kommunikation, hat mit iiRDS einen Branchenstandard erarbeitet. Dieser erleichtert den Austausch von Technischer Dokumentation in digitaler Form zwischen Herstellern und ihren Kunden. Außerdem können Inhalte so leicht in digitalen Umgebungen ausgespielt werden, zum Beispiel in Serviceportalen und Bedienoberflächen von Maschinen. Genutzt wird dafür ein standardisiertes Metadatenmodell und ein einheitliches Austauschpaket, um Inhalte und Metadaten zwischen verschiedenen Systemen zu übertragen.

Wer konkrete Fragen zur Texterstellung hat, findet in der tekom-Leitlinie „Regelbasiertes Schreiben“ genauere Antworten. Die Leitlinie beinhaltet alles rund um das Thema „Text für Technische Dokumentation“. Angefangen bei der Dokumentgliederung über Verständnishilfen wie Querverweise und Indexeinträge bis hin zu Satzstruktur, Wortwahl und Kommasetzung finden Redakteure viele Regeln, die ihnen die tägliche Arbeit erleichtern. Auch zu den Themen Platzsparen und übersetzungsgerecht Schreiben bietet die tekom-Leitlinie Tipps und Hinweise.

Viele Redaktionen nutzen diese Leitlinie bzw. Auszüge daraus für ihre Redaktionsleitfäden. Praktisch für Redakteure sind die Beispiele für jede Regel sowie kleine „Entscheidungshilfen“. Auch für ein schnelles Nachschlagen eignet sich die Leitlinie.

Die Liste der Normen, die in der Technischen Redaktion relevant sind, ließe sich noch beträchtlich erweitern. So gibt es zum Beispiel Standards für die Schreibung von Maßeinheiten (DIN 1301-1), für Kapitelgliederung und Nummerierung (DIN 1421) oder Normen mit Schreib- und Gestaltungsregeln (DIN 5008). Welche Norm tatsächlich relevant ist, hängt vom Produkt, der Branche und den Zielmärkten ab.

Eine Rolle spielen auch europäische Vorgaben und nationale Gesetze für Produktsicherheit, Produkthaftung und Arbeitssicherheit. Für Maschinen gilt die Maschinenrichtlinie 2006/42/EG. Sie behandelt nicht nur die Anforderungen bei der Konstruktion und dem Inverkehrbringen der Maschine, sondern auch die Anforderungen an die Technische Dokumentation der Maschine, beispielweise welche Dokumente mitgeliefert werden müssen und was die Betriebsanleitung beinhalten muss. Ab Januar 2027 löst die Maschinenverordnung 2023/1230 sie ab.

Darüber hinaus gibt es noch weitere Normen und Richtlinien, die in ihren jeweiligen Bereichen Anwendung finden und ebenfalls die Technische Dokumentation betreffen, zum Beispiel die Richtlinie für Elektromagnetische Verträglichkeit oder Normen und Gesetze für Medizinprodukte, Luftfahrt und Verteidigung.

Die Antwort lautet ja und nein. Es ist keine Pflicht, die Normen zu berücksichtigen. Im Haftungsfall ist es jedoch gut, wenn man aufzeigen kann, dass Normen angewandt wurden – außer es gibt Gründe, die gegen die Normenregelungen sprechen. In den meisten Fällen sollten Redakteure die Norm auf die eigene Situation sinnvoll anwenden und nicht auf Biegen und Brechen umsetzen.

Technische Redakteure können also für ihre Arbeit einiges an Richtlinien, Normen und Leitlinien finden. Kommentare zu diesen Dokumenten bieten meist einen guten Einstieg, um sich einen Überblick zu verschaffen und eventuell sogar eine Kaufentscheidung zu treffen. Kenntnisse der relevanten Normen und Standards geben Sicherheit bei der täglichen Arbeit und helfen, bessere Informationsprodukte zu erstellen.