Normen und Standards für die Technische Doku – wo schaue ich nach

Die Technische Redaktion muss für die Doku-Erstellung viele unterschiedliche Aufgaben bewältigen. Die Bedienungsanleitung soll nicht nur verständlich sein, sondern auch gut zugänglich, sicheren Produktumgang gewährleisten und am Ende vielleicht auch gut aussehen. Doch wo können sich Redakteure Hilfe holen? Einen Ansatz bieten da die Norm IEC/IEEE 82079-1.2019, die tekom Leitlinie “Regelbasiertes Schreiben” oder die mehr auf Sicherheit spezifizierte ANSI Z535.6. Was können diese Standards und wobei helfen sie in der Redaktion?

Die Norm IEC/IEEE 82079-1

Ein kleiner Allrounder für Technische Redaktionen ist die Norm IEC/IEEE 82079-1 “Erstellen von Nutzungsinformationen (Gebrauchsanleitungen) für Produkte”. Diese Norm geht auf viele relevante Punkte ein, über die ein Redaktionsteam früher oder später auch nachdenken muss. Dabei werden drei Dimensionen der Doku-Erstellung näher betrachtet: Der Zweck, die Qualität und der Erstellungsprozess eines Informationsprodukts.

Die Norm hilft durch die Planung und Gestaltung des Informations-Management-Prozesses und gibt dabei Stützen, um wichtige Fragen nicht zu vergessen. Ebenso werden wichtige Inhalte für Produktinformationen aufgelistet. Ob diese alle zutreffen, hängt natürlich von dem Produkt der eigenen Doku ab. Die Norm gibt auch Hinweise zur Inhaltsstrukturierung und Aufbau sowie der Medienwahl für das Informationsprodukt. Die neue 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.

tekom Leitlinie “Regelbasiertes Schreiben – Deutsch für die Technische Kommunikation”

Die IEC/IEEE 82079.1 beschreibt Rahmenbedingungen und Grundlagen für gute Technische Dokumentationen. Wer zur Texterstellung zum Beispiel konkreter Fragen hat, findet in der tekom Leitlinie “Regelbasiertes Schreiben” bessere Antworten. Diese 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 erleichtert. Auch zu den Themen Platzsparen und übersetzungsgerecht Schreiben bietet die tekom Leitlinie Tipps und Hinweise.

Viele Redaktionen nutzen diese Leitlinie, bzw. Auszüge davon auch für ihre Redaktionsleitfäden (es ist natürlich kein Ersatz für einen internen Redaktionsleitfaden). Praktisch für Redakteure sind die Beispiele für jede Regel sowie kleine “Entscheidungshilfen”. Auch für ein schnelles Nachschlagen – “wo kommt jetzt das Komma hin?” – eignet sich die Leitlinie.

Die Norm ANSI Z535.6

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 Rechtssicherheit zu gewährleisten. Doch auch wir können uns für den europäischen Raum viel abgucken. (Einiges davon wurde schon in die neue Auflage der IEC/IEEE 82079.1 übernommen.)

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.

Was gibt es noch?

Eine Rolle spielen natürlich auch nationale Gesetze für Produktsicherheit, Produkthaftung und Arbeitssicherheit. Ebenfalls gibt es noch viele Normen und Richtlinien, die abhängig vom zu beschreibenden Produkt zum Einsatz kommen.

Für Maschinen gilt da ganz klar die Maschinenrichtlinie 2006/42/EG. Diese Richtlinie behandelt nicht nur die Anforderungen bei der Konstruktion und Inverkehrbringung 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.

Auch für Software-Produkte gibt es mittlerweile Normen, die die Redakteure unterstützen. So zum Beispiel die Normenreihe ISO/IEC/IEEE 26511 – 26515 oder die ISO/IEC 18019:2004. Speziell auf Software zugeschnitten behandeln diese Normen die Planung und Herangehensweise, den Erstellungsprozess sowie Usability-Tests oder das Arbeiten in einer agilen Umgebung.

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.

Müssen Normen angewendet werden?

Die Antwort lautet ja und nein. Es ist keine Pflicht die Normen anzuwenden. Im Haftungsfall ist es jedoch gut, wenn man aufzeigen kann, dass Normen angewandt wurden – außer es gibt gute Gründe, Normen nicht anzuwenden. 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 Informationsprodukten zu erstellen.

Kommentar verfassen

von Anders Noren.

Nach oben ↑

%d Bloggern gefällt das: