BA #037 Das Prinzip Verständlichkeit in der technischen Redaktion

Die Informationsqualität – sie soll nach der DIN EN IEC/IEEE 82079-1 sichergestellt werden durch sieben Prinzipien. Insbesondere eine dieser Prinzipien begegnet uns oftmals bereits in der vom Kunden übermittelten technischen Dokumentation. Es geht um das Prinzip der Verständlichkeit.

Verständlichkeit – was ist das eigentlich, was verbirgt sich hinter diesem Begriff?

Wikipedia beschreibt es, meiner Meinung nach, recht gut. Zitat: Verständlichkeit ist im kommunikativen Handeln eine Grundbedingung dafür, dass etwas verstanden werden kann.

Verständlichkeit, genauer die Forderung nach der Verständlichkeit der technischen Dokumentation, insbesondere in Hinblick auf sicherheitsrelevante Informationen, wird in vielen Richtlinien eingefordert, so zum Beispiel in der MRL bzw. der neuen Maschinenverordnung, der NRL, der EMV-RL, der FuAnl-RL oder der Medizinprodukteverordnung.

Nun ist es mit der Verständlichkeit eine recht einfache Sache, wenn es um das gesprochene Wort geht. Anhand der Reaktionen meines Gegenübers kann ich recht schnell erkennen, ob das, was ich vortrage, auch im von mir beabsichtigten Maße ankommt – also ob es verstanden wird und ggfs. darauf entsprechend reagieren.

In Schriftwerken, wie bei uns in der technischen Dokumentation, wird es da schon deutlich schwieriger. Meist erfahren wir gar nicht, ob unsere Werke verstanden werden – oder aber erst dann, wenn beispielsweise eine Reklamation vorliegt.

Aber die Verständlichkeit einer Information hängt nicht nur von demjenigen ab, der eine Information teilt, sondern auch von demjenigen, für den die Information bestimmt ist. Einem technischen Laien wird auch die best formulierte Betriebs- oder Bedienungsanleitung nichts nutzen, wenn er fachlich gar nicht in der Lage ist, sie zu verstehen (Stichwort Zielgruppenanalyse).

BA #014 Zielgruppen in der Technischen Dokumentation

Die Wichtigkeit der Verständlichkeit ist nun aber nicht auf das gesprochene oder geschriebene Wort beschränkt, auch Bilder, Grafiken, Animationen, Diagramme – kurz alles, was der Illustration im Zusammenhang mit der Informationsvermittlung dient, muss verständlich aufbereitet sein. Dabei ist aber zu berücksichtigen, dass eine Illustration für sich alleine nicht immer jeden Sachverhalt umfassend darlegen kann. Vielfach wird ein beschreibender Text benötigt, um Verständlichkeit herzustellen. Dennoch gibt es sie, die Bilder, die auch völlig ohne Text erklären. Denken wir nur an die Utility-Videos.

Ein weiterer Punkt, der Einfluss auf die Verständlichkeit eines Dokumentes nimmt, ist seine Struktur. Dies wird in der DIN EN IEC/IEEE 82079-1 in Kapitel 8.1 auch so gefordert. Ich habe leider schon einige Betriebsanleitungen zur Prüfung oder Neuerstellung gesehen, bei denen keinerlei sinnvolle Struktur erkennbar war.

Dies beginnt meist mit einer fehlenden logischen Reihenfolge nach Produktlebensphasen und endet mit irgendwo im Dokument scheinbar unmotiviert eingestreuten Kapiteln zu einem bestimmten Thema – bestenfalls noch mit einem Querverweis versehen.

Querverweise sind übrigens auch so ein Thema: Gerade bei umfangreichen Dokumenten geht es nicht ohne sie. Allerdings sollte man sie nach einer dokumentenweiten Terminologie gestalten und möglichst nur auf Inhalte anwenden, die sachlich zueinander gehören. Querverweise über mehrere Ebenen hinweg – also ein Querverweis auf einen Querverweis auf einen Querverweis – sind nach meiner Auffassung nicht zielführend.

