LesehilfenUnter Lesehilfen versteht man im Bereich der Technischen Dokumentation sämtlicheHilfestellungen für den Leser, die ihm das Lesen und Verstehen des Textes und die Orientierungbzw. Navigation im Text erleichtern sollen.Überprüft wird, ob Orientierungs- und Navigationshilfen überhaupt vorhanden sind und ob siefunktionieren. Dies können z. B. sein:• Glossare, in denen verwendete Fach- und Fremdwörter erläutert werden oder auch• Abkürzungsverzeichnisse, die noch einmal (zusätzlich zur Aufschlüsselung beim erstenAuftreten der Abkürzung) eine Aufschlüsselung der verwendeten Abkürzungen z. B. inTabellenform beinhalten sollten.• Inhaltsverzeichnis,• Stichwortverzeichnis (Index),• Tabellenverzeichnis,• Abbildungsverzeichnis• Literaturverzeichnis.Weitere Orientierungshilfen sind Kolumnentitel, Randmarken und auch Verweise auf andereTextstellen.Wichtig bei der Bewertung sollte sein, dass nicht nur auf das bloße Vorhandensein derVerzeichnisse, Glossare und Verweise geachtet wird, sondern dass das Hauptaugenmerk auf ihrerVollständigkeit und Funktionalität liegen sollte. Gerade bei Verweisen ist es wichtig, dass sie exaktund ohne Umwege zur referenzierten Textstelle führen.TextDem Text, meistens der Kern der Technischen Dokumentation, sollte große Aufmerksamkeitgeschenkt werden. Er entscheidet über die Verständlichkeit der Gebrauchs- oderBetriebsanleitung und darüber, ob der Leser sich auch so verhält, wie es der Autor derTechnischen Dokumentation vorgesehen hat.Ein Text kann und sollte auf verschiedenen Ebenen untersucht werden:• Rechtschreibung und Zeichensetzung (Orthographie/Interpunktion)• Wortebene (Begriffswahl/Terminologie und grammatikalisch richtige Verwendung derBegriffe)• Satzebene (syntaktische Korrektheit, Eindeutigkeit, keine Passivkonstruktionen,Unterscheidung zwischen beschreibenden Texten, Handlungsanweisungen undSicherheitsinformationen)8
SicherheitshinweiseWird eine Technische Dokumentation hinsichtlich ihrer Sicherheitshinweise untersucht, sollte aufdrei wesentliche Punkte eingegangen werden:1. Sind die Sicherheitshinweise vollständig? Stehen überall dort, wo Gefahren für den Anwenderentstehen können, entsprechende Sicherheitshinweise? Wird nicht nur innerhalb desAnleitungstextes vor Gefahren gewarnt, sondern ist auch ein Kapitel „AllgemeineSicherheitshinweise“ vorhanden? Wird die bestimmungsgemäße Verwendung definiert, für diedas Gerät oder die Maschine gebaut worden ist? Wird vor voraussehbarenbestimmungswidrigen Verwendungen gewarnt?2. Stehen die Sicherheitshinweise an der richtigen Stelle? Innerhalb eines Anleitungskapitelsmüssen Sicherheitshinweise vor den Handlungsanweisungen stehen. AllgemeingültigeSicherheitshinweise wie z. B. Hinweise zu Lärmemissionen einer Maschine müssen in einemKapitel „Allgemeine Sicherheitshinweise“ am Anfang der Dokumentation stehen.3. Sind die Sicherheitshinweise als solche zu erkennen? Sind sie durch ein Piktogramm,Signalwort und einen fetteren Schriftschnitt ausgezeichnet? Sind die Sicherheitshinweiseeindeutig formuliert? Werden neben der Gefahrenquelle auch Möglichkeiten zurGefahrenvermeidung und Konsequenzen bei Nichtbeachtung benannt?Abbildungen, VisualisierungenAbbildungen sollen den Text ergänzen oder manchmal auch vollständig ersetzen, wo eine reinsprachliche Beschreibung der Situation nicht ausreicht. Dies ist meistens dort erforderlich, woz. B. die Position oder das Aussehen eines Geräteteils beschrieben werden soll. In solchenSituationen ist eine Abbildung des Gerätes oder des Geräteteils sinnvoller und eindeutiger.Abbildungen können aber nur dann den an sie gestellten Anforderungen gerecht werden, wennsie einige Voraussetzungen erfüllen:• Die Art der Abbildung muss dazu geeignet sein, den Sachverhalt zu verdeutlichen. Oft ist eineStrichzeichnung einer detaillierten Fotografie vorzuziehen, ein Gerätedetail ist besser zuerkennen, wenn es besonders gekennzeichnet ist.• Reicht die Anzahl der Abbildungen aus, sind zu wenige oder gar zu viele Abbildungenvorhanden?• Befinden sich die Abbildungen an der richtigen Position und vereinfachen dadurch dasReferenzieren zwischen Text und Abbildung? Ist dies nicht der Fall, dann ist eine eindeutigeText-Bild-Zuordnung schwierig.• Wird eine detaillierte Abbildung, wie z. B. eine Geräteübersicht, durch eine Legende erläutert?Dies sorgt für eine schnellere Identifizierung der einzelnen Geräteteile und erspart demAnwender das Blättern in der Betriebsanleitung.Bei Visualisierungen, wie z. B. Diagrammen und Piktogrammen, muss darauf geachtet werden,dass sie erläutert werden müssen, wenn sie nicht als allgemein bekannt vorausgesetzt werdenkönnen. Weiterhin ist vor allem bei Piktogrammen darauf zu achten, dass sie zumindest dem ingängigen Normen definierten Standard entsprechen oder Eigenentwicklungen darstellen, diegeeignet erscheinen, den Standard zu erfüllen.9