Lek3 - Dokumentanalyse

Die Dokumentenanalyse analysiert bestehender Dokumentation, um Schwachstellen und Stärken zu identifizieren. Bewertungen, gut und schlecht, müssen dabei immer sachlich begründet werden.

1.     Was wird untersucht - Angaben zum Gegenstand der Analyse und zur Vorgehensweise.

2.    Was sind die Kriterien - Darstellung der einzelnen Analysemerkmale und -kriterien.

3.    Beschreibung des Ist-Zustands - Darstellung der Analyseergebnisse, geordnet nach den Analysemerkmalen und -kriterien jeweils mit Beschreibung des Ist-Zustands

4. Bewertung des Ist-Zustands und daraus resultierenden Optimierungsvorschlägen

6.     Umfassende Stellungnahme zum analysierten Dokument.

7.     Falls notwendig, ein Anhang mit ausführlichen Optimierungsvorschlägen.

1.     Äußere Form und Ausführung

2.     Gestaltung & Abbildungen

3.     Einheitlichkeit & Verständlichkeit

4.     Orientierungshilfen und Verzeichnisse

5.     Strukturierung einzelner Sätze, Absätze, Themen, etc.

6.     Text & Sprache

7.     Rechtschreibung & Grammatik

8.     Sicherheits- und Warnhinweise

9.     Gesetze, Normen, Regeln und Richtlinien

10.  Vollständigkeit an Produktinformationen

Sicherheitshinweise weisen auf allgemeine Gefahren hin. Sie stehen am Anfang und gelten für das gesamte Dokument

Das Material, aus dem die Dokumentation besteht, muss für den späteren Anwendungsbereich, den Einsatzort und die Zielgruppe geeignet sein.

• Die Papierqualität sollte dem Anwendungszweck angemessen sein.

  Ein Werkstatt-Handbuch für eineAutowerkstatt z.B. sollte aus ölbeständigem stabilen Papier bestehen, die Anleitung einer Küchenma-schine sollte im Idealfall abwaschbar sein.

• Die Bindung sollte gebrauchsfest und langlebig sein.

• Das Format der Dokumentation muss in einem geeigneten Verhältnis zum Produkt stehen.

  Eine Anleitung im DIN-A4-Format passt genauso wenig zu einer Armbanduhr wie eine Anleitung im Miniformatzu einem Videorecorder.

  
  

—> Die äußere Form und Ausführung der Dokumentation muss den Anforderungen entsprechen, darf aber nicht zu aufwändig und kostenintensiv sein.

Das Produkt, seine Funktionen und der Anwendungsbereich müssen beschrieben werden, vorranging der sicherer und korrekter Gebrauch.

Weitere Inhalte:

• Leistungsdaten und -bedingungen

• Energieverbrauch

• Emissionen

• Informationen zur Entsorgung

Warnhinweise warnen Nutzern. Sie sind konkret situationsgebunden und stehen da im Text wo die Gefahr auftritt

• Typografie (Schriftfamilien, Schriftarten, Schriftgrößen)

• Satzspiegel (Spaltenaufteilung, Seitenränder)

• Seitenlayout (Gesamteindruck der Seite, Anordnung von Text und Bild, Lesefl uss)

Die innere Ordnung bezieht sich auf die grammatische Ebene der Textstruktur.

Die äußere Ordnung bezieht sich auf die thematische Ebene der Textstruktur.

In der Dokumentenanalyse werden zum Beispiel folgende Kriterien untersucht:

• sinnvolle Reihenfolge der Sätze im Text (z.B. das Wichtigste zuerst, Sicherheitshinweise vorHandlungen)

• sinnvolle, klare Gliederung des Textes in Absätze (z.B. jede Handlung in einem eigenen Absatz)

• thematisch sinnvolle und für die Leserinnen und Leser leicht zu erkennende Einteilung des Textes in Kapitel (z.B. Inbetriebnahme, Bedienung, Reinigung usw.)

• Wortebene

  Rechtshreibung und Zeichensetzung, Einheitlichkeit der Terminologie, Vermeidung von Komposita und Fremdwörtern

• Satzebene

  Sätze müssen kurz, klar, korrekt und pragmatisch sein.

• Absatz-Ebene

  Sinnvolle Bildung von Abschnitten, Übergängen und erhalten von logischen Bezügen

  
  

  —> Das oberste Ziel ist Verständlichkeit

Gleiche Symbolik für gleiche Informationen.

Klarer inhaltlicher Bezug von Text und Abbildung

Hoher Kontrast und schnelle Lesbarkeit

Hohe Auflösung und gute Qualität

Bei einer Überprüfung auf Normenkonformität muss in der Dokumentenanalyse untersucht werden, obdie speziell für das Produkt geltenden Normen und Richtlinien in der Dokumentation umgesetzt wur-den.

