Dokumentation ()

Download Report

Transcript Dokumentation ()

Technische Dokumentation

Dipl. Tech. Red. Raphaela Schmidt [email protected]

Was erwartet Sie?

Berufsbild eines Technischen Redakteurs Gesetze, Normen und Richtlinien Typografie Standardisierungsmethoden Bildbearbeitung Adobe Photoshop Tutorial Microsoft Word 2010 (siehe PDF) SS 2011, R. Schmidt 2

Prüfungsleistung: Projektarbeit

Selbstständige Erstellung einer standardisierten, normgerechten Bedienungsanleitung mit MS Word • • Bearbeitung des Projekts in Dreiergruppen. Die Gruppenfindung ist Aufgabe der Studierenden.

Das zu beschreibende technische Gerät wählt jede Gruppe selbst. Geeignet sind einfache technische Geräte mit potentiell sicherheitsrelevanten Anwendungsfehlern, z.B. Toaster, Mikrowelle, Kaffeemaschine, Mixer, Brotbackautomat, Fön, Bohrmaschine,… Details siehe „Projektarbeit Aufgabenstellung.pptx“.

SS 2011, R. Schmidt 3

Zeitplanung der Projektarbeit

• • • • • Fr, 18.03.

Festlegung der Projektgruppen Sa, 19.03. Festlegung der Projektthemen Fr, 08.04.

Feedback zur Projektarbeit: Mindestens Vorlage des Soll-Zeitplans sowie der kompletten Texte mit zugewiesenen funktional benannten Formatvorlagen Fr, 15.04.

Fr, 29.04

Feedback zur Projektarbeit Abgabe und Präsentation SS 2011, R. Schmidt 4

Projektphase

Input Projektarbeit Abgabe

Zeitplanung

Datum

Fr, 18.03.

Sa, 19.03.

So, 20.03. bis Do, 28.04.

Fr, 25.03.

Fr, 01.04.

Fr, 08.04.

Fr, 15.04.

Fr, 29.04.

Thema

Berufsbild; Gesetze, Normen & Richtlinien, Typographie, Festlegung der Projektgruppen MS Word, Funktionsdesign, MS Word, Details zur Aufgabenstellung der Projektarbeit, Festlegung der zu dokumentierenden Produkte Selbstständige Projektarbeit Kein Seminar, Raum ist frei Kein Seminar, Raum ist frei Besprechung der Funktionsdesign-Hausaufgabe, Feedback zur Projektarbeit MS Word, Feedback zur Projektarbeit Abgabe und Präsentation der Projektarbeit, Bildbearbeitung, Adobe Photoshop Tutorial SS 2011, R. Schmidt 5

Berufsbild eines Technischen Redakteurs

SS 2011, R. Schmidt 6

Typisches Aufgabenspektrum

Dokumentation erstellen • Recherche • Gefahren-/Risikoanalyse • Text- und Bilderstellung • Ggf. Koordination von Übersetzungsagentur, Grafikern, Druckerei, Redaktionsdienstleister) • Review, Freigabe, Publizierung Regeln und Prozesse definieren • Schreib-, Grafik-, Layoutregeln festlegen • Prozesse definieren (Recherche, Review, Freigabe, Publizierung, Archivierung) • Software auswählen und ggf. customizen • Redaktionsleitfaden erstellen Konzept erstellen • Zielgruppen definieren • Textsorten festlegen • Sprachvarianten und Übersetzungen planen • Publikationsmedien aussuchen SS 2011, R. Schmidt 7

Software-Werkzeuge

Desktop-Publishing-Tools (DTP) Content-Management-Systeme (CMS) Terminologiemanagement-Systeme Tools zur Bildbearbeitung Translation-Memory-Systeme (TMS) SS 2011, R. Schmidt 8

Content-Management-System (CMS)

• • Trennung von Inhalt, Struktur und Layout Gleiche Inhalte können unterschiedlich formatiert ausgegeben werden (z.B. als PDF und Onlinehilfe) Editor Genera tor Forma tierer Daten bank SS 2011, R. Schmidt Sinnvoll bei hohem Wiederverwendungsgrad von Modulen 9

Content-Management-System (CMS)

Auswahl möglicher weiterer Features • • • • • Benutzerverwaltung (Rollen, Benutzerrechte) Versionsverwaltung Workflowkonzept Unterstützung von Variablen (Möglichkeit der Anbindung von) • Terminologiemanagement-System • Translation Memory-Systeme SS 2011, R. Schmidt 10

Single Source Publishing & Cross Media Publishing

Quelle Onlinehilfe Ersatzteil katalog Manual für Produkt 1 Manual für Produkt 2 SS 2011, R. Schmidt Schulungs unterlagen 11

Translation-Memory-System (TMS)

• Probleme für Übersetzer ohne TMS: – Zeitverlust durch Suchen bestehender Übersetzungen – Risiko, dass nicht die aktuellste Version gefunden wird.

– Zeitverlust durch erneutes Übersetzen – Keine einheitlichen Übersetzungen SS 2011, R. Schmidt 12

Translation-Memory-System (TMS): Funktionsweise

• Zerlegt Quelltext und übersetzen Text in Segmente (i.d.R. Sätze) und speichert Quelltext und übersetzten Text als Segmentpaare. Beispiel: - Anfang des Segmentpaares Deutsch: Klicken Sie auf die Schaltfläche "Löschen".

Englisch: Click on the button "Delete".

- Ende des Segmentpaares • Bei neuer Übersetzung: – Das TMS zerlegt den neuen Text in Segmente, – gleicht diese Segmente mit bereits gespeicherten Segmenten ab und – 100 % matches: Identische Segmente: Automatische Übersetzung – Fuzzy matches: Ähnliche Segmente: Bietet dem Übersetzer den ähnlich übersetzten Satz an. SS 2011, R. Schmidt 13

Translation-Memory-System (TMS)

• Sinnvolle Einsatzgebiete: Wenn Textmodule immer wieder übersetzt werden müssen, also bei – Häufigen Updates – Verwandten Produktmodellen • Vorteile: – – Zeit-/Kostenersparnis Aktualität – Konsistenz SS 2011, R. Schmidt 14

Terminologiemanagement

„Gleiche Dinge mit gleichen Wörtern benennen“ 1. Fach- und Unternehmensterminologie extrahieren 2. Begriffsbedeutungen durch Definitionen festlegen 3. Begriffssysteme erstellen 4. Ergebnisse veröffentlichen, z. B. im Intranet 5. Texte entsprechend überarbeiten SS 2011, R. Schmidt 15

Terminologiemanagement

Ziele: – Fachkommunikation wird verbessert – Bedienungsanleitungen werden verständlicher – Weniger Fehler in Übersetzungen – TMS sind effizienter, geringere Übersetzungskosten – Unternehmensimage wird gestärkt („Corporate Language“) SS 2011, R. Schmidt 16

Terminologie-Management-System

• • Verwaltet Terminologie in einer Datenbank Ist u.U. in ein Content-Management-System oder ein Translation-Memory-System integriert SS 2011, R. Schmidt 17

Gesetze, Normen und Richtlinien

SS 2011, R. Schmidt 18

Konsequenzen im Schadensfall Zivilrecht (BGB)

• Gewährleistungsansprüche bei Mängeln • Schadensersatzansprüche bei Personen und Sachschäden

Öffentliches Recht

• Produktverbote durch Marktaufsichtsbehörden

Strafrecht (StGB)

• Strafrechtliche Verfolgung der Doku Verantwortlichen bei schwerwiegenden Personenschäden durch mangelhafte Dokumentation SS 2011, R. Schmidt 19

Fehlerarten bei fehlerhaften Produkten (§ 823 BGB)

– Konstruktionsfehler – Fabrikationsfehler – Fehler in der Organisation – Produktbeobachtungsfehler –

Instruktionsfehler

SS 2011, R. Schmidt 20

Produkthaftung (§ 823 BGB)

• Instruktionspflicht  Instruktionspflicht – Vor Gefahren warnen • Aufklärungspflicht des Herstellers • Warnhinweise müssen spezifisch sein • Zielgruppengerechte Instruktion • Erfahrungswissen darf vorausgesetzt werden SS 2011, R. Schmidt 21

