Transcript Aufgabenstellung ()

Projektarbeit
Technische Dokumentation
Aufgabenstellung, Anforderungen, Bewertungskriterien
Dipl. Tech. Red. Raphaela Schmidt
[email protected]
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
2
Abgabedokumente
(jeweils für Papier und CD)
1. Titelblatt der Hausarbeit
2. Zeitplan: Soll und Ist
3. Bedienungsanleitung
–
–
–
–
Eigentliche Bedienungsanleitung
Festlegung der Formulierungsmuster
Erstellung eines Formatkatalogs
Ausdruck der verwendeten Formatvorlagen
4. Abschlusspräsentation
SS 2011, R. Schmidt
3
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
4
Zeitplanung Soll
Arbeitspaket
Std.
Verantwortlicher
Zeitplan erstellen
KW
12
KW
13
…
KW
17
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
5
Zeitplanung Ist
Arbeitspaket
Std.
Verantwortlicher
Zeitplan erstellen
KW
12
KW
13
…
KW
17
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
6
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
7
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
8
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
9
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
10
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
11
Ausdruck der Formatvorlagen
• Datei / Drucken: Formatvorlagen / OK.
SS 2011, R. Schmidt
12
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
0
Standard
Handlungsaufforderung
0
Standard
Handlungsresultat
0
Standard
Überschrift 1
1
…
…
…
SS 2011, R. Schmidt
13
Vorgaben für die Präsentation
• Powerpoint-Präsentation
• Vorstellung Ihres Projekts, NICHT des Produkts
• Mindestinhalte:
1. Wie kamen Sie auf Ihr Thema?
2. Was hat länger/kürzer gedauert als geplant? Auswertung
3.
4.
5.
6.
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
14
Abgabe auf Papier und CD
Abgabe des
Papierausdrucks
in einem
Schnellhefter
Beschriftung der CD mit
• „Hausarbeit Technische
Dokumentation“
• Namen der Gruppenmitglieder
• Abgabedatum
SS 2011, R. Schmidt
15
Abgabedokumente
• Schnellhefter
1. Titelblatt der Hausarbeit(!)
2. Zeitplanung Soll
3. Zeitplanung Ist
4. Bedienungsanleitung
5. Festlegung der
• CD
Formulierungsmuster
6. Ausdruck des Formatkatalogs
7. Ausdruck der verwendeten
Formatvorlagen (Datei / Drucken/
–
–
–
–
–
Drucken: Formatvorlagen)
8. Präsentation
(6 Folien pro Seite)
9. Ggf. Quellen (OriginalBedienungsanleitung/en)
SS 2011, R. Schmidt
–
–
–
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 (OriginalBedienungsanleitung/en)
16
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
17
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
18
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
19