Außerdem muss geprüft werden, ob das Dokument die Normen und Richtlinien für Technische Doku-mentationen berücksichtigt.

ob die Sicherheitshinweise den Vorgaben entsprechen

ob sie normen- und richtlinienkonform sind (und auf welche Normen und Richtlinien man sich in derAnalyse bezieht)

ob über alle Restrisiken informiert wird

ob darin Fachbegriffe richtig verwendet werden

ob die Sicherheitshinweise konsistent gestaltet und formuliert sind

ob sie sich ausreichend vom Text abheben

ob sie an den richtigen Stellen stehen

Hauptteil der Seite, der tatsächliche Inhalt, enthält die Anleitungstexte und Bilder.

55-60 Zeichen pro Zeile

ist eine zusätzliche (schmale) Spalte links oder rechts von der Textspalte

geeignet für Stichwörter, seitliche Überschriften oder Piktogramme und kurze Fließtexte wie Zitate.

Sicherheits- und Warnsymbole können hier gut aufgehoben sein.

der äußere Rand, beschreibt in einem Buch den Weißraum zwischen dem Text und dem Seitenrand.

Er sollte nicht zu klein sein, damit die Seite genügend Weißraum enthält.

der Innensteg. Beschreibt in einem Buch den Weißraum zwischen dem Text und dem Bund.

Auch er sollte nicht zu klein sein, um den Weißraum ausreichend zugestalten. Außerdem dürfen die Textspalten bei gebundenen Werken nicht im Bund (der Falz)verschwinden.

Text am oberen Seitenende.

Hier fi ndet der Leser meist Informationen, die ihm die Ori-entierung erleichtern, z.B. wird in der Kopfzeile häufig die Überschrift des aktuellen Kapitels wiederholt

Lebender Kolumnentitel: Ändert sich von Kapitel zu Kapitel

Toter Kolumnentitel: Informationen, die sich nicht mit dem Anleitungsinhalt ändern, z.B. die Datei-oder Druckversion.

Die Beschnittzugabe ist für das gedruckte Werk gedacht, wenn dessen Seiten nach dem Druck und der Bindung beschnitten werden. Also zusätzlicher Weißraum außerhalb des Außenstegs.

Dieser Rand gehört aber nicht zur Seite.

Die Pagina ist die Seitennummerierung.

—> Sie sollte zum Außensteg hinstehen, damit der Leser sie schnell findet (und somit Seiten und Kapitel schnell anspringen kann).

Die Satzspiegelunterkante begrenzt den Satzspiegel nach unten. Die Pagina steht immer unter dem Satzspiegel, weil sie nicht Teil des Inhalts ist.

Der Satzspiegel ist die Nutzfläche eines Layouts, also der Teil der Seite, auf dem Texte und Bilder angeordnet werden.

Also die Textspalte + Marginalspalte + ggf. Fußnoten

Der obere und untere Weißraum zwischen dem Text-ende und dem Seiten-ende

• Schriftgröße von min. 10pt, max. 12pt für DINA4; min. 9pt., max. 10pt. für DINA5

• Zeilenabstand von 120% der Schriftgröße

• Absätze mit einem Zwischenraum von etwa einer Drittel-Zeile

• Schriftgrößen der Überschriften größer als die des Fließtextes

• Ausreichender Abstand zwischen Kapiteln

DONT:

-Komposita

-Nominalstil

-werbende Begriffe

-Fremdwörter

-Abkürzungen ohne Einführung

-Fachbegriffe ohne Einführung

-Füllwörter

-unnötige Synonyme

DO:

-neutral, sachlich

-simple Sprache die an der Leseniveau angepasst ist

-einheitliche Begriffe

-Erklärung unbekannter Begriffe

-Aufführung von Fremdwörtern in einem Glossar

-Korrekte Rechtschreibung + Zeichensetzung

Im Nominalstil werden Verben nomiertt.

Beispiel:

“Die Prüfung der Maschine erfolgt durch den Techniker”

“Der Techniker prüft die Maschine”

—> Verbalstil ist einfacher zu lesen und zu verstehen.

Nominalstil gilt als sachlich, formell, umständlich.

• Formulierungen:

  Passivkonstruktionen sind insbesondere in Handlungsanweisungen zu vermeiden (sie machen einen Text steif und sind häufig mehrdeutig).

• Satzlänge:

  Zu lange Sätze oder Schachtelsätze sollten in Technischen Dokumentationen nicht verwendetwerden.

  Die einzelnen Satzteile sollten etwa gleich lang sein. (thats terrible writing advice lol don’t do that)

• Grammatik:

  Das Dokument sollte keine unvollständigen Sätze enthalten.