Vorgaben für Techn. Doku

• Produkthaftungsrichtlinie • Produktsicherheitsrichtlinie • Maschinenrichtlinie • Produkthaftung nach § 823 BGB • Produkthaftungsgesetz • Geräte- und Produkt sicherheitsgesetz • 9. Verordung zum GPSG EU-Richtlinien & Gesetze • DIN EN 62079 • ISO 12100-2 • ANSI Z535.6

• … Normen SS 2011, R. Schmidt • Richtlinie zur Erstellung von Sicherheits hinweisen in Betriebs anleitungen • … Richtlinien 22

Gesetze und EU-Richtlinien

SS 2011, R. Schmidt 23

EU-Richtlinien

• • • Harmonisierung von Gesetzen  Optimierung des EU-Binnenmarktes Wesentliche Teile nationaler Gesetze folgen aus der Umsetzung von EU-Richtlinien Verpflichtung der EU-Mitgliedsstaaten EU Richtlinien innerhalb bestimmter Fristen (i. a. 2 Jahre) national umzusetzen SS 2011, R. Schmidt 24

Nationale Umsetzung von EU Richtlinien

Produkthaftungs richtlinie Produktsicherheits richtline Maschinen richtlinie Produkthaftungs gesetz Geräte- und Produktsicherheits gesetz 9. Verordnung zum GPSG SS 2011, R. Schmidt 25

Überblick Gesetze und Richtlinien

Forderung Gesetz / Richtlinie

Ein Produkt darf (…) nur in den Verkehr gebracht werden, wenn […] Sicherheit und Gesundheit […] nicht gefährdet werden. [Anleitungen, Darbietung] Informationen um Gefahren beurteilen und sich dagegen schützen können Geräte- und Produktsicherheitsgesetz (GPSG) GPSG Gebrauchsanleitung in deutscher Sprache beim Inverkehrbringen mitliefern CE-Kennzeichen EG-Konformitätserklärung Schadensersatz GPSG • GPSG • EG-Maschinenrichtlinie (2006/42/EG) • 9. Verordnung zum Geräte- und Produktsicherheitsgesetz (GPSGV 9) • • EG-Maschinenrichtlinie (2006/42/EG) GPSGV 9 • Produkthaftung nach § 823 BGB • Produkthaftungsgesetz (ProdHaftG) SS 2011, R. Schmidt 26

EG-Konformitätserklärung

= Rechtsverbindliche Bestätigung des Herstellers (oder seines in der Europäischen Gemeinschaft niedergelassenen Bevollmächtigten), dass sein Produkt alle sicherheits technischen Anforderungen der auf dieses Produkt anwendbaren EG-Richtlinien erfüllt oder mit der Bauart konform ist, für die eine EG-Baumusterprüfbescheinigung ausgestellt wurde.

SS 2011, R. Schmidt 27

Inhalt einer EG-Konformitätserklärung

• • • • Name und Anschrift des Herstellers (oder seines Bevollmächtigten) Beschreibung des Produkts Die für das Produkt bekannt gemachten harmonisierten oder anerkannten Normen Namen und Anschriften der Prüf-, Überwachungs- und Zertifizierungsstellen • Name und Funktion der Person, die zur Unterzeichnung im Namen des Herstellers oder seines Bevollmächtigten ermächtigt ist Genaue Angaben siehe jeweilige EG-Richtlinie des betreffenden Produkts. Muster siehe PDF.

SS 2011, R. Schmidt 28

EG-Maschinenrichtlinie (2006/42/EG)

• http://eurlex.europa.eu/LexUriServ/LexUriServ.do?ur

i=OJ:L:2006:157:0024:0086:DE:PDF 1. Was bedeutet die CE-Kennzeichnung einer Maschine?

2. In welcher/n Sprache(n) muss eine Betriebsanleitung für Maschinen ausgeliefert werden?

3. In welchem Artikel findet man Mindestinhalte für Betriebsanleitungen von Maschinen?

4. In welchem Artikel findet man Mindestinhalte für EG-Konformitätserklärungen von Maschinen?

SS 2011, R. Schmidt 29

Normen

SS 2011, R. Schmidt 30

Normungsgremien

SS 2011, R. Schmidt 31

Normen

• • Anerkannte Regeln der Technik unterschiedlicher Gremien Keine generelle Anwendungspflicht, außer Vorgabe aus Rechtsvorschriften oder Verträgen.

• Im Haftungsfall: – – Bei Einhaltung der Norm: Widerlegbare Erfüllungsvermutung sich schuldig gemacht hat.

: Die geschädigte Partei trägt die Beweislast, dass der Hersteller Bei Nichteinhaltung der Norm: Beweislastumkehr : Der Hersteller trägt die Beweislast, dass er keine Schuld trägt.

Beweislastumkehr ist eine Ausnahme von dem Grundsatz, dass grundsätzlich jede Partei die Beweislast für die tatsächlichen Voraussetzungen der ihr günstigen Rechtsnorm trägt.

SS 2011, R. Schmidt 32

Normen zur Techn. Dokumentation

Deutschland • DIN EN 62079 • ISO 12100-2, Abschnitt 6 • … USA • ANSI Z535.6

• … Produkt spezifisch SS 2011, R. Schmidt 33

DIN EN 62079 „Erstellen von Anleitungen“

• • Wendet sich an Technische Redakteure Inhalte: • Grundlegende Inhalte und Strukturen • Beispielhaftes Inhaltsverzeichnis • Kommunikationsprinzipien • Checklisten (kostenloser Download möglich) • … SS 2011, R. Schmidt 34

ISO 12100-2 „Sicherheit von Maschinen“

Wendet sich v. a. an Konstrukteure, in Abschnitt 6 Aussagen zur Benutzerinformation: – Mindestangaben – Infos zu Kennzeichnungen auf der Maschine (Angabe des Herstellers, Serien-/Typbezeichnung, …) – Benutzerinformation in der Sprache des Landes, in dem die Maschine zum ersten Mal eingesetzt wird – Bestmögliche Lesbarkeit der Schriftart/-größe, Hervorhebung von Sicherheitshinweisen, … – Verständlichkeit: Farbe, Illustrationen, Tabellenform, Inhaltsverzeichnis, einfach und knapp, einheitliche Terminologie, Erklärung von Fachbegriffen, Informationen müssen sich eindeutig auf den speziellen Maschinentyp beziehen, … SS 2011, R. Schmidt 35

Produktspezifische Normen

• • Zu vielen Produkten, insbesondere für sicherheitsrelevante Produkte, gibt es spezielle Normen - Recherchieren!

Vorgaben zu Inhalt, Warnhinweisen, … SS 2011, R. Schmidt 36

ANSI Z535

• • • ANSI: American National Standards Institute Vorgaben für die Erstellung von Sicherheitshinweisen und warning labels.

Norm hat besondere Relevanz in USA, aber auch weltweit Warning label nach ANSI-Standard SS 2011, R. Schmidt 37

Richtlinien

SS 2011, R. Schmidt 38

Richtlinien

• • • • • Leitfaden Betriebsanleitungen (SAQ/TECOM/tekom 2001) - Aufbau, Inhalt, Ausführung und Gestaltung von Betriebsanleitungen VDI-Richtlinie 4500 - u. a. Dokumentenmanagement, elektronischer Ersatzteilkatalog DIN Fachbericht 146 - für Betriebsanleitungen von Anlagen …

Richtlinie zur Erstellung von Sicherheitshinweisen in

Betriebsanleitungen (tekom 2005) SS 2011, R. Schmidt 39

Richtlinie zur Erstellung von Sicherheitshinweisen in Betriebsanleitungen

• Entstehungsbedingungen: – Keine einheitlichen Vorgaben für Sicherheitshinweise für Europa – Keine europäische Norm, die ausführlich und ausreichend wäre – Vielzahl von Quellen mit ungenauen oder zu allgemeinen Anforderungen  Richtlinie der Tekom SS 2011, R. Schmidt 40

Erarbeiten von Sicherheits- und Warnhinweisen

