Überspringen zu Hauptinhalt

NI #012 Prinzip der Konsistenz nach IEC/IEEE 82079-1

NI #012 Prinzip Der Konsistenz Nach IEC/IEEE 82079-1

Heute setzen wir uns erneut mit der IEC/IEEEE 82079-1 „Erstellen von Nutzungsinformationen“ als Edition 2 von 2019 auseinander.  In der letzten Folge haben wir uns das Prinzip der Prägnanz angeschaut. Heute schauen wir uns das Prinzip „Konsistenz“ an.

In diesem Zuge möchte ich auf unsere Online-Seminare hinweisen. Wir haben neue Themen in unsere Online-Seminare aufgenommen.

Eine wichtige Anmerkung: Die neue 82079 ist noch nicht in Deutsch erschienen. Wir arbeiten hier mit der englischen Norm sowie einem Praxisleitfaden zur Norm. Zur deutschen Version könnten sich also noch einige Dinge ändern.

Der Leitfaden wird von unserem Branchenverband herausgegeben und wurde von Leuten verfasst, die auch bei der Entstehung der Norm beteiligt werden. Einige Autoren kennen Sie vermutlich sogar aus den Interviews von meinen Kollegen. Aufgrund der Nähe der Autoren zur Norm vermute ich aber wenige bis keine Änderungen.

In diesem Zuge möchte ich auch gleich erwähnnen, dass die Prinzipien der Norm selten alleine stehen. Häufig sind sie mit anderen Prinzipien der Norm verbunden und erzeugen so Schnittmengen. Diese Prinzipien behandele ich in anderen Folgen.

Ich verlinke daher hier auf die jeweiligen Folgen:

Die Anforderungen des Prinzips „Konsistenz“

Wie immer, beginnen mit der Beschreibung des Prinzips aus der Norm, damit wir wissen, was die Norm unter diesem Prinzip versteht und welche Anforderungen an die Nutzungsinformation gestellt werden.

Die Beschreibung des Prinzips ist dabei etwas umfangreicher als bei anderen Prinzipien. Bedeutet das, dass auch das Prinzip anspruchsvoller ist als die anderen? Nun ich würde wohl sagen, ja. Denn auch der Begriff selbst, also „Konsistenz“ kann einiges bedeuten und viele Themenbereiche abdecken.

Im Kontext zur Nutzungsinformation hat der Begriff vor allem eine Bedeutung im Hinblick auf Inhalt, Darstellung und die Form. Mit Form meine ich dabei die Art und Weise, wie die Informationen zur Verfügung gestellt werden. Also als A4 auf Papier in Ordnern, Gebunden als Heft oder vielleicht digital als PDF-Datei.

Große Bedeutung eines kleinen Begriffs

Wie Sie anhand dieser Erläuterung schon sehen können, kommt hier einiges zusammen. Konsistente Nutzungsinformationen zu erstellen ist nicht leicht. Gerade im Hinblick auf Serien- oder Massenprodukte mit einer Vielzahl an Zubehör und Individualisierungsmöglichkeiten. Letzteres ist vor allem im Bereich von Consumer-Produkten für die Technische Dokumentation ein erheblicher Aufwand. Den ein eigenes, designtes Produkt zu besitzen, das sonst niemand hat ist ein großes Verkaufsargument. Aber ein so individuelles Produkt benötigt auch eine passende Anleitung.

Ein schönes Beispiel hierfür ist die Anleitung für Automobile vom Anfang des 21. Jahrhunderts. Also bevor auch dort die Digitalisierung eingesetzt hat. Damals hat man ein Auto zusammen mit dem Händler oder über die Website des Herstellers konfiguriert. Beispielsweise hat man entschieden ein Schiebedach oder eine Klimaanlage zu haben. Weiter ging es mit elektrischen Fenstern vorn oder hinten, Lichtpaketen, Entertainmentausrüstung im Radio, Boardcomputer etc.

Die Dokumentation war dabei das komplette Gegenstück. Dort bekam man eine dicke Anleitung. Es war alles beschrieben. Zum Beispiel wie ich das Schiebedach öffnen kann, auch wenn ich eine Klimaanlage hatte. Gleichzeitig wurden Bedienoberflächen und Konsolen beschrieben, die im Auto aber so nicht verbaut waren. Die Konsistenz zwischen Nutzungsinformation und tatsächlichem Produkt war nur begrenzt oder gar nicht vorhanden.

