Projektarbeit Technische Dokumentation Aufgabenstellung, Anforderungen, Bewertungskriterien Dipl. Tech. Red. Raphaela Schmidt raphaela.schmidt@gmail.com

Aufgabenstellung Selbstständige Erstellung einer standardisierten, normgerechten Bedienungsanleitung mit MS Word Verwendung der Standardisierungsmethode Funktionsdesign Gestaltung von normgerechten Warnhinweisen Bearbeitung des Projekts in (2er- oder) 3er Gruppen. 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,… SS 2011, R. Schmidt

Abgabedokumente (jeweils für Papier und CD) Titelblatt der Hausarbeit Zeitplan: Soll und Ist Bedienungsanleitung Eigentliche Bedienungsanleitung Festlegung der Formulierungsmuster Erstellung eines Formatkatalogs Ausdruck der verwendeten Formatvorlagen Abschlusspräsentation SS 2011, R. Schmidt

Vorgaben für Titelblatt Hausarbeit Hochschule Karlsruhe – Technik und Wirtschaft Fakultät für Maschinenbau und Mechatronik Vorlesung Technische Dokumentation PROJEKTARBEIT Thema: Standardisierte Erstellung einer Bedienungsanleitung mit MS Word unter Verwendung der Methode Funktionsdesign Vorgelegt von: … Vorgelegt am … Betreuende Dozentin: Raphaela Schmidt SS 2011, R. Schmidt

Zeitplanung Soll Arbeitspaket Std. Verantwortlicher KW 12 KW 13 … Zeitplan erstellen x Layout in MS Word einrichten Funktionsdesign planen (inkl. Formulierungsmuster) und umsetzen Funktional benannte Formatvorlagen in MS Word anlegen Recherche, Texte erstellen, Bilder (erstellen bzw.) organisieren Lektorat Rechtschreibung und Grammatik Lektorat Funktionsdesign (inkl. Formulierungsmuster) Lektorat Sicherheitshinweis Lektorat Typographie Präsentation erstellen Ausdrucken, in Schnellhefter, CD brennen und beschriften. Kontrolle ob alle geforderten Ausdrucke/Dateien vorhanden sind. SS 2011, R. Schmidt

Zeitplanung Ist Arbeitspaket Std. Verantwortlicher KW 12 KW 13 … KW 17 Zeitplan erstellen x Layout in MS Word einrichten Funktionsdesign planen (inkl. Formulierungsmuster) und umsetzen Funktional benannte Formatvorlagen in MS Word anlegen Recherche, Texte erstellen, Bilder (erstellen bzw.) organisieren Lektorat Rechtschreibung und Grammatik Lektorat Funktionsdesign (inkl. Formulierungsmuster) Lektorat Sicherheitshinweis Lektorat Typographie Präsentation erstellen Ausdrucken, in Schnellhefter, CD brennen und beschriften. Kontrolle ob alle geforderten Ausdrucke/Dateien vorhanden sind. SS 2011, R. Schmidt

Tipps zur Zeitplanung Erstellen Sie die Zeitplanung in MS Excel. Planen und bearbeiten Sie Arbeitspakete wenn möglich parallel. Informieren Sie den Dozenten sofort, falls ein Projektmitglied nicht „mitziehen“ oder abspringen sollte. SS 2011, R. Schmidt

Vorgaben für die Bedienungsanleitung Inhalte 6 bis 10 Seiten in MS Word Mindestens Titelblatt, Inhaltsverzeichnis, Kapitel „Grundlegende Sicherheitshinweise“ und Kapitel „Bedienung“ Mindestens 1 normenkonformer handlungsbezogener Warnhinweis nach ANSI Z535.6, ISO 3864.2 und ISO 7010 SS 2011, R. Schmidt

Vorgaben für die Bedienungsanleitung Standardisierungsmethode Funktionsdesign Die optische Gestaltung unterstreicht die Funktion der Inhalte. Mehrschrittige Handlungsanweisungen als nummerierte Listenpunkte, … Optische Gestaltung ausschließlich über Formatvorlagen, keine Direktformatierungen Formatvorlagen funktional benannt (nicht „Standard“, sondern z.B. „Themenangabe“, „Handlungsvoraussetzung“, „Handlungsaufforderung“, „Resultat“) und konsistent zugewiesen Konsistente Verwendung von Formulierungsmustern mindestens bei Überschriften und Handlungsanweisungen SS 2011, R. Schmidt