Konstruk tion • Konstruktion: Alle Mittel ausschöpfen, um das Produkt so sicher wie möglich zu entwerfen, zu konstruieren und zu produzieren.

• Ggf. trennende Schutzeinrichtungen vorsehen.

Gefahren analysen • Gefahrenanalysen durch den Hersteller (iterativ), parallel zum Entstehungsgang des Produkts Doku • Ggf. den Benutzern Gefahren durch Sicherheits- und Warnhinweise deutlich machen SS 2011, R. Schmidt 41

Grundlegende Sicherheitshinweise

• • • Eigenes Kapitel vorn in der Bedienungsanleitung Inhalt: u. a.

– Anforderungen an das Bedienpersonal – Darstellung und Beschreibung der verwendeten Warnzeichen und Gefahrensymbole – Vorgaben zur Erhaltung des sicheren Zustands (regelmäßige Wartung, keine eigenmächtigen Umbauten, ...) – Bestimmungsgemäßer Gebrauch, unzulässige Verwendungen Verweise auf das Sicherheitskapitel dürfen nicht zur Einsparung von Warnhinweisen führen!

(Quellen: ISO Guide 37 und BS 4884) SS 2011, R. Schmidt 42

Handlungsbezogene Warnhinweise

• • • Warnen vor Gefahren, die in einer bestimmten Situation oder im Zusammenhang mit einem bestimmten Verhalten auftreten können.

Stehen in der Bedienungsanleitung direkt vor den gefährlichen Handlungen.

Heben sich typographisch und durch Warnzeichen deutlich hervor.

SS 2011, R. Schmidt 43

Handlungsbezogene Warnhinweise

Grad der drohenden Gefahr

(Signalwort)

Art und Quelle der Gefahr Mögliche Folgen der Gefahr

GEFAHR Quetschgefahr durch automatisch anlaufende Förderschnecke

Der Betrieb der Silobehälter 1 und 2, der Förderschnecke und des Förderbandes sind über eine Steuerung verbunden.

 Silo 1, Silo 2 und Förderung vor Reinigungsarbeiten ausschalten und gegen Einschalten sichern.

Maßnahmen zur Gefahrenvermeidung Warnzeichen

SS 2011, R. Schmidt 44

Rechtlicher und normativer Hintergrund

GPSG § 5 (1): „Der Hersteller (…) [hat] (…) sicherzustellen, dass der Verwender die erforderlichen Informationen erhält, damit dieser die Gefahren, (…), beurteilen

Grad der drohenden Gefahr

(Signalwort) ISO 3864

Warnzeichen

ISO 7010

Art und Quelle der Gefahr

ANSI Z535

Mögliche Folgen der Gefahr

ANSI Z535 … und sich dagegen schützen kann.“

Maßnahmen zur Gefahren vermeidung

ANSI Z535 SS 2011, R. Schmidt 45

Signalwörter

(nach ISO 3864)

GEFAHR

• Schwerer Personenschaden • Droht unmittelbar

WARNUNG

• Schwerer Personenschaden • Droht möglicherweise

VORSICHT

• Leichter oder mittlerer Personenschaden oder Sachschaden SS 2011, R. Schmidt 46

Warnzeichen nach ISO 7010

(Beispiele) Heiße Oberfläche Gefährliche elektrische Spannung SS 2011, R. Schmidt 47

Optische Gestaltung der Warnhinweise

• • • • • Heben sich klar vom übrigen Text ab Einheitliche Darstellung „Maßnahmen zur Abwendung der Gefahr“ heben sich klar vom übrigen Warntext ab Genormtes Warnzeichen Farbige Gestaltung nicht unbedingt erforderlich; bei farbiger Gestaltung normgerechte Farben bei Warnzeichen einsetzen SS 2011, R. Schmidt 48

Formulierung von Warntexten

• Imperativischer Infinitiv oder Imperativ Beispiel: – Nicht: Die Maschine muss zum Reinigen oder Warten ausgeschaltet werden.

Sondern: Zum Reinigen oder Warten Maschine ausschalten.

(Imperativischer Infinitiv)

Oder: Schalten Sie zum Reinigen oder Warten die Maschine aus.

(Imperativ)

SS 2011, R. Schmidt 49

Formulierung von Warntexten

• • • • • Reihenfolge der Maßnahmen = zeitliche Abfolge Aktiv Kurz und prägnant Einfach zu verstehen Eindeutig SS 2011, R. Schmidt 50

SS 2011, R. Schmidt 51

Beispiel 1

An Pin 2 des Steckers X4 liegt eine sehr hohe Spannung an. Die Spannung darf nur mit Hochspannungstastkopf gemessen werden!

Beispiel 1

An Pin 2 des Steckers X4 liegt eine sehr hohe Spannung an. Die Spannung darf nur mit Hochspannungstastkopf gemessen werden!

GEFAHR Spannungsüberschlag

Durch Spannungsüberschlag schwere Verletzungen am ganzen Körper!

 Hochspannung nur mit Hochspannungs tastkopf messen.

SS 2011, R. Schmidt 53

Beispiel 2

! Bei geändertem Netzspannungsanschluss muss das Klebe schild mit der Spannungsangabe auf der Geräterückseite ersetzt werden.

SS 2011, R. Schmidt 54

Beispiel 2

! Bei geändertem Netzspannungsanschluss muss das Klebe schild mit der Spannungsangabe auf der Geräterückseite ersetzt werden.

VORSICHT Zerstörungsgefahr

Zu hohe Netzspannung kann das Gerät beschädigen.

 Klebeschild mit der korrekten Netzspannungs angabe an der Geräterückseite anbringen.

SS 2011, R. Schmidt 55

Übung

Kommentieren und optimieren Sie folgende Sicherheitshinweise: Öffnen Sie den Deckel des Kühlers vorsichtig! Heißer Dampf!

Rotierende Walzen. Die Wartungstür darf nicht geöffnet werden, bevor die Walzen stillstehen.

SS 2011, R. Schmidt 56

Kritisieren Sie den Sicherheitshinweis:

Übung

WARNING

THE BLADE CONTINUES TO ROTATE AFTER THE MACHINE IS SWITCHED OFF.

CAREFULLY READ THE INSTRUCTION BOOK AND THE SAFETY PECAUTIONS.

SWITCH OFF AND REMOVE PLUG FROM MAIN SUPPLY BEFORE ADJUSTING.

CLEANING IF CORD IS CUT OR ENTANGLED.

KEEP HANDS AND FEET AWAY FROM THE BLADE.

5146447 SS 2011, R. Schmidt 61

Typografie

SS 2011, R. Schmidt 63

Typografie: Was ist das?

Gestaltungsprozess, der mittels Schrift, Bildern, Linien, Flächen und typografischem Raum auf Druckwerke und elektronische Medien angewendet wird.

http://de.wikipedia.org/wiki/Typographie SS 2011, R. Schmidt 64

Typografie

• • • • •

Grundlayout

Format Satzspiegel Kolumnentitel Spalten Marginalien

Verwendung richtiger Zeichen Webtypografie

• • • •

Formatierung

Schrift Zeilenabstände Seitenumbruch Zeilenausrichtung SS 2011, R. Schmidt 65

Format

Typische Seitenformate

DIN-A-Serie (21,0 x 29,7 cm) in metrisch orientierten Gesellschaften (auch: Kanada) – Letter (21, 59 x 27,94 cm) in nichtmetrisch orientierten Gesellschaften (z.B. USA) DIN A4 Letter SS 2011, R. Schmidt 66

Satzspiegel Marginalien spalte

Satzspiegel

Kolumnentitel; lebender KT zählt zum Satzspiegel, toter KT nicht Marginalien SS 2011, R. Schmidt Kolumnentitel 67

Satzspiegel Innensteg Bundsteg

Stege

Kopfsteg Außensteg Seitensteg Fußsteg SS 2011, R. Schmidt 68

Gestaltungsregeln für Titelseite und Satzspiegel

Goldener Schnitt

– Gestaltungsregel für optisch attraktive Seitenverhältnisse – Länge der größeren Seite verhält sich zur Länge der kleineren Seite wie beide summierten Längen zur größeren Seite – Praktikabler: 2 / 3 •

Fibonacci-Zahlenreihe