Viele weitere Punkte nehmen Einfluss auf die Verständlichkeit, auf alle werde ich hier nicht eingehen. Allerdings scheint mir einer doch besonders erwähnenswert: Es geht um die Terminologie und in diesem Zusammenhang um die Verwendung von Fachsprache. Zum einen finde ich in zu bearbeitenden Dokumenten immer wieder vor, dass für einen Begriff mindestens zwei, manchmal sogar drei Benennungen verwendet werden. Das alleine ist schon ein Problem, allerdings wird dies noch gesteigert, wenn Benennungen verwendet werden, die sich nicht mehr kognitiv zuordnen lassen und der Leser dann nicht mehr weiß, was nun gemeint ist.
Gegen die Verwendung von Fachsprache ist überhaupt nichts einzuwenden – wenn Sie da eingesetzt wird, wo es erforderlich und sinnvoll ist. So zum Beispiel in Serviceanleitungen, denn hier ist die Zielgruppe relativ homogen – es handelt sich in der Regel um Fachpersonal, das mit dieser Terminologie vertraut ist.

Nun bemühen wir technischen Redakteure uns ja tagtäglich bei unserer Arbeit darum unsere Informationsprodukte eben auch nach dem Prinzip der Verständlichkeit zu erstellen. Das ist die eine Seite der Medaille. Die andere Seite ist die – und damit bin ich bei dem Anlass für den heutigen Podcast – auch technische Redakteure haben auf der Input-Seite mit der Verständlichkeit zu tun, ich gehe sogar soweit zu sagen: zu kämpfen.

Es geht um die Dokumente, die man vom Kunden überreicht bekommt, beispielsweise mit dem Auftrag daraus eine Betriebsanleitung zu erstellen. Und diese Dokumente haben es teilweise in sich – leider jedoch oftmals auch in negativer Hinsicht. Und das macht – zumindest mir – die Arbeit regelmäßig sehr schwer und führt zu großem Unmut meinerseits.

Worum geht es konkret?
Hier einige Beispiele aus der Praxis:

Beispiel 1:

Die Lieferung des Produktes erfolgt in mehreren Teilen: Teil 1, Teil 2 und Teil 3.

Klingt erst einmal nicht schlecht, nur muss man dazu wissen, dass an anderer Stelle dieses Dokumentes herauskam, dass zu dem Produkt noch weitere Elemente Teil des Lieferumfanges sind – was jedoch im eigentlichen Kapitel zum Lieferumfang mit keinem Wort erwähnt wird.
Damit nicht genug, existierte zu keinem der benannten Teile auch nur eine einzige Illustration.

Beispiel 2

Sollte der Abstand zwischen Modul A und Modul B zu groß sein muss der Anschlusswert angepasst werden (5.3.5).

Weitere Informationen gab es hierzu nicht.
Mir stellte sich daher die Frage: Wann ist der Abstand zwischen Modul A und Modul B denn korrekt, bzw. wann ist er zu groß? Und: Welcher Anschlusswert ist hier wie anzupassen?

Beispiel 3

Der Sammelwasserablauf sollte tiefer als der Sammelwasserbehälter montiert werden.

Nun, das ist schon aus physikalischen Gründen zu empfehlen, aber um welches Maß?
Und: „sollte“? Abgesehen davon, dass es sich um ein zu vermeidendes Modalverb handelt: Das heißt, der Ablauf muss gar nicht zwingend tiefer liegen? Wehe, das interpretiert der Monteur falsch …

Beispiel 4:

Alle elektrischen Verbindungslinien sind ordnungsgemäß auszuführen.
Nun gut, ich bin gelernter Elektrotechniker, und nach nochmaligem Gegenprüfen des betreffenden Kapitels zur Sicherheit gelangte ich dann zu der Überzeugung, dass der Autor mitteilen wollte: Alle elektrischen Leitungen sind fachgerecht zu verlegen und anzuschließen. Ich gehe davon aus, dass dies jeder meiner Kollegen auch so interpretiert. Dennoch: Können wir bei einem weltweit vertriebenen Produkt sicher sein, dass jeder, der mit dem Anschluss einer solchen Maschine betraut ist, diese Anweisung wirklich versteht?

Beispiel 5:

Nach Beseitigung der Verstopfung ist eine Neuinbetriebnahme erforderlich.
Also eine Neuinbetriebnahme wird vermutlich fast jeder mit einer ersten Inbetriebnahme bzw. als Maßnahme nach einer erfolgten Rücksetzung auf Werkseinstellung interpretieren. Das kommt durchaus vor, in diesem Fall jedoch meinte der Autor schlichtweg: Schalten Sie die Maschine wieder ein.

