Überspringen zu Hauptinhalt

BA #029 Informationqualität

BA #029 Informationqualität

Die DIN EN IEC/IEEE 82079-1 benennt der technischen Redaktion Grundsätze und allgemeine Anforderungen an Nutzungsinformationen für Produkte. Ein Kapitel der Norm ist der Informationsqualität gewidmet.

Die Rolle von Prinzipien

Prinzipien spielen im täglichen Leben – mal mehr mal weniger – aber nahezu immer eine Rolle. Prinzipien sind Grundsätze, Überzeugungen oder feste Regeln, die man sich selbst erwählt oder die von anderer Seite auferlegt werden. Ihr Zweck ist es beispielsweise Orientierung und Hilfen bei Entscheidungen in Arbeitsprozessen zu geben.

Prinzipien begegnen uns auch in der täglichen Arbeit in der technischen Redaktion. So spielen sie beispielsweise in der DIN EN IEC/IEEE 82079-1 eine entscheidende Rolle: In Anhang A.2.2 heißt es sinngemäß übersetzt, dass wenn eine detaillierte Anforderung der 82079-1 nicht vollständig erfüllt ist, jedoch die Anforderungen aus den Kapiteln 8 (Struktur der Nutzungsinformationen) und 9 (Medien und Format) insgesamt als erfüllt angesehen werden können, lässt sich mit Hilfe der Prinzipien in Kapitel 5 die Erfüllung der Norm begründen.

Das bedeutet also, dass – solange alle Prinzipien befolgt werden – auch eine nicht vollständig erfüllte spezifische Forderung der Norm hinnehmbar ist.

Die Prinzipien sind in die Kategorien „Allgemeine Prinzipien“ und „Prinzipien zur Sicherstellung der Informationsqualität„ eingeteilt. Während die allgemeinen Prinzipien beispielsweise Vorgaben zu der Zielgruppenorientierung des Informationsproduktes machen oder auf die Notwendigkeit hinweisen, dass das Informationsprodukt problemlos dem bezogenen Produkt zugeordnet werden muss, stellen die sicherheitsbezogenen Prinzipien in besonderem Maße auf den Inhalt des Informationsproduktes ab.

Die sieben Prinzipien zur Sicherstellung der Informationsqualität heißen Vollständigkeit, Minimalismus, Korrektheit, Prägnanz, Konsistenz, Verständlichkeit und Verfügbarkeit.

Gratis - Checkliste klärt endlich auf!
Die wichtigsten 6. Punkte zur Prüfung von Betriebsanleitungen in der technischen Dokumentation.
  • Ersichtlicher Verwendungszweck der Maschine
  • Nachvollziehbare Handlungsanweisungen
  • Korrekt gestaltete Warnhinweise
  • Übersichtliches Layout der Betriebsanleitung
  • Verständliche Abbildungen
  • Hochwertige textliche Gestaltung

Die sieben Prinzipien zur Sicherstellung der Informationsqualität

Vollständigkeit

Zuerst einmal ist es unerlässlich, dass das Informationsprodukt alle Informationen über die Risiken enthält, die von dem bezogenen Produkt während seines gesamten Produktlebenszyklus ausgehen. Daher sind also nicht nur die Risiken zu nennen die beim Gebrauch – also der Anwendung – des Produktes durch den Benutzer selbst auftreten können, sondern auch die, welche beispielsweise den Personen drohen, die das Produkt lediglich transportieren, montieren, warten oder entsorgen. Hieraus folgt, dass die gewissenhafte Durchführung der Zielgruppenanlayse und der Risikobeurteilung unerlässliche Komponenten bei der Erstellung eines Informationsproduktes darstellen. Darüber hinaus sind aber auch Informationen zu berücksichtigen, die sich aufgrund vertraglicher Vereinbarungen oder weiteren rechtlichen Verpflichtungen ergeben.

Minimalismus

Dieser Punkt ist nicht immer einfach zu handhaben und steht scheinbar auch im Gegensatz zur geforderten Vollständigkeit.
Selbstverständlich muss ein Informationsprodukt sämtliche sicherheitskritischen Informationen enthalten, daran darf es gar keinen Zweifel geben. Und Informationen dieser Kategorie dürfen, ja sie müssen sich sogar dort wiederholen, wo sie benötigt werden. So kann beispielsweise ein und derselbe Warnhinweis durchaus mehrere Male in einem Informationsprodukt vorkommen. Hier das Minimalismusprinzip anwenden zu wollen, wäre sogar ein Verstoß gegen die Norm.