verwenden, wenn goldener Schnitt nicht geht.

SS 2011, R. Schmidt 69

Übung Goldener Schnitt

• • Schauen Sie sich eine Minute Ihre(n) Nebensitzer(in) an.

Wo entdecken Sie überall den goldenen Schnitt (Verhältnis 2/3)?

SS 2011, R. Schmidt 70

Lösung: vitruvianischer Mensch

SS 2011, R. Schmidt 71

Fibonacci Zahlenreihe

• • 0, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55, 89, 144, 233, 377, 610, … Die jeweils nächste Zahl in dieser Folge erhält man als Summe der beiden vorangehenden. Das Verhältnis zweier aufeinanderfolgender Zahlen der Fibonacci-Folge strebt gegen den Goldenen Schnitt.

SS 2011, R. Schmidt 72

Gestaltungsregel Weißraum

• • • Seiten nicht überfüllen. Ca. 1/3 der Seite als Weißraum Maximal 45 bis 65 Zeichen pro Zeile Neue Kapitel immer auf einer rechten (also ungeraden) Seite beginnen lassen.

SS 2011, R. Schmidt 73

Kolumnentitel

• – Kopf- und Fußzeilen werden Kolumnentitel genannt.

Tot (ändert sich nicht, z.B. Copyright) – Lebend (ändert sich, z.B. referenzierte Überschriften).

• – Vorteile: Orientierung im Dokument durch Seitenzahlen und Kapitelreferenzen – Identifikation auch bei Einzelseiten durch Version, Dokumentnummer, Bearbeitungsstatus SS 2011, R. Schmidt 74

35 % 25 %

Regel zur Inhaltsverteilung in Kolumnentiteln

• 25 % 15 % • Aufmerksamkeits verteilung im westlichen Kulturkreis Den wichtigsten Inhalt möglichst links/außen oben platzieren, den am wenigsten wichtigen Inhalt rechts/innen unten.

Auch relevant bei der Text-Bild Verteilung: Wichtigeres Medium links/außen bzw. darüber, weniger wichtiges Medium rechts/innen bzw. darunter.

SS 2011, R. Schmidt 75

Spalten

• • Mensch nimmt ca. zehn bis zwölf Zeichen beim Lesen auf.

(ca. zwei bis drei Wörter) Optimal eine Zeilenlänge von 45 bis 65 Zeichen (ca. sechs bis zehn Wörter) SS 2011, R. Schmidt 76

Marginalien

• • Bieten Orientierung im Dokument – In Marginalienspalte z. B.

Zwischenüberschriften – Schlüsselworte – Piktogramme – Zusammenfassungen SS 2011, R. Schmidt 77

Konsistenz

• • Format, Satzspiegel, Kopf- und Fußzeilen, Anzahl der Spalten, Marginalienspalte außer in begründeten Einzelfällen auf allen Seiten

gleich.

Text/Bild-Verteilung auf allen Seiten gleich (Bilder konsistent rechts bzw. links oder unter bzw. über den dazugehörigen Text).

SS 2011, R. Schmidt 78

Blockbildung

• Sinnabschnitte / Zusammenhänge gruppieren – Dokumente (pro Zielgruppe/Thema ein eigenes Dokument – Abschnitte (bitte immer mehr Abstand vor einer gliedernden Überschrift als danach!) – Absätze (durch erhöhten Abstand oder leichtes Einrücken optisch erkennbar machen) – Sätze (durch Punkte und Kommata gruppieren) SS 2011, R. Schmidt 79

Seitenumbruch

• Seitenumbruch verteilt Elemente wie z.B. Text und Bild auf verschiedenen Seiten • Seitenumbruch ist ein wirksames Mittel zur Blockbildung, aber auch zur Zerstörung (siehe nächste Folie) SS 2011, R. Schmidt 80

Seitenumbruch

Schusterjunge: Erste Zeile eines neuen Absatzes steht auf der vorigen Seite.

Hurenkind: Letzte Zeile eines Absatzes steht auf der nächsten Seite.

Seitenumbruch als allerletztes optimieren [Strg + Return], dann Verzeichnisse aktualisieren SS 2011, R. Schmidt 81

Schrift

• Man unterscheidet – – Serifenschriften ( Georgia,…) Times New Roman, Courier New, Serifenlose Schriften ( Arial, Verdana, Tahoma ,… ).

• Empfohlene Anwendungen – – Für den Druck optimiert: z.B. Bookman , Palatino ,… Myriad ,… Times New Roman , Für die Displayansicht optimiert: z.B. Verdana , Georgia , SS 2011, R. Schmidt 82

Schrift

Schriftart

– – Maximal 2 Schriftarten pro Dokument.

Schriften immer einbetten. – „Kennt“ der Drucker die Schriftart? Werden alle Zeichen korrekt dargestellt?

– PDF-Dateien: Sind alle Schriften eingebettet (also mit der Datei mitgeliefert)?

– Müssen Lizenzrechte erworben werden?

– Unterschiedliche Schriftgrößen müssen sich deutlich voneinander abheben. SS 2011, R. Schmidt 83

Schrift

Schriftgröße

– 8 bis 12 Punkt Grundschrift für Erwachsene – Kopf- und Fußzeilen, Tabellen und Fußnoten können etwas kleiner sein als die Grundschrift, aber: – Bitte nichts kleiner als 8 Punkt (evtl. das Kleingedruckte…) •

Zeilenabstand

– 2 bis 4 Punkt für Grundschrift – 20 – 30 % der Schriftgröße allgemein anwendbar => Word „Zeilenabstand“ 1,2 – 1,3 SS 2011, R. Schmidt 84

Schrift

Schrift bei Überschriften

– Überschriften müssen als solche deutlich erkennbar sein: Fettschrift, (regelmäßig) gestuft größere Schriftgröße,… – Überschriftenebenen durch unterschiedliche Schriftgrößen deutlich unterscheiden.

– Maximal 3 Überschriftsebenen SS 2011, R. Schmidt 85

Typografische Auszeichnungen von Schrift

Auszeichnung Besonderheit / Empfohlene Anwendungsfälle

Kursiv

Fett

Unterstreichung VERSALIEN K APITÄLCHEN Sperren Schriftmischung Fällt erst auf, wenn man an die entsprechende Stelle kommt, deshalb i.a. für Auszeichnungen im Text am besten geeignet.

Sehr aufdringlich; zieht direkt die Aufmerksamkeit auf sich. Für Überschriften, Beschriftungen, Teile von Aufzeichnungen, Verzeichnissen und Tabellenköpfen geeignet.

Vermeiden! Überbleibsel aus dem Schreibmaschinenzeitalter.

= Großbuchstaben. Text wird schlecht lesbar. Wenn überhaupt, dann nur bei kurzen Wörtern und selten verwenden. Dann u.U. leicht sperren, evtl. auch verkleinern.

Nur verwenden, wenn man genau weiß, was man tut. Leicht sperren.

= Vergrößern der Abstände zwischen Buchstaben eines Wortes. Ist etwas für „Typographie-Meister“.

Schriftmischung ist etwas für Experten!

SS 2011, R. Schmidt 86

Sparsam mit

typografischen Auszeichnungen

(z. B. Fett, Kursiv, Schriftfarbe

,

Schriftart,

Schriftgröße

) umgehen. Sonst verlieren sie ihre

Wirkung und das Schriftbild wirkt unruhig.

SS 2011, R. Schmidt 87

Konsistenz

Gleiche typografische Auszeichnungen für gleiche Informationen.

Beispiel: 1. Drücken Sie die Taste Ein.

2. Drücken Sie die Taste Start.

3. Ziehen Sie den Heben nach vorne.

SS 2011, R. Schmidt 88

Zeilenausrichtung

• Linksbündigen Flattersatz mindestens bei Überschriften, Beschriftungen und Handlungsschritten Bei Blocksatz und auch Flattersatz: Silbentrennung aktivieren!

SS 2011, R. Schmidt 89

Guter Flattersatz Schlechter Flattersatz SS 2011, R. Schmidt typokurz von Christoph Bier http://www.zvisionwelt.de

90

Guter Blocksatz Schlechter Blocksatz SS 2011, R. Schmidt typokurz von Christoph Bier http://www.zvisionwelt.de

91

Zeichen

Geschützter Trennstrich Bedingter Trennstrich Gedankenstrich Apostroph

Striche

Beispiel

iPunkt, XRay Donau¬dampf¬ schiff — Wie geht’s?

ASCI-Code

Alt0173 Alt0172 Alt0150 Alt0146

Word

Strg+Umschalt+_ Strg+ Alt+Strg+Num SS 2011, R. Schmidt 92

Leerzeichen, Ziffern und Zahlen

Zeichen

Geschütztes Leerzeichen

Beispiel

MS Word Schmales Leerzeichen z. B.

Bis zu vier Ziffern Ab 5 Ziffern Telefonnummer Telefonnummer mit Vorwahl Postleitzahlen

Umsetzung

Alt0160 1400 1 000 000 123 45 +49 / 030 / 1 23 45 (+49) (030) 1 23 45 76227 Kleinere Schriftgröße beim Leerzeichen Kein Leerzeichen Gruppierung von hinten in Dreiergruppen Gruppierung von hinten in Zweiergruppern Trennung der Vorwahl durch Leerzeichen Keine Leerzeichen SS 2011, R. Schmidt 93

Webtypografie

• • • • • Textabschnitte kurz fassen Zeilenabstand zwischen 120 und 150 Prozent der Schrifthöhe Artikel sinnvoll verlinken Serifenlose Schriften für Fließtext sind üblich, z. B. Schriftart „Verdana“ Grauabstufungen und weiche Farbtöne statt reinem schwarz oder weiß verwenden SS 2011, R. Schmidt 94

Standardisierungsmethoden

SS 2011, R. Schmidt 95

Standardisierung: Beispiele &Vorteile

?

SS 2011, R. Schmidt 96

Standardisierungsmethoden für Dokumente

Methode

Funktionsdesign Information Mapping Klassenkonzept-Technik Zielprogrammierung Kontrolliertes Deutsch (bzw. weitere Kontr. Sprachen)

Entwickler

Prof. Jürgen Muthig und Prof. Robert Schäflein-Armbruster Robert E. Horn Prof. Sissi Closs Dietrich Juhl Anne Lehrndorfer SS 2011, R. Schmidt 97

Sprechakttheorie

SS 2011, R. Schmidt 98

Sender und Empfänger

Beim Sprechen werden außer dem gesprochenen Wort auch noch andere wichtige Zusatzinformationen übermittelt, die zum richtigen und eindeutigen Verstehen der Botschaft unerlässlich sind, z.B.: – Gestik, Mimik (visuell) – Lautstärke, Stimmfarbe, (Unter-)Ton (akustisch) – Situation, Umfeld http://clipproject.info/ SS 2011, R. Schmidt 99

http://clipproject.info/

„Die Tür ist offen!“

SS 2011, R. Schmidt 100

„Die Tür ist offen!“

SS 2011, R. Schmidt 101

„Die Tür ist offen!“

SS 2011, R. Schmidt 102

„Die Tür ist offen!“

Tatsache

Feststellung durch den Sender ohne weitere Intention.

Kritik

Die Tür wurde durch den zuletzt Eintretenden offen gelassen!

Aufforderung

Schließen Sie bitte die Tür!

Rauswurf

„Die Tür ist offen! Machen Sie sie bitte von außen zu.“

Einladung

„Meine Tür steht Ihnen offen. Kommen Sie herein!“ SS 2011, R. Schmidt 103

Sprechakttheorie

• • Aus Sicht des Senders: – These: Mit unseren Äußerungen vollziehen wir Handlungen.

– Nicht einzelne Wörter oder Sätze sind die Grundbestandteile der menschlichen Kommunikation, sondern Sprechakte.

Sprechen ist auch Handeln.

Aus Sicht des Empfänger: Es gibt keine absoluten Aussagen, sondern nur Interpretationen.

SS 2011, R. Schmidt 104

Sender und Empfänger

• • Beim Schreiben fehlen wichtige Zusatzinformationen wie Gestik, Mimik und Tonfall. Deshalb muss auf eine eindeutige Darstellung geachtet werden.

Fazit: Ein Satz kann verschiedene Bedeutungen haben. Deshalb ist gerade in der Technischen Dokumentation eine eindeutige Darstellung wichtig.

SS 2011, R. Schmidt 105

Funktionsdesign

SS 2011, R. Schmidt 106

• • • •

Funktionsdesign – theoretischer Hintergrund

Sprechakttheorie: Nicht nur Inhalte werden übermittelt, auch deren kommunikative Funktion (Feststellung, Aufforderung, Bitte, Empfehlung, Warnung, …) Beispiel: „Die Tür ist offen.“- Feststellung, Aufforderung hereinzukommen oder auch herauszugehen, Bitte die Tür zu schließen, …) Klarheit über die Funktion des Inhalts im Mündlichen durch – Gestik, Mimik, Tonfall – Situation, Umfeld Klarheit im Schriftlichen durch – Charakteristische Formulierungsmuster – Typographische Auszeichnungen SS 2011, R. Schmidt 107