Das Ganze betrifft dabei nicht nur das Prinzip der Konsistenz, würde man eine solche Anleitung nach der IEC/IEEE 82079-1 heute bewerten, würde sie auch bei den anderen Prinzipien durchfallen. Aber es ist ein dennoch ein schönes Beispiel. Heutzutage ist das ganze übrigens besser gelöst. Durch Redaktionssysteme und anderen miteinander verbundenen Softwarelösungen entstehen die zum Produkt passenden Anleitungen. Egal ob diese dann auf Papierform oder digital im Boardcomputer vorhanden sind.

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

Konsistenz im Hinblick auf Inhalt

Kommen wir nun aber wieder zurück zur Norm und deren Anforderungen. Wie eingangs erwähnt unterteilt die Norm die Anforderungen im Hinblick auf Inhalt, Darstellung und Form bzw. dem Medium. Mein Beispiel mit dem Auto war schon sehr treffend auf den ersten Punkt, der Konsistenz im Hinblick auf den Inhalt.

Die Norm fordert, dass die Inhalte der Nutzungsinformation eindeutig und korrekt sind. Sie müssen mit dem Produkt übereinstimmen. An dieser Stelle erkennen Sie vermutlich schon die Schnittmenge mit dem Prinzip der Korrektheit. Gleichzeitig gibt es hier auch eine Schnittmenge mit den Prinzipien der Vollständigkeit und des Minimalismus, den das Produkt soll vollständig beschrieben sein, aber die Anleitung sollte nur die notwendigen Informationen beinhalten.

Konsistenten Inhalt zu erstellen ist aber gerade in der Serienfertigung mit Sonderausstattungen eine große Herausforderung. Um das Richtig und Effizient zu erreichen, bedarf es den Einsatz von verschiedenen Systemen und die Trennung des Inhalts von der Formatierung. Wir sind hier also auf der einen Seite auf Redaktionssysteme angewiesen, die den Inhalt, also den Text, vom Layout trennen. Nur so können wir Texte und Textbausteine erstellen, die in den verschiedensten Medien wiederverwendet werden können. So könnten beispielsweise die Technischen Daten sowohl in der Betriebsanleitung als auch in einem Prospekt verwendet werden. Wenn beide Inhalte aus dem Redaktionssystem stammen, müssen diese nur einmal gepflegt werden. Besonders Effizient wird es, umso mehr Dokumente dieselbe Quelle verwenden.

Auf der anderen Seite benötigen wir aber nicht nur Redaktionssysteme. Die Trennung von Text und Formatierung ist nur eine kleine Baustelle. Denn im Vergleich dazu ist die korrekte Zuordnung der Dokumente an die Produkte eine Mamutaufgabe. Es muss durch verschiedene Systeme gewährleistet werden, dass immer die korrekten Informationen dort ankommen, wo sie gebraucht werden. Damit auch Kunde A Produkt A und Anleitung bekommt und nicht Produkt B und Anleitung C.

Konsistenz im Hinblick auf Darstellung

Sie sehen schon, das Prinzip der Konsistenz ist spannend aber auch herausfordernd. Und wir haben uns bisher nur mit dem Inhalt auseinandergesetzt. Beschäftigen wir uns daher mit dem zweiten Punkt, der Darstellung. Auch dieser Teil kann eine Herausforderung sein. Darstellung ist ein weiter Begriff, entsprechend wird die Norm auch hierbei etwas genauer.

Unter Darstellung  versteht die Norm unter anderem einheitliche Terminologie, einheitliche Maßeinheiten, einheitliche Strukturen und Angaben, einheitliche Symbole, Warnhinweise und Farben. Eine lange Liste. Beginnen wir also mit einem kurzen Ausflug in die Terminologie. Terminologie ist ein sehr großes Themengebiet, hier haben wir auch eigene Podcast-Folgen dazu.

Für alle die mit dem Begriff der Terminologie jedoch nichts anfangen können, hier eine kurze Erläuterung. Unter Terminologie versteht man die Sammlung von Fachbegriffen aus einem Fachgebiet. Im Kontext der Technischen Dokumentation fallen außerdem häufig auch noch interne Produktbezeichnungen oder ähnliche Begriffe unter diesen Begriff.

Terminologie Beispiel

