Vorlesung Technische Dokumentation 1

Inhalt
• Layout
• Texte, Kapitel, Nummerierung
• Bilder
Vorlesung
• Bildunterschriften und Bildreferenzierung
• Grafiken
• Diagramme
• Tabellen
Technische Dokumentation 1
• Zahlen, Größen, Einheiten und Gleichungen
• Literatur
Gestaltungshinweise, Regeln und Normen
• Tipps und Tricks zur Texterstellung
• Benotung von Berichten an der Hochschule
• Zusammenfassung
Technische Dokumentation
1/17
Gestaltungshinweise,
und Normen
© Studiengang
Mechatronik Regeln
und Mikrosystemtechnik
an der Hochschule Heilbronn • Prof. Dr.-Ing. Wolfgang
• 2017
© HHN • Wehl
Wehl (2017)
Technische Dokumentation
Gestaltungshinweise, Regeln und Normen
2/17
© HHN • Wehl (2017)
Text-, Kapitelstruktur und Seitenzählung
Layout des Berichts
Deckblatt
HS-intern: nur Laborname
Berichtsblatt zum praktischen Studiensemester (nur bei PSS-Bericht)
Kurzfassung
zentriert, 1 cm vom oberen Seitenrand
... geht davon aus, dass der Leser den Rest nicht kennt
Inhaltsverzeichnis (optional Bilder-, Tabellen-, Formelzeichen- und
Abkürzungsverzeichnis
1 Einleitung (ggf. 1.1 ...; 1.2 ...; ...)
2 Kapitel ... (ggf. 2.1 ...; 2.2 ...; ...)
...Kapitel ...
n Kapitel ... (ggf. n.1 ...; n.2 ...; ...)
n+1 Zusammenfassung und Ausblick
unten, linksbündig (Tabellenstruktur)
... geht davon aus, dass der Leser den Bericht kennt
n+2 Literaturverzeichnis
n+3 Anhang
Seitenzählung: Entweder beim Deckblatt oder bei der Einleitung mit Seite 1 beginnen
Technische Dokumentation
Gestaltungshinweise, Regeln und Normen
3/17
© HHN • Wehl (2017)
Technische Dokumentation
Gestaltungshinweise, Regeln und Normen
4/17
© HHN • Wehl (2017)
Textstruktur und -nummerierung
Fließtext
Man verwendet Argon (Ar) in der Halbleitertechnik als Sputtergas in Form eines Argonplasma, sowie als Schutz- und Trägergas, da es als Edelgas sehr reaktionsträge (inert) ist und somit
nicht mit dem Wafer chemisch reagiert. Zudem lässt sich Argon
sehr rein gewinnen und enthält deshalb kaum Kontaminationen
(Eigenschaften: Chemisches Element aus der achten Hauptgruppe, Ordnungszahl 18, Relative Atommasse 39,95, Schmelzpunkt 189,2 °C, Siedepunkt 185,9 °C) [1].
Arsen (AS) ist eine metallisch aussehende Substanz geringer
Härte, welche man in der Halbleitertechnik zur n-Dotierung sowie zur Herstellung von Halbleitern (Galliumarsenid) verwendet. Arsen und seine Verbindungen sind sehr giftig. (Eigenschaften: Chemisches Element aus der fünften Hauptgruppe,
Ordnungszahl 33, Relative Atommasse 74,92, Dichte 5,7 g/cm3.
Bei einer Temperatur von 613 °C sublimiert festes Arsen direkt
in gasförmiges Arsen) [1].
1
1 Erstellung technischer Berichte
Serifenschrift
Blocksatz
Silbentrennung
Komma
Abstand
Zahlen bis zwölf
geschütztes
Leerzeichen1
Literaturverweis
Dies erscheint nur im ersten Moment schwierig.
Wenn man in der Vorbereitungsphase die Abläufe
strukturiert und systematisch abarbeitet, fällt einem vor einem Unterkapitel
die abschließende Umsetzung ganz einfach. Zur Vor- muss ein Text stehen
bereitung gehört die Stoffsammlung und der Entwurf
einer Gliederung.
Literaturverweise in der
Überschrift nicht zulässig
1.1. Stoffsammlung [3]
kein
Punkt hinter der letzten
Eine gute Basis für die Stoffsammlung ist ein MindZiffer
Map. Es empfiehlt sich, sehr regelmäßig (!) während
der Durchführung der Arbeit alles verfügbare Material zu sammeln und nach Vorgabe der eigenen
Mind-Map grob vorzusortieren.
1.2 Gliederung
...
Untergliederung nur zulässig, wenn mindestens
zwei Kapitel folgen
(vor dem Punkt!)
Eingabe durch [Strg]+[]+[Leertaste]
5/17
Technische Dokumentation
Gestaltungshinweise, Regeln und Normen
© HHN • Wehl (2017)
Bilder, Bildunterschriften und Referenzierung
Ein Bezug auf die Überschrift
ist nicht zulässig
Technische Dokumentation
Gestaltungshinweise, Regeln und Normen
6/17
© HHN • Wehl (2017)
Grafiken
Die Robert Bosch GmbH stellt seit vielen Jahren Drehratensensoren her. Anfangs waren
diese feinwerktechnisch aufgebaut (siehe Bild 3.2). Nachdem der „Elchtest“ die 1997 noch
neue A-Klasse von Mercedes zum Kippen gebracht hätte, konnten sich die viel billigeren
und zuverlässigeren mikrotechnischen Drehratensensoren von Bosch schnell durchsetzen.
Grafik so groß wie
möglich, ausreichende
Linienstärke, Farbe
Bildreferenzierung
1
Bild so groß wie möglich,
scharf, nur mit wesentlichem
Inhalt
2 3 4 5
möglichst ausführliche
Bildunterschrift mit
Detailbeschreibung
möglichst ausführliche Bildunterschrift mit Detailbeschreibung
Referenzgröße
Bild 3.2 Vergleich eines feinwerktechnisch und eines mikrotechnisch aufgebauten Drehratensensors von Bosch [4]. 1 Sensortrommel mit acht piezoelektrischen Elementen, 2 Beschleunigungssensor, 3 Auswertechip, 4 mikrotechnischer Drehratensensor, 5 Dickschichtschaltung
Technische Dokumentation
Gestaltungshinweise, Regeln und Normen
7/17
© HHN • Wehl (2017)
Bild 3.3 Schematischer Aufbau einer Diffusionspumpe zur Erzeugung
von Hochvakuum. 1 Dampfstrahl (Spezialöl), 2 Gasmoleküle,
3 gekühlte Gehäusewand, 4 Purifikationszone, 5 Siederaum,
6 Heizung
Technische Dokumentation
Gestaltungshinweise, Regeln und Normen
8/17
© HHN • Wehl (2017)
Diagramme (z. B. aus Excel)
Tabellen und Tabellenüberschriften
Alles falsch
Optimal
Anhalteweg beim Bremsen
Tabellen haben Überschriften, Bilder etc. Unterschriften
120
Tabelle 3.1 Kinetische Eigenschaften verschiedener, in der mikro- ggf. Quelle
technischen Fertigung eingesetzter Gase [2]
nicht vergessen
Reaktionsweg in m
140,0
Bremsweg in m
100
120,0
100,0
Anhalteweg in m
80,0
Wege in m
80
s [m]
Reaktionsweg in m
Bremsweg in m
Anhalteweg in m
60,0
60
40
40,0
20,0
20
0,0
0
50
100
150
200
0
v [m/s]
0
siehe auch:
de.wikipedia.org/wiki/Achsenbeschriftung DIN 461
de.wikipedia.org/wiki/DIN_1313: Physikalische Größen
20
40
60
80
100
Geschwindigkeit v in m/s
120
140
160
Bild 3.1 Anhalteweg eines Autos bei einer
Reaktionszeit von 0,5 s und einer
Bremsverzögerung von 10 m/s2
Zahlen in Ziffern
gerade
1; 123; -4,56
Zahlen in Buchstaben bei freier Bedeutung
kursiv
n-fach; 2n; aik
Zahlen in Buchstaben bei konventioneller
Bedeutung
gerade
e  2,718 (Eulerzahl)
i2 = j2 = -1 (imaginäre Einheit)
Formelzeichen für physikalische Größen, auch
physikalische Konstanten
kursiv
Zeichen für Funktionen und Operatoren,
wenn deren Bedeutung frei wählbar ist
kursiv
Zeichen für Funktionen und Operatoren,
wenn mit konventioneller Bedeutung
gerade
d; ; ; ; div; lim; Re (Realteil); lg
Zeichen für Einheiten
gerade
m (Meter); µF (Mikrofarad)
Symbole für Chemie und Atomphysik
gerade
Fe (Eisen); e‒ (Elektron)
Wortabkürzungen
gerade
pabs (absolut); Fmin (minimal)
Technische Dokumentation
Gestaltungshinweise, Regeln und Normen
H2
2
1762
5,3
He
4
1246
3,7
H2O
18
587
1,8
N2
28
471
1,4
Luft
29
463
1,4
Ar
40
394
1,2
CO2
44
376
1,1
Schreibweisen:
Größe in Einheit
oder
Größe/Einheit
falsch wäre:
Größe [Einheit]
10/17
© HHN • Wehl (2017)
Größen: kursiv
Indizes: normal (nicht kursiv)2
Schriftlage Beispiele
pLuft   Hg  g  h  h 
i (elektrische Stromstärke; m (Masse)
e  1,602·10-19 As (Elementarladung)
y = f (x)
u(t) = U0 sin t
pLuft
 Hg  g
(2.3)
Komma
Leerzeichen1
1,013  105
m3  s 2  N
h

 0,762 m
13,546  103  9,81 kg  m  m 2
Runden!
(2.3a)
Nummerierung
Ziffern und Einheiten: normal (nicht kursiv)2
Achtung, das ist falsch und niemals zulässig:
• eckige Klammern um eine Einheit (z. B. [V])
• Einheiten indizieren (z. B. VDC)
 DIN 1304 Formelzeichen und DIN EN ISO 80000: Internat. Größensystem (ISQ)
Machzahl
1
Gleichungen
Größenwert = Zahlenwert x Einheit (Beispiele t = 5 s;  = 20 °C)
Merke: Zwischen Zahlenwert und Einheit muss
immer ein (geschütztes) Leerzeichen stehen.
z. B. 10 s; 30,5 kg; 10 %; 25 °C (aber 45°)
mittlere Geschw.
c in m·s-1
Technische Dokumentation
Gestaltungshinweise, Regeln und Normen
© HHN • Wehl (2017)
Größen, Zahlenwerte und Einheiten (DIN 1338)
Gegenstand
Molare Masse
Mmolar in g·mol-1
kleinere, serifenlose Schrift oft zweckmäßiger (z. B. Calibri 8 oder 10 Punkt)
9/17
Technische Dokumentation
Gestaltungshinweise, Regeln und Normen
Gas
1
2
Eingabe im Formeleditor mit [Strg]+[Leerzeichen] oder mit Formatvorlage Text
Im Formeleditor unter Formatvorlage Text auswählen (ggf. Format vorher definieren)
[de.wikipedia.org/wiki/Formelsatz]
11/17
© HHN • Wehl (2017)
Technische Dokumentation
Gestaltungshinweise, Regeln und Normen
12/17
© HHN • Wehl (2017)
Literaturverzeichnis
Tipps zur Rechtschreibung
so ist es richtig und gut 
alles falsch oder schlecht 
230-V-Anschluss / 3-D-Bild
230V Anschluss, 230 V-Anschluss, 3D Bild, 3 D-Bild2
5 s oder fünf Sekunden
5 Sekunden, fünf s, 5 sec3
Druck p in N/m2 oder Druck p / Nm-2
Druck p [N/m2], Druck p (N/m2)4
HS Heilbronn (aber: HS-Mitarbeiter
und Dipl.-Ing. / Dr.-Ing.)
HS-Heilbronn / Dipl. Ing. / Dipl.Ing.5
PCs, CDs, Pkws, LEDs, LCDs
PC’s, CD’s, Pkw’s, LED‘s, LCD‘s6
vmax-Fahrt
Vmax Fahrt / vmax - Fahrt
Duden
Technische Berichte
Verständlich gliedern, gut gestalten, überzeugend vortragen
Heike Hering, Lutz Hering, 2015, Springer Vieweg,
ISBN: 978-3-8348-1586-6 (Print) 978-3-8348-8317-9 (Online)
E-Book (3,6 MB): http://dx.doi.org/10.1007/978-3-8348-8317-9
2.
Duden
• www.duden.de
Komplettes Wörterbuch (auch Fremdwörter) inklusiver Rechtschreibung, Bedeutung,
Aussprache und Grammatik
• Duden Band 1: Die deutsche Rechtschreibung.
26. Auflage, 2014, Dudenverlag, ISBN 978-3-411-04650-8
• Duden Das große Fremdwörterbuch
11. Auflage, 2015, Dudenverlag, ISBN 978-3-411-04061-2
2
Was als ein Wort gesprochen wird, muss als ein Wort geschrieben werden.
3
Das Einheitenzeichen für die Sekunde ist s nicht sec.
4
Einheiten dürfen nicht in eckige oder runde Klammern geschrieben werden (DIN 1313).
5
HS Heilbronn steht für Hochschule Heilbronn  zwei Wörter  kein Bindestrich
6
(Deppenapostroph!) Den Apostroph gibt es nur im Englischen und dort auch nur beim Genitiv.
13/17
Technische Dokumentation
Gestaltungshinweise, Regeln und Normen
1.
© HHN • Wehl (2017)
3.
Das internationale Einheitensystem (SI). 39-seitiger Sonderdruck der PTB-Mitteilungen
aus 117. Jahrgang, Heft 2, Juni 2007. Als PDF herunterladbar unter www.ptb.de
(Publikationen)
4.
DIN 5008 Schreib- und Gestaltungsregeln für die Textverarbeitung
www.din5008.de
Technische Dokumentation
Gestaltungshinweise, Regeln und Normen
Tipps und Tricks zur Texterstellung
Berichtsbewertung
Was
Anwendung
Wie (MS-Word)
Geschütztes Leerzeichen
Zusammenhalt und Größe und Einheit (5 N)
Definierter Abstand bei Blocksatz
Konsistente Schreibweise von Abkürzungen
[Strg] + [] + [Leertaste]
Geschützter Bindestrich
Konsistente Schreibweise von Abkürzungen
[Strg] + [] + [-]
Optionaler Bindestrich
Verbesserte Trennung von Wörtern
[Strg] + [-]
Gedankenstrich [–]
Andere Bedeutung als Bindestrich
[Strg] + [-] (Zahlenblock)
oder [Alt]+150
1. Inhalt
•
•
•
Fachlicher Inhalt
Inhaltliche Verständlichkeit (bezogen auf Leserschaft)
Authentizität (Glaubwürdigkeit: Plagiate führen zu dramatischen Folgen)
2. Sprache
•
1. Bild-, Tabellen- und Literaturreferenzierung durch Feldfunktionen
(alle (!) Bilder, Tabellen und Literaturquellen sind im Text zu referenzieren)
1. Bei Bild, Tabelle oder Literaturliste: {seq Bild} bzw. {seq Tab} oder {seq Lit}
2. Dem kompletten Feld {...} eine (sinnvolle) Textmarke zuweisen
Ausdruck, Zeichensetzung, Rechtschreibung, Denglish, AKüFi
3. Struktur
•
•
•
•
•
•
Inhalts- und Literaturverzeichnis
20 % Einleitung
70 % Hauptteil (Was haben Sie selbst gemacht!)
10 % Zusammenfassung, Fazit und Ausblick
Zusammenspiel von Text, Bild und Gleichungen (Nummerierung, Bezüge)
Gleichungen, Grafiken, Bilder und Bildunterschriften
4. Formalien
3. Bezug im Text durch {ref Textmarke}
•
•
•
•
2. Fußnoten nur im Ausnahmefall verwenden (sie stören den Lesefluss)
3. Spezifische Abkürzungen sind bei der ersten Verwendung zu erläutern.
Ein Abkürzungsverzeichnis kann sinnvoll sein.
Technische Dokumentation
Gestaltungshinweise, Regeln und Normen
14/17
© HHN • Wehl (2017)
15/17
© HHN • Wehl (2017)
Deckblatt (Corporate Design der Hochschule Heilbronn)
Zahlen und Einheiten
Layout (Blocksatz, Kopf- und Fußzeilen, Silbentrennung, Schriftart ...)
Umfang (Praktisches Studiensemester ca. 50 Seiten)
Technische Dokumentation
Gestaltungshinweise, Regeln und Normen
16/17
© HHN • Wehl (2017)
Zusammenfassung
Typografie: Lesbarkeit von Fließtext
•
Die Erstellung eines guten Berichts ist nicht schwierig.
•
Wichtig ist es insbesondere, bei Zeiten ausreichend Material zu sammeln und
aufzubereiten.
•
Versetzen Sie sich beim Schreiben in Ihre Leser. Setzen Sie nur wenig
Kenntnisse der Leser voraus.
•
Hilfreich ist es, sich am Layout von renommierten Fachbuchverlagen
(z. B. Hanser, Vieweg-Teubner, Springer) zu orientieren.
(Achtung! Auch Fachbuchverlage machen Fehler)
•
Unter Dokumentation versteht man die Nutzbarmachung von Informationen zur weiteren Verwendung.
Ziel der Dokumentation ist es, die dokumentierten Objekte gezielt auffindbar zu machen. Bei den
Objekten handelt es sich in der Regel um Dokumente mit einem Informationsgehalt, der mit Hilfe der
Dokumentation systematisch verwertet werden soll. Dokumente können in diesem Sinne Fachbücher,
Zeitschriftenartikel oder sonstige Druckschriften sein, aber auch Bilder, Filme, Tondokumente und
ähnliches. Auch wissenschaftlich erhobene Daten können im Sinne einer Dokumentation behandelt
werden.
Die Erschließung von Informationen ist eine der wesentlichen Aufgaben von Bibliotheken und anderen
Dokumentationseinrichtungen. Die Beschreibung und Verzeichnung bibliographischer und archivalischer
Ressourcen geschieht u.a. durch Katalogisierung, d.h. die Aufnahme von Dokumentationseinheiten in
einen Katalog. (Serifenlose Schrift: Calibri 12 Punkt)
Nutzen Sie – jedoch mit Verstand – externe Quellen (Fachbücher, Internet).
Schreiben Sie nicht einfach ab, sondern reflektieren Sie über Ihre Quellen.
Unter Dokumentation versteht man die Nutzbarmachung von Informationen zur weiteren Verwendung. Ziel der Dokumentation ist es, die dokumentierten Objekte gezielt auffindbar zu machen. Bei
den Objekten handelt es sich in der Regel um Dokumente mit einem Informationsgehalt, der mit
Hilfe der Dokumentation systematisch verwertet werden soll. Dokumente können in diesem Sinne
Fachbücher, Zeitschriftenartikel oder sonstige Druckschriften sein, aber auch Bilder, Filme, Tondokumente und ähnliches. Auch wissenschaftlich erhobene Daten können im Sinne einer Dokumentation behandelt werden.
Die Erschließung von Informationen ist eine der wesentlichen Aufgaben von Bibliotheken und
anderen Dokumentationseinrichtungen. Die Beschreibung und Verzeichnung bibliographischer und
archivalischer Ressourcen geschieht u. a. durch Katalogisierung, d. h. die Aufnahme von Dokumentationseinheiten in einen Katalog. (Schrift mit Serifen: Cambria 12 Punkt)
17/17
Technische Dokumentation
Gestaltungshinweise, Regeln und Normen
© HHN • Wehl (2017)
Bilder
Grafiken
Bild 3.2: alter und neuer Drehratensensor
•
•
•
•
•
viel zu viel Randbereich
„Trauer-“ Rand
unscharf
schlecht ausgeleuchtet
fehlender Weißabgleich
•
•
•
•
•
verschiedene Maßstäbe
fehlender Referenzmaßstab
keine Detailbeschriftung
keine aussagekräftige Bildunterschrift
Doppelpunkt nach „Bild 3.2“ unnötig
•
•
•
•
•
zu viel Information (Grafik gehört in die Anlage)
„Trauer-“ Rand
unscharf, kontrastarm
keine Detailbeschriftung
schlecht schwarzweiß-kopierbar
Gleichungen, Zahlen, Größen und Einheiten
pLuft   Hg  g  h  h 
pLuft
 Hg  g
1.013 105 N / m 2
 0.762306 m
h
13546kg / m 3  9,81m / s 2
Ende
Fehler:
•
•
•
•
•
•
Einheiten kursiv
Kein Leerzeichen zwischen Größe und Einheit
Indizes kursiv
Dezimalpunkt statt Dezimalkomma
Keine Ergebnisrundung
(Trauer-) Rand