Und auch alle Informationen darüber hinaus die den effizienten und effektiven Gebrauch eines Produktes erst ermöglichen dürfen selbstverständlich nicht fehlen.
Gleichzeitig bedeutet das Minimalismusprinzip jedoch, dass nur relevante Informationen bereitzustellen sind.
Diese Forderung ergibt durchaus einen Sinn, denn ein deutliches „zu viel“ an Informationen die sich nicht mehr auf die eigentlichen Funktionen und die Sicherheitsaspekte beziehen kann zur Folge haben, dass die Benutzer eines Produktes die wirklich benötigten Informationen nicht nur schwerer auffinden, sondern auch die Lust am Lesen verlieren und die Anleitung beiseitelegen. Beachten sollte man in diesem Zusammenhang auch, dass ausschweifende Formulierungen besser in einen Roman als in ein technisches Informationsprodukt gehören.

Man kann also wohl sagen, dass alle Informationen die nicht sicherheitsrelevant sind oder nicht dem effektiven und effizienten Gebrauch des Produktes dienen der Schere des Minimalismusprinzips zum Opfer fallen müssen.

Ein Beispiel wie schnell man in der technischen Redaktion in Konflikt mit dem Minimalismusprinzip kommen kann, sind Warnhinweise und das Sicherheitskapitel, wenn es um Maschinen geht. Hier bestehen nämlich durchaus Unterschiede zwischen der DIN EN IEC/IEEE 82079-1 und der DIN EN ISO 20607.

So fordert die 82079-1 in Kapitel 7.11.2, dass Warnhinweise in Schritt-für-Schritt Anleitungen in Zusammenhang mit dem Auftreten der Gefahr genannt werden müssen. Sie sind also unmittelbar vor der jeweiligen Tätigkeit zu nennen, bei der eine Gefahr drohen kann. Dies kann sogar vor einem bestimmten Handlungsschritt als eingebetteter Warnhinweis erforderlich sein.

Außerdem fordert die Norm, dass Sicherheitshinweise in einem eigenen Kapitel am Anfang des Informationsproduktes aufzuführen sind. Sicherheitshinweise im Sinne der Norm sind eine eigene Art von sicherheitsbezogener Information (siehe Kapitel 7.11.1 und 7.11.4)

Die DIN EN ISO 20607 hingegen fordert in Kapitel 5.2.2.2, dass Warnhinweise im Kapitel Sicherheit stehen müssen. Und Warnhinweise müssen gemäß Kapitel 6.5 nach SAFE strukturiert werden. Da die 20607 jedoch bezüglich der Warnhinweise keine weiteren Vorgaben hinsichtlich Handlungsanweisungen macht, liegt es nahe, die Forderungen beider Normen zu erfüllen.

Somit stehen wir im Maschinenbau nach meiner Auffassung vor der Anforderung, dass wir jeden Warnhinweis ggfs. nicht nur mehrfach in verschiedenen Handlungsschritten aufführen müssen, sondern zusätzlich auch im Sicherheitskapitel. Dieses kann dann, je nach beschriebenem Produkt, ziemlich lang werden – Minimalismusprinzip hin oder her.

Korrektheit

Hier fordert die Norm, dass alle Informationen im Informationsprodukt des bezogenen Produktes auf dem aktuellsten Stand und selbstverständlich inhaltlich und technisch korrekt sind. Insbesondere dieser Punkt erfordert meiner Meinung nach eine enge Zusammenarbeit mit der Entwicklungsabteilung. Sofern man als externer Dienstleister für ein Unternehmen arbeitet, sollte auch unbedingt eine lückenlose Dokumentation des Auftraggebers zum aktuellen Stand der beschriebenen Produkte vorliegen. Aber das gilt im Prinzip auch bei der Inhouse-Redaktion. Erfährt ein Produkt Änderungen, ist selbstverständlich darauf zu achten, dass das zugehörige Informationsprodukt sofort entsprechend angepasst wird.

Prägnanz