Funktionsdesign - Forderung

• • Textelemente mit gleicher kommunikativer Funktion (=Funktionale Einheiten) optisch gleich darstellen, charakteristisch und konsistent formulieren.

SS 2011, R. Schmidt 108

Funktionsdesign-Entwicklung (kurz)

1. Funktionale Analyse: Für jede Dokumentart die für den kommunikativen Zweck erforderlichen Elemente bestimmen.

2. Funktionales Design: Für jedes Element festhalten, welche Regeln der Autor bei deren Verwendung einhalten muss.

SS 2011, R. Schmidt 109

1.

Beispiel: Schmutzwasserpumpe

• Ausgangspunkt: Unstrukturierter Fließtext 2.

• Funktionale Analyse 3.

• Funktionales Design SS 2011, R. Schmidt 110

Unstrukturierter Fließtext

Schalter A auf Position 1 zu stellen. Die grüne Kontrolllampe leuchtet auf. Dabei sollten Sie darauf achten, dass sich keine Flüssigkeit im Behälter befindet. Damit ist die Pumpe betriebsbereit. Sie können mit dem Absaugen beginnen. ist SS 2011, R. Schmidt 111

Funktionale Analyse

• Schalter A ist auf Position 1 zu stellen.

• Die grüne Kontrolllampe leuchtet auf.

• Dabei sollten Sie darauf achten, dass sich keine Flüssigkeit im Behälter befindet.

• Damit ist die Pumpe betriebsbereit • Sie können mit dem Absaugen beginnen.

SS 2011, R. Schmidt 112

Funktionale Analyse

Handlungsaufforderung • Schalter A ist auf Position 1 zu stellen.

• Die grüne Kontrolllampe leuchtet auf.

• Dabei sollten Sie darauf achten, dass sich keine Flüssigkeit im Behälter befindet.

• Damit ist die Pumpe betriebsbereit • Sie können mit dem Absaugen beginnen.

SS 2011, R. Schmidt 113

Funktionale Analyse

Handlungsaufforderung • Schalter A ist auf Position 1 zu stellen.

Resultat/ Erfolgskontrolle • Die grüne Kontrolllampe leuchtet auf.

• Dabei sollten Sie darauf achten, dass sich keine Flüssigkeit im Behälter befindet.

• Damit ist die Pumpe betriebsbereit • Sie können mit dem Absaugen beginnen.

SS 2011, R. Schmidt 114

Funktionale Analyse

Handlungsaufforderung • Schalter A ist auf Position 1 zu stellen.

Resultat/ Erfolgskontrolle • Die grüne Kontrolllampe leuchtet auf.

Voraussetzung/ Warnung • Dabei sollten Sie darauf achten, dass sich keine Flüssigkeit im Behälter befindet.

• Damit ist die Pumpe betriebsbereit • Sie können mit dem Absaugen beginnen.

SS 2011, R. Schmidt 115

Funktionale Analyse

Handlungsaufforderung • Schalter A ist auf Position 1 zu stellen.

Resultat/ Erfolgskontrolle • Die grüne Kontrolllampe leuchtet auf.

