00:00:00
die Informationsqualität sie soll nach
00:00:03
der Diener Triple
00:00:06
i82.0791 sichergestellt werden durch 7
00:00:10
Prinzipien insbesondere eine dieser
00:00:12
Prinzipien begegnet uns oftmals bereits
00:00:15
in der vom Kunden übermittelten
00:00:16
technischen Dokumentation es geht um das
00:00:20
Prinzip der Verständlichkeit und damit
00:00:23
ein herzliches willkommen zu einer neuen
00:00:25
Folge unseres Podcasts zur Technischen
00:00:27
Dokumentation mein Name ist Frank Sommer
00:00:30
und ich bin Technischer Redakteur bei
00:00:32
der GFT Akademie
00:00:34
Verständlichkeit was ist das eigentlich
00:00:36
was verbirgt sich hinter diesem Begriff
00:00:39
Wikipedia beschreibt es meiner Meinung
00:00:41
nach recht gut Zitat Verständlichkeit
00:00:44
ist im kommunikativen Handeln eine
00:00:46
Grundbedingung dafür dass etwas
00:00:48
verstanden werden kann
00:00:50
Verständlichkeit genauer die Forderung
00:00:53
nach der Verständlichkeit der
00:00:54
technischen Dokumentation insbesondere
00:00:56
in Hinblick auf sicherheitsrelevante
00:00:58
Informationen wird in vielen Richtlinien
00:01:01
eingefordert so zum Beispiel in der
00:01:03
Maschinenrichtlinie bzw der neuen
00:01:06
Maschinenverordnung der
00:01:07
Niederspannungsrichtlinie der im
00:01:09
vorrichtlinie der funkanlagenrichtlinie
00:01:11
oder der Medizinprodukte Verordnung
00:01:15
nun ist es mit der Verständlichkeit ein
00:01:17
recht einfache Sache wenn es um das
00:01:19
gesprochene Wort geht anhand der
00:01:21
Reaktionen meines Gegenübers kann ich
00:01:23
recht schnell erkennen ob das was ich
00:01:25
Vortrage auch im von mir beabsichtigten
00:01:27
Maße ankommt also ob es verstanden wird
00:01:30
und gegebenenfalls darauf entsprechend
00:01:32
reagieren in Schriftwerken wie bei uns
00:01:35
in der technischen Dokumentation wird es
00:01:37
da schon deutlich schwieriger meist
00:01:40
erfahren wir gar nicht ob unsere Werke
00:01:41
verstanden werden oder aber erst dann
00:01:43
wenn beispielsweise eine Reklamation
00:01:45
vorliegt aber die Verständlichkeit einer
00:01:48
Information hängt nicht nur von
00:01:50
demjenigen ab der eine Information teilt
00:01:52
sondern auch von demjenigen für den die
00:01:55
Informationen bestimmt ist einem
00:01:57
technischen Laien wird auch die
00:01:59
bestformulierte Betriebs- oder
00:02:00
Bedienungsanleitung nichts nutzen wenn
00:02:02
der fachlich gar nicht in der Lage ist
00:02:03
sie zu verstehen Stichwort
00:02:05
Zielgruppenanalyse zum Thema Zielgruppen
00:02:08
verweise ich auf einen Podcast meines
00:02:11
Kollegen Florian Schmieder den
00:02:13
entsprechenden Link habe ich in den
00:02:14
schon Notes hinterlegt
00:02:16
die Wichtigkeit der Verständlichkeit ist
00:02:19
nun aber nicht nur auf das gesprochene
00:02:21
oder geschriebene Wort beschränkt auch
00:02:23
Bilder Grafiken Animationen Diagramme
00:02:25
kurz alles was der Illustrationen im
00:02:28
Zusammenhang mit der
00:02:29
Informationsvermittlung dient muss
00:02:31
verständlich aufbereitet sein dabei ist
00:02:34
aber zu berücksichtigen dass eine
00:02:36
Illustration für sich alleine nicht
00:02:37
immer jeden Sachverhalt umfassend
00:02:39
darlegen kann vielfach wird ein
00:02:41
beschreibender Text benötigt um
00:02:43
Verständlichkeit herzustellen dennoch
00:02:45
gibt es sie die Bilder die auch völlig
00:02:48
ohne Text erklären denken wir nur an die
00:02:51
utility-videos ein weiterer Punkt der
00:02:54
Einfluss auf die Verständlichkeit eines
00:02:55
Dokumentes nimmt ist seine Struktur dies
00:02:59
wird in der dienenden ic-triple
00:03:02
i82-791 in Kapitel 81 auch so gefordert
00:03:05
ich habe leider schon einige
00:03:07
Betriebsanleitungen zur Prüfung oder
00:03:09
Neuerstellung gesehen bei denen
00:03:11
keinerlei sinnvolle Struktur erkennbar
00:03:13
war dies beginnt meist mit einer
00:03:16
fehlenden Reihenfolge nach
00:03:17
produktlebensphasen und endet irgendwo
00:03:20
mit im Dokument scheinbaum unmotiviert
00:03:22
eingestreuten Kapiteln zu einem
00:03:24
bestimmten Thema bestenfalls noch mit
00:03:27
einem Querverweis versehen Querverweise
00:03:29
sind übrigens auch so ein Thema gerade
00:03:32
bei umfangreichen Dokumenten geht es
00:03:34
nicht ohne sie allerdings sollte man sie
00:03:36
nach einer Dokumenten weiten
00:03:38
Terminologie gestalten und möglichst nur
00:03:40
auf Inhalte anwenden die sachlich
00:03:42
zueinander gehören
00:03:43
Querverweise über mehrere Ebenen hinweg
00:03:46
also ein Querverweis auf einen
00:03:48
Querverweis auf einen Querverweis sind
00:03:50
nach meiner Auffassung nicht zielführend
00:03:53
viele weitere Punkte nehmen Einfluss auf
00:03:55
die Verständlichkeit auf alle werde ich
00:03:57
hier nicht eingehen allerdings scheint
00:03:59
mir einer doch besonders erwähnenswert
00:04:01
es geht um die Terminologie und in
00:04:04
diesem Zusammenhang um die Verwendung
00:04:05
von Fachsprache zum einen finde ich ihn
00:04:08
zu bearbeitenden Dokumenten immer wieder
00:04:09
vor dass für einen Begriff mindestens
00:04:12
zwei manchmal sogar drei Benennung
00:04:14
verwendet werden das alleine ist schon
00:04:16
ein Problem allerdings wird dies noch
00:04:18
gesteigert wenn Benennung verwendet
00:04:20
werden die sich nicht mehr kognitiv
00:04:22
zuordnen lassen und der Leser dann nicht
00:04:24
mehr weiß was nun gemeint ist gegen die
00:04:27
Verwendung von Fachsprache ist überhaupt
00:04:28
nichts einzuwenden wenn sie da ein
00:04:30
Gesetz wird wo es erforderlich und
00:04:32
sinnvoll ist so zum Beispiel in
00:04:34
Serviceanleitung denn hier ist die
00:04:36
Zielgruppe relativ homogen es handelt
00:04:38
sich in der Regel um Fachpersonal das
00:04:40
mit dieser Terminologie vertraut ist nun
00:04:43
bemühen wir technischen Redakteure und
00:04:45
sehr tagtäglich bei unserer Arbeit darum
00:04:47
unsere Informationsprodukte eben auch
00:04:49
nach dem Prinzip der Verständlichkeit zu
00:04:51
erstellen das ist die eine Seite der
00:04:53
Medaille die andere Seite ist die und
00:04:56
damit bin ich bei dem Anlass für den
00:04:57
heutigen Podcast auch technische
00:04:59
Redakteure haben auf der input-seite mit
00:05:01
dem Verständlichkeit zu tun ich gehe
00:05:03
sogar so weit zu sagen zu kämpfen es
00:05:06
geht um die Dokumente die man von Kunden
00:05:08
überreicht bekommt beispielsweise mit
00:05:10
dem Auftrag daraus eine
00:05:11
Betriebsanleitung zu erstellen und diese
00:05:13
Dokumente haben es teilweise in sich
00:05:15
leider jedoch oftmals auch in negativer
00:05:18
Hinsicht und das macht zumindestens mehr
00:05:21
die Arbeit regelmäßig sehr schwer und
00:05:23
führt zu großem Unmut meinerseits worum
00:05:27
geht es konkret hier einige Beispiele
00:05:30
aus der Praxis Beispiel 1
00:05:32
die Lieferung des Produktes erfolgt in
00:05:35
mehreren Teilen Teil 1 Teil 2 und Teil 3
00:05:38
klingt erst einmal nicht schlecht nur
00:05:41
muss man dazu wissen dass an anderer
00:05:43
Stelle dieses Dokuments herauskamen das
00:05:45
zu dem Produkt noch weitere Elemente
00:05:46
Teile es Lieferumfang sind was jedoch im
00:05:48
eigentlichen Kapitel zum Lieferumfang
00:05:50
mit keinem Wort erwähnt wird damit nicht
00:05:53
genug existierte zu keinen der benannten
00:05:55
Teile auch nur eine einzige Illustration
00:05:57
beispielsweise
00:05:59
sollte der Abstand zwischen Modul a und
00:06:02
Modul B zu groß sein muss der
00:06:04
Anschlusswert angepasst werden
00:06:05
weitere Informationen gab es hierzu
00:06:08
nicht mir stellte sich daher die Frage
00:06:10
wann ist der Abstand zwischen Modul a
00:06:12
und Modul B den korrekt bzw man ist ja
00:06:16
zu groß und welcher anschlusswert ist
00:06:18
hier wie anzupassen
00:06:20
Beispiel 3
00:06:22
der sammelablauf sollte tiefer als der
00:06:25
sammelwasserbehälter montiert werden nun
00:06:27
das ist schon aus physikalischen Gründen
00:06:29
zu empfehlen aber um welches Maß und
00:06:32
sollte abgesehen davon dass es sich um
00:06:35
einen zu vermeidendes Modalverb handelt
00:06:37
das heißt der Ablauf muss gar nicht
00:06:39
zwingend tiefer liegen wehe das
00:06:41
interpretiert der Monteur falsch
00:06:44
Beispiel 4 alle elektrischen
00:06:46
Verbindungslinien sind ordnungsgemäß
00:06:49
auszuführen
00:06:50
nun gut ich bin gelernter
00:06:52
Elektrotechniker und nach nochmaligen
00:06:54
gegenprüfen das betreffenden Kapitels
00:06:56
zur Sicherheit gelangte ich dann zu der
00:06:58
Überzeugung dass der Autor mitteilen
00:07:00
wollte alle elektrischen Leitungen sind
00:07:02
fachgerecht zu verlegen und
00:07:03
anzuschließen ich gehe davon aus dass
00:07:06
dies jeder meiner Kollegen auch so
00:07:07
interpretiert dennoch könnten wir bei
00:07:10
einem weltweit Vertriebenen Produkt
00:07:11
sicher sein dass jeder der mit dem
00:07:13
Anschluss einer solchen Maschine betraut
00:07:15
ist diese Anweisung wirklich versteht
00:07:18
Beispiel 5 nach Beseitigung der
00:07:21
Verstopfung ist eine neuinbetriebnahme
00:07:23
erforderlich also eine neue
00:07:25
Inbetriebnahme wird vermutlich fast
00:07:27
jeder mit einer ersten Inbetriebnahme
00:07:29
bzw als Maßnahme nach einer erfolgten
00:07:32
Rücksetzung auf Werkseinstellung
00:07:33
interpretieren das kommt durchaus vor in
00:07:36
diesem Fall jedoch meinte der Outdoor
00:07:38
schlichtweg schalten Sie die Maschine
00:07:40
wieder ein und mit solchen Informationen
00:07:43
an der Hand sollen wir technischen
00:07:45
Redakteure nun eine Informationsprodukt
00:07:47
für den sicheren Gebrauch erstellen was
00:07:49
folgt daraus wenn man nicht gerade das
00:07:52
Produkt um das es geht im direkten
00:07:53
Zugriff hat um die Aussage praktisch
00:07:55
nachzuvollziehen bleiben nur
00:07:57
zeitaufwendige Rückfragen beim
00:07:59
Auftraggeber diese Kosten Zeit und
00:08:01
manches Mal auch nerven
00:08:03
dabei sind einige dieser Beispiele
00:08:05
keineswegs aus Bösartigkeit entstanden
00:08:07
das hoffe ich doch zumindest sondern
00:08:09
vermutlich schlichtweg dem Umstand
00:08:11
geschuldet dass derjenige der etwas
00:08:13
konstruiert so tief in der Materie
00:08:16
steckt dass er bei jemandem dem er etwas
00:08:18
erklärt einfach ein Gewissen
00:08:19
Kenntnisstand voraussetzt leider geht
00:08:21
das so manches Mal dann schief und ist
00:08:24
in der technischen Dokumentation der
00:08:25
falsche Ansatz umso mehr wird daran
00:08:28
deutlich wie wichtig die Zusammenarbeit
00:08:30
zwischen Entwicklungsabteilung und
00:08:32
technischer Redaktion ist
00:08:34
Maßnahmen zur Sicherstellung der
00:08:36
Verständlichkeit sind wie bereits
00:08:38
erwähnt auch bei Elementen der
00:08:39
Visualisierung anzuwenden wie oft habe
00:08:42
ich beispielsweise Screenshots von
00:08:43
Displays einer Maschinensteuerung
00:08:45
gesehen die bei falscher Beleuchtung
00:08:47
Stichwort zu dunkel oder Lichtreflexe
00:08:49
einfach abfotografiert wurden wie oft
00:08:52
habe ich Illustrationen gesehen bei
00:08:54
denen das Element um das es im
00:08:56
begleitenden Text geht schlichtweg
00:08:57
untergeht weil der Bildausschnitt zu
00:09:00
viel Umgebungsraum zeigt
00:09:01
insbesondere an diesen beiden eben
00:09:03
gehörten Beispielen sehen wir übrigens
00:09:05
dass es gar nicht so einfach ist immer
00:09:06
eine strikte Kategorisierung
00:09:08
hinsichtlich der 7 Prinzipien der
00:09:10
Verständlichkeit vorzunehmen zur
00:09:12
Erinnerung sie heißen Vollständigkeit
00:09:14
Minimalismus Korrektheit Prägnanz
00:09:17
Konsistenz Verständlichkeit und
00:09:20
Verfügbarkeit
00:09:22
verstößt also mein Beispiel mit dem
00:09:24
Bildausschnitt der zu viel Umgebungsraum
00:09:27
zeigt nicht eher gegen das Prinzip des
00:09:28
Minimalismus und der Prägnanz darüber
00:09:31
lässt sich vermutlich trefflich streiten
00:09:33
ich sehe es zumindest so eine
00:09:36
Illustration deren Kernaussage sich mir
00:09:38
nicht auf den ersten Blick erschließt
00:09:39
ist für mich unverständlich vergessen
00:09:42
wir nicht es geht hier um
00:09:43
Informationsprodukte die den sicheren
00:09:45
Gebrauch eines Produktes ermöglichen
00:09:47
sollen da bleibt keine Zeit sich zu
00:09:49
fragen was wollte der Meister uns mit
00:09:51
diesem Bild sagen und im Prinzip ist es
00:09:54
doch so wir technischen Redakteure
00:09:56
kommen wohl überwiegend aus zwei Welten
00:09:58
die einen haben technische Kommunikation
00:10:01
auf der Hochschule von der Pike
00:10:03
aufgelernt die anderen so wie ich kommen
00:10:05
als Praktiker mit Jahrzehnte langer
00:10:07
Berufserfahrung aus einem technischen
00:10:08
Sektor und sind technische Redakteure
00:10:10
als Seiteneinsteiger geworden gemeinsam
00:10:13
stehen wir aber oftmals vor dem gleichen
00:10:15
Problem der technische Redakteur von der
00:10:18
Hochschule wird mangels jahrelanger
00:10:19
praktischer Erfahrung in irgendeinem
00:10:21
technischen Sektor zu Hause hilflos
00:10:23
reinschauen wie ich wenn es
00:10:24
beispielsweise um den technischen Teil
00:10:26
einer Betriebsanleitung zu einer
00:10:28
komplexen Anlage aus der
00:10:29
Verfahrenstechnik geht umso mehr ist es
00:10:32
von großer Wichtigkeit dass wir für
00:10:34
unsere Arbeit Informationen an die Hand
00:10:36
bekommen die auch für uns verständlich
00:10:38
sind halten wir also fest das ein
00:10:41
Informationsprodukt verständlich sein
00:10:43
muss wird von vielen EU-Richtlinien bzw
00:10:46
Verordnungen gefordert das Prinzip der
00:10:49
Verständlichkeit ist eines der sieben
00:10:51
Prinzipien zur Sicherstellung der
00:10:53
Informationsqualität
00:10:55
die Forderungen nach Verständlichkeit
00:10:56
betrifft nicht nur den Text sondern
00:10:59
beispielsweise auch Illustrationen die
00:11:01
Terminologie oder die Struktur eines
00:11:03
informationsproduktes
00:11:05
und die Verständlichkeit eines
00:11:07
Dokumentes ist nicht nur für den
00:11:09
Bediener eines Produktes von Bedeutung
00:11:10
sondern auch für die technische
00:11:13
Redaktion
00:11:15
und damit sind wir am Ende unserer
00:11:17
heutigen Folge wenn Ihnen diese gefallen
00:11:19
hat dann lassen Sie uns doch ein Abo da
00:11:22
klicken Sie hierzu ganz einfach auf die
00:11:24
Schaltfläche abonnieren unter dem Player
00:11:26
Bedienfeld so verpassen Sie keine Folge
00:11:30
vielen Dank fürs zuhören und bleiben Sie
00:11:32
der technischen Dokumentation gewogen
00:11:34
hier Frank Sommer