Vorgaben für die Bedienungsanleitung MS Word Automatisches Inhaltsverzeichnis Die Überschrift „Inhaltsverzeichnis“ bzw. „Inhalt“ erscheint nicht im Inhaltsverzeichnis selbst Jedes Kapitel beginnt automatisch auf einer neuen Seite Referenzierte Überschrift in Kopfzeile Automatische Seitenzahl in Fußzeile Keine Kopf- und Fußzeilen auf der Titelseite. Marginalienlayout für die Kapitel Referenzierte Bilder (Einfügen / Grafik / Mit Datei verknüpfen) Qualität aller Bilder im Ausdruck gut (nicht pixelig oder verschwommen) Typographische Grundregeln beachtet Keine Rechtschreibfehler (Word Rechtschreibkontrolle!) SS 2011, R. Schmidt

Beispiele für Formulierungsmuster Funktionale Einheit Formulierungsmuster Beispiel Überschrift 1. Ebene Substantiv Reinigung Überschrift 2. Ebene Substantiv + Verb Gerät entkalken Handlungsaufforderung Imperativ mit Anrede „Sie“ Drücken Sie die Taste. SS 2011, R. Schmidt

Ausdruck der Formatvorlagen Datei / Drucken: Formatvorlagen / OK. SS 2011, R. Schmidt

Formatkatalog Namen aller verwendeten Formatvorlagen Darstellung der Vererbung (auf welcher FV basiert die FV?) Angabe der Ebene Tabellarische Darstellung im Querformat Beispiel: Basierung Name Ebene Standard Handlungsaufforderung Handlungsresultat Überschrift 1 1 … SS 2011, R. Schmidt

Vorgaben für die Präsentation Powerpoint-Präsentation Vorstellung Ihres Projekts, NICHT des Produkts Mindestinhalte: Wie kamen Sie auf Ihr Thema? Was hat länger/kürzer gedauert als geplant? Auswertung anhand eines bzw. zweier Excel-Diagramme. Vorstellung Ihrer Bedienungsanleitung anhand der Word-Datei Highlights Ihrer Arbeit Was lief gut? Welche Probleme hatten Sie und wie haben Sie diese gelöst? Erkenntnisse für zukünftige Projekte Dauer: 5 bis 8 Minuten Es präsentiert die gesamte Gruppe. SS 2011, R. Schmidt

Abgabe auf Papier und CD Beschriftung der CD mit „Hausarbeit Technische Dokumentation“ Namen der Gruppenmitglieder Abgabedatum Abgabe des Papierausdrucks in einem Schnellhefter SS 2011, R. Schmidt

Abgabedokumente Schnellhefter CD Titelblatt der Hausarbeit(!) Zeitplanung Soll Zeitplanung Ist Bedienungsanleitung Festlegung der Formulierungsmuster Ausdruck des Formatkatalogs Ausdruck der verwendeten Formatvorlagen (Datei / Drucken/ Drucken: Formatvorlagen) Präsentation (6 Folien pro Seite) Ggf. Quellen (Original-Bedienungsanleitung/en) CD Titelblatt der Hausarbeit: DOC Zeitplanung Soll und Ist: XLS Bedienungsanleitung: DOC und PDF ALLE Bilder der Bedienungsanleitung Festlegung der Formulierungsmuster: DOC oder XLS Formatkatalog: XLS Präsentation: PPT Ggf. Quellen (Original-Bedienungsanleitung/en) SS 2011, R. Schmidt

Termine 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. Feedback zur Projektarbeit Fr, 29.04 Abgabe und Präsentation SS 2011, R. Schmidt

K.O. Kriterien Dokumente termingerecht im geforderten Umfang abgegeben? Funktionsdesign entwickelt und umgesetzt? Vorgaben für MS Word vollständig umgesetzt? Grundregeln der Typografie beachtet? Grundlegende Sicherheitshinweise kurz und prägnant formuliert und sinnvoll gegliedert? Handlungsbezogene Warnhinweise normenkonform erstellt? Präsentation informativ und interessant? SS 2011, R. Schmidt

Tipps zur Arbeit in Projektgruppen Tauschen Sie sich innerhalb Ihrer Projektgruppen intensiv aus (Treffen, E-Mail, Chat,…). Nutzen Sie die Gruppe für häufige Feedbackrunden und geben Sie sich Hilfe bei Unklarheiten und Problemen. Legen Sie Ihre Dokumente zentral und für alle Gruppenmitglieder jederzeit zugreifbar ab (z.B. in eine Dropbox: www.dropbox.com). Vermeiden Sie redundante Datenhaltung. SS 2011, R. Schmidt