Voraussetzung/ Warnung • Dabei sollten Sie darauf achten, dass sich keine Flüssigkeit im Behälter befindet.

Resultat (relevante Folge) • Damit ist die Pumpe betriebsbereit • Sie können mit dem Absaugen beginnen.

SS 2011, R. Schmidt 116

Funktionale Analyse

Handlungsaufforderung • Schalter A ist auf Position 1 zu stellen.

Resultat/ Erfolgskontrolle • Die grüne Kontrolllampe leuchtet auf.

Voraussetzung/ Warnung • Dabei sollten Sie darauf achten, dass sich keine Flüssigkeit im Behälter befindet.

Resultat • Damit ist die Pumpe betriebsbereit Handlungsaufforderung/ Resultat / Erlaubnis • Sie können mit dem Absaugen beginnen.

SS 2011, R. Schmidt 117

Funktionales Design

Absaugen des Schmutzwassers

Voraussetzung: Stellen Sie sicher, dass sich keine Flüssigkeit im Behälter befindet.

1.

Stellen Sie Schalter A auf Position 1.

Grüne Kontrolllampe leuchtet. Daran erkennen Sie, dass die Pumpe betriebsbereit ist. 2.

Beginnen Sie mit dem Absaugen.

SS 2011, R. Schmidt 118

Funktionales Design

Themenangabe: fehlte im Original!

Voraussetzung: Explizite Kennzeichnung Voraussetzung: Verbesserung des Formulierungs musters Handlungs aufforderung Verb-Erststellung und Sie-Anrede Absaugen des Schmutzwassers

Voraussetzung: Stellen Sie sicher, dass sich keine Flüssigkeit im Behälter befindet.

1.

2.

Stellen Sie Schalter A auf Position 1.

Grüne Kontrolllampe leuchtet. Daran erkennen Sie, dass die Pumpe betriebsbereit ist. Beginnen Sie mit dem Absaugen.

Resultat: ohne Artikel: kurz; explizite Kohärenz beziehung Handlungsaufforderung Verb-Erststellung und Sie-Anrede

SS 2011, R. Schmidt 119

Festlegungskategorien für Funktionale Einheiten

1.

2.

3.

4.

5.

6.

Verwendung Inhalt Sequenzierung Formulierungmuster Optische Gestaltung Explizite Kennzeichnung

Mit diesen Festlegungen sichern Sie die Konsistenz UND in diesen Festlegungen definieren Sie die Qualität.

Für jede einzelne Funktionale Einheit müssen bzw. können Festlegungen getroffen werden, die man den oben genannnten Kategorien zuordnen kann.

SS 2011, R. Schmidt 120

Festlegungskategorien

Verwendung Inhalt Sequenzierung Formulierung Optische Gestaltung Explizite Kennzeichnung

Beispiel

Festlegungen für Funktionale Einheit „Aufforderung“

SS 2011, R. Schmidt 121

Festlegungskategorien Verwendung Inhalt Sequenzierung Formulierung Optische Gestaltung Explizite Kennzeichnung

Beispiel

Festlegungen für Funktionale Einheit „Aufforderung“

Immer, wenn der Anwender etwas tun muss.

SS 2011, R. Schmidt 122

Festlegungskategorien Verwendung Inhalt Sequenzierung Formulierung Optische Gestaltung Explizite Kennzeichnung

Beispiel

Festlegungen für Funktionale Einheit „Aufforderung“

Immer, wenn der Anwender etwas tun muss.

Mindestens: handlungsrelevanter Gegenstand und Handlungsverb.

SS 2011, R. Schmidt 123

Festlegungskategorien Verwendung Inhalt Sequenzierung Formulierung Optische Gestaltung Explizite Kennzeichnung

Beispiel

Festlegungen für Funktionale Einheit „Aufforderung“

Immer, wenn der Anwender etwas tun muss.

Mindestens: handlungsrelevanter Gegenstand und Handlungsverb.

Vorgänger: Resultat, Warnung, Abbildung.

Nachfolger: Resultat, Bild, Aufforderung SS 2011, R. Schmidt 124

Festlegungskategorien Verwendung Inhalt Sequenzierung Formulierung Optische Gestaltung Explizite Kennzeichnung

Beispiel

Festlegungen für Funktionale Einheit „Aufforderung“

Immer, wenn der Anwender etwas tun muss.

Mindestens: handlungsrelevanter Gegenstand und Handlungsverb.

Vorgänger: Resultat, Warnung, Abbildung.

Nachfolger: Resultat, Bild, Aufforderung Immer Verb-Erststellung und Sie-Anrede.

SS 2011, R. Schmidt 125

Festlegungskategorien Verwendung Inhalt Sequenzierung Formulierung Optische Gestaltung Explizite Kennzeichnung

Beispiel

Festlegungen für Funktionale Einheit „Aufforderung“

Immer, wenn der Anwender etwas tun muss.

Mindestens: handlungsrelevanter Gegenstand und Handlungsverb.

Vorgänger: Resultat, Warnung, Abbildung.

Nachfolger: Resultat, Bild, Aufforderung Immer Verb-Erststellung und Sie-Anrede.

FV: HA; nummeriert, fett, Abstand oben 6 pt, Abstand unten 2 Pt SS 2011, R. Schmidt 126

Festlegungskategorien Verwendung Inhalt Sequenzierung Formulierung Optische Gestaltung Explizite Kennzeichnung

Beispiel

Festlegungen für Funktionale Einheit „Aufforderung“

Immer, wenn der Anwender etwas tun muss.

Mindestens: handlungsrelevanter Gegenstand und Handlungsverb.

Vorgänger: Resultat, Warnung, Abbildung.

Nachfolger: Resultat, Bild, Aufforderung Immer Verb-Erststellung und Sie-Anrede.

FV: HA; nummeriert, fett, Abstand oben 6 pt, Abstand unten 2 Pt Keine.

SS 2011, R. Schmidt 127

Übung 1

• Kritisieren und optimieren Sie folgende Formulierung aus einer Montageanleitung für ein Bücherregal.

Nachdem die Seitenteile in den Sockel geschoben und die Rückwand von oben eingezogen wurde, ziehen Sie die sechs Schrauben an jedem Seitenteil an.

SS 2011, R. Schmidt 128

Lösungsvorschlag

Nachdem die Seitenteile in den Sockel geschoben und die Rückwand von oben eingezogen wurde, ziehen Sie die sechs Schrauben an jedem Seitenteil an.

Zur Montage gehen Sie wie folgt vor: 1. Seitenteile in den Sockel schieben.

2. Rückwand von oben einziehen.

3. Die 6 Schrauben an jedem Seitenteil anziehen.

SS 2011, R. Schmidt 129

Übung 2

• Optimieren Sie folgenden Text.

Um Ihr Passwort zu ändern, gelangen Sie nach erfolgreicher Anmeldung über Klicken Ihres Namens auf der Menüleiste in den Kennwort ändern Dialog. Nach Eingabe eines neuen Kennworts und Auswahl von Speichern ist ihr Passwort geändert.

SS 2011, R. Schmidt 130

Lösungsvorschlag

Passwort ändern

Voraussetzung:  Sie sind angemeldet.

1.

Klicken Sie in der Menüleiste auf Ihren Benutzernamen.

Der Dialog Kennwort ändern erscheint. 2.

Geben Sie das alte und neue Passwort ein.

3.

Klicken Sie auf Speichern.

Ihr Passwort ist geändert. SS 2011, R. Schmidt 131

Lösungsvorschlag

mit imperativischem Infinitiv statt Imperativ

Passwort ändern

Voraussetzung:  Sie sind angemeldet.

1.

In der Menüleiste auf den Benutzernamen klicken.

Der Dialog Kennwort ändern erscheint. 2.

Altes und neues Passwort eingeben.

3.

Auf Speichern klicken.

Ihr Passwort ist geändert. SS 2011, R. Schmidt 132

Übung 3

• Optimieren Sie folgenden Text.

Um einen neuen Benutzer anzulegen klicken Sie mit der rechten Maustaste in das Hauptfenster und wählen Sie

Neuen Benutzer hinzufügen