Die 82079-1 schreibt vor, dass alle Inhalte, Formate und Medien eines Informationsproduktes prägnant zu sein haben. Der Duden definiert diesen Begriff als „etwas in knapper Form genau treffend, darstellend“. Hieraus ergeben sich somit Querverbindungen zu den Prinzipien Korrektheit und Minimalismus. Bezogen auf die Inhalte und ihre Darstellung wird gefordert, dass Formulierungen prägnant zu sein haben wobei die Texte und Abbildungen keine überflüssigen Details aufweisen sollen. Auch Videos sollten nicht länger als nötig sein – eine Forderung, die insbesondere den Utility-Videos eine besondere Bedeutung zukommen lässt.

Konsistenz

In Bezug auf unsere Informationsprodukte bedeutet Konsistenz die insgesamte Erstellung in sich thematisch und logisch zusammenhängender Inhalte. So müssen Inhalte eindeutig dem zu beschreibenden Produkt zugeordnet werden und selbstverständlich auch korrekt sein. Mit dem letzten Punkt wird wieder das Prinzip der Korrektheit berührt. Aber auch die Bereiche Format und Medien des Informationsproduktes müssen konsistent sein. Hierzu gehört übergeordnet die Trennung von Inhalt und Layout bzw. Format. Die Konsistenz von Format und Medien wird beispielsweise durch den Aufbau einer einheitlichen Terminologie, den strikten Gebrauch einheitlicher Maßangaben, Farben und Symbole – insbesondere in Warnhinweisen – oder dem Ermöglichen einer sinnvollen und einfachen Orientierung im Dokument durch Kapitelüberschriften, lebende Kolumnentitel und andere Elemente erreicht.

Bei der Erzielung von Konsistenz – insbesondere im Hinblick auf die Strukturierung – besitzen Auszeichnungssprachen wie XML eine besondere Bedeutung. In Zusammenhang mit einem CMS lässt sich so nicht nur innerhalb einer Betriebsanleitung zu einem Produkt Konsistenz erzielen, sondern auch im Zusammenhang mit weiteren, dem Produkt verbundenen Informationsprodukten wie beispielsweise seiner Verpackung oder den Verkaufs- und Werbeprospekten.

Verständlichkeit

Es ist eigentlich unnötig zu erwähnen, aber unsere Informationsprodukte müssen auch verständlich sein. Was nützt es, wenn ein aufwendig erstelltes und optisch hervorragendes Betriebshandbuch von niemandem nachvollzogen werden kann?
Eine sichere, effiziente und effektive Bedienung eines Produktes wird so nicht möglich sein – ein klassischer Instruktionsfehler der automatisch zu einem Produktmangel führt.

Und damit berühren wir wieder automatisch das Prinzip der Vollständigkeit, denn es geht wieder um die Analyse der Zielgruppe. Man kann und man muss ein Informationsprodukt für ein und dasselbe Produkt inhaltlich und formell an verschiedene Zielgruppen anpassen. Eine Motorsäge etwa wird zwar überwiegend von Forstarbeitern und damit im professionellen Einsatz betrieben, findet aber durchaus auch ihre Verwendung im heimischen Garten eines Sachbearbeiters, der sonst nie mit Maschinen arbeitet. Wir können davon ausgehen, dass der Forstarbeiter aufgrund seiner Qualifizierung viele der Informationen die der Sachbearbeiter dringend benötig nicht bedarf. Dennoch müssen wir bei derartigen Produkten darauf achten, dass nicht nur grundsätzlich alle sicherheitsrelevanten Informationen vorhanden sind, sondern auch darauf, dass sich die Betriebsanleitung nicht in einer Fachterminologie verliert die zwar der Forstarbeiter, nicht aber unserer Sachbearbeiter versteht.

Damit aber nicht genug, auch die Abbildungen, Symbole sowie alle Navigationselemente und Strukturen müssen in einer für die Zielgruppe verständlichen Form vorliegen – womit wir wieder mindestens die Prinzipien der Prägnanz und der Konsistenz berühren.
Und wir sollten auch daran denken, dass die Verständlichkeit eines Informationsproduktes immer auch eine Frage des Nutzungskontextes ist. So sollte beispielsweise dem Sicherheitskapitel einer Betriebsanleitung ein besonderes Augenmerk gewidmet sein, wenn es um den Inhalt des Abschnittes geht, der Anweisungen für einen Notfall gibt. Hier müssen Informationen nämlich besonders schnell gefunden und unmissverständlich nachvollzogen werden können.