Der Zusammenhang mit dem Prinzip der Konsistenz entsteht in diesem Fall sowohl Dokument intern als auch dokumentenübergreifend. Ich erläutere das Ganze anhand eines Beispiels aus der Broschüre „Terminologie als wirtschaftlicher Faktor“ von Matthias Schulz. Im dortigen Beispiel geht es um einen Spielwarenhersteller der eine Babyrassel auf den Markt bringt.

Das Produkt wird mit dem Namen „Ringel“ vertrieben und so in den Verkaufsprospekten bezeichnet. In der Betriebsanleitung wird stattdessen der Begriff „Klingelrassel“ verwendet, weil der Begriff „Ringel“ erklärungsbedürftig ist. Aufgrund von Fehlern kommen in der Dokumentation jedoch auch die Begriffe „Glockenrassel“ und auch „Klingelrassel“ vor. Die Konstruktion verwendet dagegen wieder andere Begriffe. Das Chaos ist perfekt und nicht nur die Leser der Prospekte und der Dokumentation sind verwirrt. Wohin das ganze führt und welche Kosten sich darin verstecken möchte ich jetzt aber nicht weiter behandeln. Sonst kommen wir vom eigentlichen Thema ab.

Einheitliche Farben, Warnhinweise und Maßeinheiten

Ich denke, auf die weiteren Punkte der einheitlichen Darstellung muss ich nicht im Detail eingehen, diese sind großteils selbsterklärend. Aus der Praxis kennen wir zum Beispiel, dass einheitlich Maßeinheiten häufig ein Problem sein können. Wir sehen oft, in einer Anleitung manche Angaben in Millimeter angegeben werden, ein Kapitel weiter sind diese dann umgerechnet in Zentimeter. Oder manchmal werden diese Angaben mit einer entsprechenden Inch-Umrechnung in Klammer angegeben, manchmal ohne. Oder innerhalb der Inch-Angaben als Bruch und manchmal als Dezimalzahl.

Dasselbe Spiel sehen wir häufig bei Warnhinweisen. Hier fehlen Inhalte wie Signalwörter oder andere Angaben der Warnhinweise, bei anderen Fehlen hingegen Informationen zur Vermeidung der Gefahr. Oder alle Warnhinweise werden mit demselben Signalwort gekennzeichnet, eine Abstufung ist nicht vorhanden. Diese chaotischen Zustände gehen weiter und manifestieren sich vielseitig. Handlungsanweisungen werden nicht als solche dargestellt, sondern als normaler Absatz. Bilder sind mal farbig, mal schwarzweiß. Manche Bilder sind detaillierte Zeichnungen manchmal sind sie stark vereinfacht.

Das Thema der einheitlichen Darstellung geht auch Dokumentenübergreifend weiter, wenn einige Dokumente dann Inhalte haben, die in anderen fehlen. Wenn also Strukturen fehlen, die vorhanden sein müssten. Zum Beispiel wenn ein Dokument ein Inhaltverzeichnis hat und das nächste nicht. Oder keine Dokumentenbezeichnung oder sonstige Zuordnungen. Oder wenn ein Dokument genormte Symbole verwendet und das andere nicht.

An dieser Stelle breche ich nun ab. Ich glaube es ist klar, worauf ich und auch die Norm in diesem Punkt hinaus möchten. Inkonsistente Dokumente im Bereich der Darstellung irritieren und verwirren die Leser und Verwender der Dokumente. Insbesondere, wenn er mehrere Dokumente vorliegen hat.

Einheitliche Medien

Jetzt fehlt uns noch der dritte Punkt des Prinzips der Konsistenz, die einheitlichen Medien. Hierunter versteht man die Form, wie Inhalte vermittelt werden. Zum Beispiel sollte ein Nutzer nicht gezwungen sein, andauernd zwischen verschiedenen Medien wechseln zu müssen. Ein Beispiel: Die sicherheitsrelevanten Informationen werden in Papierform an den Kunden ausgeliefert. Der Rest der Dokumentation ist digital. Und hier gibt es sowohl Videos als auch eine App.

Und nun möchte der Kunde sein Produkt warten. Er liest das Sicherheitskapitel und wird zur Wartung auf die App verwiesen. Er lädt die App herunter und sucht dort nach den Informationen zur Wartung. In der App wird er wiederum wird er auf ein Video verwiesen, aber der Link fehlt. Er sucht das Video also auf Youtube und findet es. Dort wird er während des Videos immer wieder auf spezielle Hinweise hingewiesen die er einhalten soll. Diese seien in der gedruckten Dokumentation vorhanden. Also muss er dort wieder nachlesen. Und so springt er mehrfach zwischen allen Medien hin und her, bis er die Wartung durchgeführt hat. Ich wette danach hat er keine Lust mehr auf das Produkt.