. Ein Icon erscheint und der Benutzer kann durch Doppelklick auf das Element eingegeben werden. Bevor Sie die neue Funktion speichern können, müssen Sie Ihre Eingabe mit der Enter Taste bestätigen.

SS 2011, R. Schmidt 133

Lösungsvorschlag

Neuen Benutzer anlegen

1.

Klicken Sie mit der rechten Maustaste in das Hauptfenster.

Ein Kontextmenü erscheint.

2.

3.

Wählen Sie Neuen Benutzer hinzufügen. Ein Icon erscheint.

Doppelklicken Sie auf das Icon.

Ein Eingabefeld erscheint.

3.

4.

5.

Geben Sie den Benutzer ein. Bestätigen Sie Ihre Eingabe mit der Enter-Taste. Klicken Sie auf Speichern.

SS 2011, R. Schmidt 134

Funktionsdesign-Entwicklung

1 2 3 4 5 6 7 • Prozess analysieren • Dokumente analysieren • Dokumentarten klassifizieren • Funktionale Einheiten definieren • Festlegungen im Leitfaden definieren • Toolumgebung einrichten • Musterdokumente erstellen SS 2011, R. Schmidt 135

Umsetzung in MS Word

Formatvorlagen Autotexte Dokument vorlagen SS 2011, R. Schmidt 136

Umsetzung in MS Word

Formatvorlagen Autotexte Dokument vorlagen Unterstützt konsistente optische Gestaltung SS 2011, R. Schmidt 137

Umsetzung in MS Word

Formatvorlagen Autotexte Dokument vorlagen Unterstützt konsistente optische Gestaltung Komplexe bzw. mehrere FEs können komfortabel eingefügt werden. Unterstützt bei richtiger optischer Gestaltung, Formulierung und Sequenzierung.

SS 2011, R. Schmidt 138

Umsetzung in MS Word

Formatvorlagen Unterstützt konsistente optische Gestaltung Autotexte Komplexe bzw. mehrere FEs können komfortabel eingefügt werden. Unterstützt bei richtiger optischer Gestaltung, Formulierung und Sequenzierung.

Dokument vorlagen Autoren können an unterschiedlichen Kapiteln einer Doku gleichzeitig arbeiten bei identischer Arbeitsumgebung.

SS 2011, R. Schmidt 139

Design-Grundsätze

Layout follows function Verzicht auf layoutorientierten Ansatz Beschränkte Anzahl optischer Gestaltungselemente Nicht jede Funktionale Einheit muss sich zwingend von anderen Funktionalen Einheiten abheben.

Kommunikativen Zweck verdeutlichen SS 2011, R. Schmidt 140

Vorteile durch Funktionsdesign

Leser • ?

Autor • ?

Unternehmen • ?

SS 2011, R. Schmidt 141

Vorteile durch Funktionsdesign

Leser • Text ist besser verständlich.

Autor • „Gerüst“ für Inhalt schon vorhanden.

• Grad der Festlegungen ist flexibel.

• Tool- und Medien-Unabhängigkeit.

• Bessere Eignung der Mehrfachverwendbarkeit.

• Selektiver Zugriff auf Inhalte gleicher kommunikativer Funktion möglich.

• Konvertierung der Dokumente nach XML leicht möglich.

Unternehmen • Zeit- und damit Kostenersparnis bei höherer Qualität SS 2011, R. Schmidt 142

Wichtige Hinweise zur Entwicklung eines Funktionsdesigns

Beteiligte einbinden • Workshops mit erfahrenen FD-Entwicklern durchführen.

• Gute Kommunikation ist elementar. Unbedingt viele Autoren in die Entwicklung des Konzeptes einbinden. Ein oktroyierter Standard hat kein langes Leben.

• Es muss ein klares Bekenntnis für diesen Weg geben bis in die Entscheider- und Führungsebene hinein. Keine echte Lösung für die Migration von Altdaten • … sofern diese nicht verwendbar strukturiert sind.

SS 2011, R. Schmidt 143

Übung 4

• • Öffnen Sie „Funktionale Analyse Register.docx“ ( \\ads\dfs\mmt\public\Lehrbeauftragte\Schmidt ).

Aufgabenstellung im Dokument.

SS 2011, R. Schmidt 144

Lösungsvorschlag

(nicht aus Layout-Sicht!) SS 2011, R. Schmidt 145

Übung 5

• Öffnen Sie „ Funktionale Analyse Word.docx“ (siehe \\ads\dfs\mmt\public\Lehrbeauftragte\Schmidt ) • Erstellen Sie sprechakt-theoretisch benannte Formatvorlagen und weisen Sie diese zu. ACHTUNG : Keine Absatz- oder Zeicheneigenschaften einstellen! Formatvorlagen nur benennen und zuweisen!

SS 2011, R. Schmidt 146

Bildbearbeitung

SS 2011, R. Schmidt 147

Bildbearbeitung – wofür?

SS 2011, R. Schmidt 148

Bildbearbeitung – wofür?

• • • • • • • Nachbearbeitung von Fotos Fotomontagen Gestaltung (Werbebilder) Anpassungen an Verwendung (Print vs. Online) Hervorhebung von Details Anbringung von Positionsnummern … SS 2011, R. Schmidt 149

Auflösung

• Anzahl der Pixel, die bei der Ausgabe pro Längeneinheit angezeigt wird.

Beispiel: 5 dpi (Dots per Inch) SS 2011, R. Schmidt http://www.ge-crew.de

150

Empfohlene Auflösung

• • Print: – Laserdruck: 150 oder 300 dpi – Profidruck: mind. 300 dpi Online: Guter Kompromiss zwischen Qualität und Dateigröße (z.B. 96 dpi) SS 2011, R. Schmidt 151

Bildkategorien

Pixelgrafik • Jedes Objekt wird in Pixel aufgelöst. Bildinformatio nen sind Punkt für Punkt gespeichert.

• Tool: z.B. Adobe Photoshop Vektorgrafik • Speichert Konturen und Flächen als mathemati sche Beschreibung von Kurven.

• Tools: z.B. Adobe Illustrator, AutoCAD, ProE de.wikipedia.org

SS 2011, R. Schmidt de.wikipedia.org

152

Vorteile von Vektorgrafiken

• • Geringe Dateigröße Skalierung ohne Qualitätsverlust Pixelgrafik Vektorgrafik SS 2011, R. Schmidt de.wikipedia.org

153

Farbsysteme (Auswahl)

CMYK • Cyan • Magenta • Yellow • Black RGB • Rot • Grün • Blau HSB • Hue • Saturation • Brightness LAB • Lightness • a (Grün-Rot) • b (Blau-Gelb) SS 2011, R. Schmidt 154

Farbsystem CMYK vs. RGB

CMYK

• Cyan, Magenta, Yellow, Black • Das Farbmodell entspricht Papier. Dies ist weiß und wird durch Auftragen von Farbpunkten bunt.

• 0 % jeder Komponente ergibt weiß. Jeweils 100 % ergibt schwarz. Gleiche Farbanteile ergeben grau.

• Verwendung für Print.

RGB

• Rot, Grün, Blau • Das Farbmodell entspricht einer Bildröhre. Treffen keine Elektronen auf, bleibt der Bildschirm schwarz.

• 0 % jeder Komponente ergibt schwarz. Jeweils 100 % ergibt weiß. Gleiche Farbanteile ergeben grau.

• Verwendung für Online.

SS 2011, R. Schmidt http://www.webfarbentrainer.de

155

Farbsystem HSB

0° • Hue (Farbton) – Rot: 0°, Gelb: 60°, Grün: 120°, Cyan: 180°, Blau: 240°, Magenta: 300° • Saturation (Sättigung) – Volle Sättigung: 100 % – Keine Sättigung: O % • Brightness (Helligkeit) – Sehr gedämpft: 100 % – Sehr hell: O % 0 % 360° 240° 0 % 100 % 180° 100 % 60° 120° Verwendung zur Modifikation einer Farbe (manuell oder in Farbeinstelldialogen), HSB-Farbsystem für den Menschen am verständlichsten ist.

SS 2011, R. Schmidt 156 http://www.webfarbentrainer.de

Farbsystem LAB