Verfügbarkeit

Das letzte Prinzip zu erfüllen ist – abhängig vom Trägermedium des Informationsproduktes – nicht ganz einfach. Es geht darum, dass ein Informationsprodukt über die gesamte Produktlebensdauer und unter Beachtung des Nutzungskontextes für die jeweiligen Zielgruppen verfügbar ist.
Das ist bei einem klassischen Printprodukt noch recht einfach zu bewerkstelligen, denn es kann ja jederzeit nachgedruckt werden.

Schwieriger zu erfüllen ist die Forderung bei digitalen Produkten wie z. B. in Form einer PDF-Datei oder gar im HTML-Format. Dies gilt übrigens besonders in Hinblick auf die neue Maschinenprodukteverordnung, deren Einführung noch in diesem Jahr vorgesehen ist. Gemäß Artikel 10, Absatz 7 und dem Anhang III, Kapitel 1.7.4 in der derzeitigen Fassung – es kann jedoch durchaus noch Änderungen geben – ist vorgegeben, dass ein Produkt Informationen bereithalten muss, wie und wo die Betriebsanleitung heruntergeladen und zum jederzeitigen Zugriff elektronisch gespeichert werden kann. Das gilt auch für Betriebsanleitungen, die in Maschinen implementiert sind (HMI = Human Machine Interface).

Die Hersteller haben sicherzustellen, dass auch digitale Betriebsanleitungen über die gesamte Produktlebensdauer, mindestens aber 10 Jahre online verfügbar sind. Sie merken schon, hier geht es in der Tat um den Download der Betriebsanleitungen und nicht darum, dass der Hersteller Ihnen das Informationsprodukt auf Anfrage zusendet.
Das bedeutet nach aktueller Lesart und meiner Auffassung, dass die Hersteller künftig sicherstellen müssen, dass für den Zeitraum von mindestens 10 Jahren eine Website bzw. eine andere Downloadmöglichkeit (FTPServer, GitHub, usw.) existiert und alle entsprechenden Links die auf den Download verweisen, stets aktuell zu halten sind.

Interessant in diesem Zusammenhang ist übrigens, dass es offensichtlich im B2B-Bereich künftig erlaubt ist, ausschließlich digitale Anleitungen zu liefern, allerdings mit der Einschränkung, dass der Käufer beim Erwerb der Maschine Anspruch auf Aushändigung einer kostenlosen Ausgabe in Papierform hat.
Bei B2C-Kunden ist die Betriebsanleitung grundsätzlich in Papierform auszuliefern.

Gratis - Checkliste klärt endlich auf!
Die wichtigsten 6. Punkte zur Prüfung von Betriebsanleitungen in der technischen Dokumentation.
  • Ersichtlicher Verwendungszweck der Maschine
  • Nachvollziehbare Handlungsanweisungen
  • Korrekt gestaltete Warnhinweise
  • Übersichtliches Layout der Betriebsanleitung
  • Verständliche Abbildungen
  • Hochwertige textliche Gestaltung

Fazit

Halten wir also fest:

Wird eine detaillierte Anforderung der 82079-1 nicht vollständig erfüllt, können jedoch die Anforderungen aus Kapitel 8 (Struktur der Nutzungsinformationen) und Kapitel 9 (Medien und Format) insgesamt als erfüllt angesehen werden, lässt sich mit Hilfe der Prinzipien in Kapitel 5 die Erfüllung der Norm begründen.

Prinzipien sind Grundsätze, Überzeugungen oder feste Regeln, die man sich selbst erwählt oder die von anderer Seite auferlegt werden. Ihr Zweck ist es beispielsweise Orientierung und Hilfen bei Entscheidungen in Arbeitsprozessen zu geben.

Hinsichtlich ihrer Verteilbarkeit, insbesondere nach Produktänderdungen oder inhaltlichen Fehlerkorrekturen, haben digitale Informationsprodukte ganz klar die Nase vorn. Allerdings gilt es die Hürde der 10-jährigen Verfügbarkeit so gekonnt wie möglich zu nehmen, hier ist vermutlich mit einigem Aufwand zu rechnen.

Unser Wissen für Sie als PODCAST - Holen Sie sich die neuesten Episoden auf Ihr Smartphone

An den Anfang scrollen