Hier sollte also der Schwerpunkt daraufgelegt werden, dass ein Nutzer möglichst viele Informationen aus einer Quelle erhält. Das zum Beispiel die spezifischen Sicherheitshinweise im Video angezeigt werden. Das kann im Hinblick auf die Übersetzung erfordern, dass es für jedes Land ein eigenes Video gibt. Und das kann erhebliche Kosten verursachen, aber es wäre der richtige Weg.

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

Umsetzung und Erfahrungen aus der Praxis

Nun haben wir die Anforderungen der Norm geklärt. Somit stellt sich nun die Frage, wie es in der Praxis um das Prinzip der Konsistenz steht. Meine Praxiserfahrungen habe ich ja bereits teilweise in den Beispielen dargelegt.

Abseits davon empfinde ich persönlich dieses Prinzip generell als eine der herausforderndsten Aufgaben im Doku-Bereich. Und aus meiner Sicht auch nicht zu lösen, wenn man ohne Unterstützung von Systemen arbeitet. Davon ausgenommen sind natürlich kleine Unternehmen, die nur wenige Redakteure und nur eine geringe Anzahl an Produkten haben. Aber selbst dort muss der Redakteur geschult und ein gutes Gespür für Konsistenz haben, um es gut machen zu können.

Auf der anderen Seite sollte man dieses Thema nicht unterschätzen oder mit geringer Priorität bewerten. Denn interessanterweise ist dieses Thema auch bei Nichtbeachtung ein Kostentreiber in verschiedenen Bereichen.

Hohe Kosten durch Missachtung des Prinzips

Denn zu allererst führt natürlich eine Missachtung des Prinzips zu schlechten und verwirrenden Anleitungen. Diese führen beim Leser in der Regel dazu, dass er die Anleitung in die Ecke wirft und frustriert ist. Diese Gefühle werden mit dem Produkt und dem Unternehmen verbunden, die dann wieder beseitigt werden müssen. Entweder durch besondere Produktinnovationen, Leistungen oder Marketingmaßnahmen.

Dieser Punkt gilt natürlich vor allem für Consumer-Produkte, sollte aber auch nicht bei Investitionsgütern wie Maschinen missachtet werden. Kann ein Maschinenbediener die Anleitung nicht gut verwenden führt dies dort auch im Unternehmen zu Frust. Sollten dadurch außerdem Ausfälle entstehen, steht es schlecht um weitere Bestellungen beim Maschinenbauer.

Aber auch beim Maschinenbauer, also beim Hersteller kann die Missachtung des Prinzips zu großen Kosten führen. Diese sind jedoch hauptsächlich verdeckt und können daher auch nicht ohne weiteres ermittelt werden. Inkonsistente Anleitungen führen nämlich direkt zu hohen Übersetzungskosten. Ohne Autorentool im Hintergrund bemerkt der Redakteur beispielsweise nicht, ob er den Text schon einmal ähnlich formuliert hat. Dadurch entsteht ein ähnlicher Satz der erneut übersetzt wird und somit unnötigerweise ein zweites Mal Kosten verursacht. Mit einem Autorentool wäre dies nicht passiert.

Und dasselbe gilt natürlich für fehlende Redaktionssysteme. Den dort werden die einmal übersetzten Texte in der Regel nicht erneut zur Übersetzung gegeben. Der Übersetzer bekommt diese nicht und muss sie dadurch auch nicht überprüfen. Auch so werden Kosten gespart.

Fehlendes Fachpersonal führt zu schlechten Anleitungen

Zu guter Letzt muss ich natürlich auch sagen, dass ich häufig Anleitungen bekomme, die gegen dieses oder andere Prinzipien verstoßen. Die Schuld ist dabei auch häufig nicht direkt dem Hersteller anzulasten. Denn um gute Anleitungen zu schreiben, benötigt man ausgebildetes Fachpersonal. Dieses kann dann auch den Prinzipen der IEC/IEEE 82079-1 erlernen und umsetzen. Doch die aktuelle Situation ist die, dass es schlicht und ergreifend zu wenig Fachkräfte gibt. Somit kämpfen viele Unternehmen um wenige technische Redakteure. Die Folge sind logischer Weise schlechte Anleitungen.

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

An den Anfang scrollen