Und mit solchen Informationen an der Hand sollen wir technischen Redakteure nun ein Informationsprodukt für den sicheren Gebrauch erstellen. Was folgt daraus? Wenn man nicht gerade das Produkt um das es geht, im direkten Zugriff hat, um die Aussage praktisch nachzuvollziehen, bleiben nur zeitaufwändige Rückfragen beim Auftraggeber. Diese kosten Zeit und manches Mal auch Nerven.

Dabei sind einige dieser Beispiele keineswegs aus Bösartigkeit entstanden (das hoffe ich doch zumindest) sondern vermutlich schlichtweg dem Umstand geschuldet, dass derjenige, der etwas konstruiert so tief in der Materie steckt, dass er bei jemandem dem er etwas erklärt, einfach einen gewissen Kenntnisstand voraussetzt. Leider geht das so manches Mal dann schief und ist in der technischen Dokumentation der falsche Ansatz. Um so mehr wird daran deutlich, wie wichtig die Zusammenarbeit zwischen Entwicklungsabteilung und technischer Redaktion ist.

Maßnahmen zur Sicherstellung der Verständlichkeit sind, wie bereits erwähnt, auch bei Elementen der Visualisierungen anzuwenden.
Wie oft habe ich beispielsweise Screenshots von Displays einer Maschinensteuerung gesehen, die bei falscher Beleuchtung (Stichwort: zu dunkel oder Lichtreflexe) einfach abfotografiert wurden. Wie oft habe ich Illustrationen gesehen, bei denen das Element um das es im begleitenden Text geht, schlichtweg untergeht, weil der Bildausschnitt zu viel Umgebungsraum zeigt.

Insbesondere an diesen beiden eben gehörten Beispielen sehen wir übrigens, dass es gar nicht so einfach ist, immer eine strikte Kategorisierung hinsichtlich der sieben Prinzipien der Verständlichkeit vorzunehmen. Zur Erinnerung: Sie heißen Vollständigkeit, Minimalismus, Korrektheit, Prägnanz, Konsistenz, Verständlichkeit und Verfügbarkeit.

Verstößt also mein Beispiel mit dem Bildausschnitt, der zu viel Umgebungsraum zeigt, nicht eher gegen das Prinzip des Minimalismus und der Prägnanz?

Darüber lässt sich vermutlich trefflich streiten. Ich sehe es zumindest so: Eine Illustration, deren Kernaussage sich mir nicht auf den ersten Blick erschließt, ist für mich unverständlich. Vergessen wir nicht, es geht hier um Informationsprodukte die den sicheren Gebrauch eines Produktes ermöglichen sollen. Da bleibt keine Zeit, sich zu fragen: „Was wollte der Meister uns mit diesem Bild sagen?“

Und im Prinzip ist es doch so: Wir technischen Redakteure kommen wohl überwiegend aus zwei Welten: Die einen haben technische Kommunikation auf der Hochschule von der Pike auf gelernt, die anderen – so wie ich – kommen als Praktiker mit jahrzehntelanger Berufserfahrung aus einem technischen Sektor und sind technische Redakteure als Seiteneinsteiger geworden. Gemeinsam stehen wir aber oftmals vor dem gleichen Problem: Der technische Redakteur von der Hochschule wird mangels jahrelanger praktischer Erfahrungen in irgendeinem technischen Sektor genauso hilflos dreinschauen, wie ich, wenn es beispielsweise um den technischen Teil einer BA zu einer komplexen Anlage aus der Verfahrenstechnik geht. Um so mehr ist es von großer Wichtigkeit, dass wir für unsere Arbeit Informationen an die Hand bekommen, die auch für uns verständlich sind.

Fazit

Halten wir also fest:

• Dass ein Informationsprodukt verständlich sein muss, wird von vielen EU-Richtlinien, bzw. -Verordnungen gefordert.
• Das Prinzip der Verständlichkeit ist eines der sieben Prinzipien zur Sicherstellung der Informationsqualität.
• Die Forderung nach Verständlichkeit betrifft nicht nur den Text, sondern beispielsweise auch Illustrationen, die Terminologie oder die Struktur eines Informationsproduktes.
• Die Verständlichkeit eines Dokumentes ist nicht nur für den Bediener eines Produktes von Bedeutung, sondern auch für die technische Redaktion.