• • • L*-Achse (=Neutralgrauachse): Luminanz/Helligkeit a*-Achse: Grün- oder Rotanteil b*-Achse: Blau- oder Gelbanteil Berücksichtigt die menschliche Farbwahrnehmung. Enthält alle wahrnehmbaren (und noch viel mehr) Farben und ist geräteunabhängig.

-a Verwendung z.B. zur verlustfreien Konvertierung zwischen Farbsystemen und Gerätearten. -b Weiß

L

+b Schwarz http://www.heise.de

+a SS 2011, R. Schmidt 157

Farbtiefe

• • Bestimmt wie viele Farben theoretisch angezeigt werden können. Ergibt sich aus der Anzahl der Bits, die pro Pixel zur Verfügung stehen. Beispiele: – Farbtiefe von 8 Bit = 2⁸ = 256 Farben (übliche Farbtiefe im Internet) – Farben („TrueColor“) SS 2011, R. Schmidt 158

24 Bit Farbtiefe SS 2011, R. Schmidt 159 http://www.eyesontutorials.com

8 Bit Farbtiefe SS 2011, R. Schmidt 160

8 Bit Farbtiefe mit Dither SS 2011, R. Schmidt 161

24 Bit Farbtiefe SS 2011, R. Schmidt 162

24 Bit Farbtiefe SS 2011, R. Schmidt 8 Bit Farbtiefe mit Dither 163

Häufige Pixelgrafikformate

Format GIF PNG -8 PNG-24 JPEG BMP TIFF PSD Max. Anzahl der Farben

256 256 16,8 Mio. Farben 16,8 Mio 16,8 Mio. 16,8 Mio.

Unterstützt Transparenz?

Binäre Transparenz Alpha-Channel Alpha-Channel

Kompri mierung

ja ja ja

Qualitäts verlust?

ja ja nein

Bemerkung

Geeignet für Grafiken mit wenig Farben (größere, einfarbigenFarbflächen und für Schrift). Animationen möglich. Geeignet für Grafiken mit wenig Farben (größere, einfarbige Farbflächen); Animationen möglich. Normalerweise etwas kleinere Dateien als PNG-24.

Geeignet für Fotos und Farbverläufe. Animationen möglich Nein Alpha-Channel optional Nein ja (Fast) nicht ja ja nein nein Komprimierung besonders geeignet für Fotos und Farbverläufe. Komprimierungsstärke gegen Verlustgrad stufenlos regelbar. Normalerweise etwas kleinere Dateien bei Fotos als PNG-24. Kann Metainformationen über das Bild enthalten (EXIF)

Große Dateien.

16,8 Mio. Alpha-Channel ja nein Containerformat, das verschiedene Grafikformate enthalten kann. Unterstützt optional CMYC. Geeignet für Druckvorstufe. Starke Komprimierung für 1-Bit-Farb-tiefe (z.B. Fax); optional auch wie JPEG oder GIF Originäres Adobe Photoshop Format. Speichert alle Bildinformationen und -daten (Ebenen, Kanäle, Vektoren, ...). Trotz guter Komprimierung große Dateien, da viele Informationen gespeichert werden.

SS 2011, R. Schmidt 164

Welches Grafikformat ist geeignet?

In diesem Beispiel hat JPG 60 KB, PNG 300 KB Raphaela Schmidt, SS 2011 http://2.bp.blogspot.com

165

Welches Grafikformat ist geeignet?

GIF oder PNG http://it-republik.de

Raphaela Schmidt, SS 2011 166

Welches Grafikformat ist geeignet?

JPG Jpg-Artefakte In diesem Beispiel haben PNG und JPG gleiche Dateigröße Raphaela Schmidt, SS 2011 167

Welches Grafikformat ist geeignet?

Raphaela Schmidt, SS 2011 168

Welches Grafikformat ist geeignet?

SS 2011, R. Schmidt 169

Welches Grafikformat ist geeignet?

Raphaela Schmidt, SS 2011 www.ipek.kit.edu

170

Welches Grafikformat ist geeignet?

Raphaela Schmidt, SS 2011 www.ipek.kit.edu

171

Positionszeichnung

Grundregeln:

 Positionsnummern im Uhrzeigersinn ansetzen.

 Details mit Lupe versehen und separat zeichnen.

Ist dieses Bild so optimal?

SS 2011, R. Schmidt 172

Weitere Grundregeln:

 Positionslinien parallel im 30 Grad Winkel.

 Positionslinien oben (bei „12 Uhr“) beginnen lassen.

 Kein emotionales Bilder bei rein sachlicher Wissensvermittlung als Hintergrund verwenden. SS 2011, R. Schmidt Beispiel für ein emotionales Bild 173

Adobe Photoshop Tutorial

SS 2011, R. Schmidt 174

SS 2011, R. Schmidt 175

Positionszeichnung erstellen

1 • Ellipse zeichnen, um ein Detail hervorzuheben • Positionslinien erstellen 2 • Positionsnummern hinzufügen 3 • Bildbereich freistellen 4 SS 2011, R. Schmidt 176

Übung: Positionszeichnung erstellen (1/4)

• Ellipse zeichnen – Neue Ebene erstellen – Farbe für Ellipse wählen – Ellipse mit Auswahlwerkzeug zeichnen – Menü Bearbeiten > Kontur füllen – Menü Auswahl > Auswahl aufheben (oder auf Hintergrundebene klicken) – Ellipse ggf. mit Verschieben-Werkzeug verschieben SS 2011, R. Schmidt 177

Übung: Positionszeichnung erstellen (2/4)

• Positionslinien erstellen – Arbeitsfläche erweitern: Menü Bild > Arbeitsfläche – Linie zeichnen, anschließend auf Hintergrundebene klicken oder anderes Werkzeug anwählen – Lineale einblenden (Menü Ansicht > Lineale) – Hilfslinie ziehen – Weitere Positionslinien ziehen – Ggf. nachträglich Linien bearbeiten: Rechtsklick auf Ebenenminiatur; Menü Fülloptionen > Kontur SS 2011, R. Schmidt 178

Übung: Positionszeichnung erstellen (3/4)

• Positionsnummern hinzufügen – Textwerkzeug wählen – In Optionenleiste Schriftgröße/-art/-farbe wählen – Auf Bild klicken und Text eingeben – – Ggf. mit Verschiebe-Werkzeug den Text verschieben Bearbeitung der Textebene beenden durch Klick auf die Hintergrundebene (oder Ebene, die keine Textebene ist) – Hilfslinie ziehen – Weitere Nummern eingeben, verschieben, dabei auf neue Ebenen achten.

SS 2011, R. Schmidt 179

Übung: Positionszeichnung erstellen (4/4)

• Bildbereich freistellen (mit dem Freistell Werkzeug) SS 2011, R. Schmidt 180

Weitere Möglichkeiten mit Photoshop – einige Beispiele –

Quelle: http://www.eyesontutorials.com

SS 2011, R. Schmidt

SS 2011, R. Schmidt 182

SS 2011, R. Schmidt 183

SS 2011, R. Schmidt 184

SS 2011, R. Schmidt 185

SS 2011, R. Schmidt 186

SS 2011, R. Schmidt 188

SS 2011, R. Schmidt 189

SS 2011, R. Schmidt 190

SS 2011, R. Schmidt 191

SS 2011, R. Schmidt 192

SS 2011, R. Schmidt 193

LITERATUREMPFEHLUNGEN

SS 2011, R. Schmidt 194

Literaturempfehlungen

• • • • • • • EU-Richtlinien: http://eur-lex.europa.eu

Gesetze: http://bundesrecht.juris.de

Normen: http://www.beuth.de

, Bibliothek der Universität Karlsruhe Der Weg zur "haftungssicheren" Dokumentation. Andrea Rögner 2003: GFT GmbH; Auflage 1 Standardisierungsmethoden für die Technische Dokumentation. Jürgen Muthig (Hrsg.) 2008: Schmidt-Römhild; Auflage 1.

Interkulturelles Technical Writing. Fachliches adressatengerecht vermitteln. Susanne Göpferich 1998: Narr; Auflage 1 Microsoft Office: Empfehlungen siehe Word Folien SS 2011, R. Schmidt 195