Dokumentieren - Technische Berichte schreiben - Fokusprojekt, 23.11.2017 (V1) - product innov@tion - ETH Zürich
←
→
Transkription von Seiteninhalten
Wenn Ihr Browser die Seite nicht korrekt rendert, bitte, lesen Sie den Inhalt der Seite unten
product
innov@tion
Dokumentieren –
Technische Berichte schreiben
Fokusprojekt, 23.11.2017 (V1)
Dr. Christian Schorno schorno@musikzimmer.ch
4 Themen
1. Aufbau eines techn. Berichts: Welche Reihenfolge ist richtig?
a) Einleitung, Vorwort, Abstract
b) Abstract, Vorwort, Einleitung
c) Vorwort, Einleitung, Abstract
d) keine von diesen
2. Zielgruppen: Für wen schreiben Sie eigentlich diese Berichte?
3. Richtig zitieren: Fussnoten, eckige Klammern oder wie?
4. Schreibweise von Masszahlen, Mikrotypografie: Was ist richtig?
a) 9,3Nm/s
b) 9.3Nm/s
c) 9,3 Nm/s
d) 9.3 Nm/s
Inhaltliche Struktur eines Dokuments
— Titel-/Deckblatt
— Abstract
— Vorwort (optional) Titelei (hat röm. Nummerierung)
— Inhaltsverzeichnis
— Liste der verwendeten
Abkürzungen/Symbole (optional)
— Einleitung
— Hauptteil Inhalt, gegliedert und nummeriert
— Zusammenfassung
— Literaturverzeichnis
Verzeichnis- und Anhangsteil
— Anhang
Gliederung und Benummerung in Texten – DIN 1421
— Abschnitt
— Textteil, entstanden durch Gliederung,
gekennzeichnet durch Abschnittnummer und Überschrift
— Maximal drei Hierarchiestufen
— 2.4.11 und nicht 2.4.11.
— Zählnummer 0 (2.0) als Präambel/Vorbemerkung möglich
— Abschnittnummer und Überschrift typografisch hervorheben
— Absatz
— Textteil, entstanden durch Gliederung eines Abschnittes
— Titel hervorgehoben ohne Nummerierung („Zwischentitel“)
— Aufzählungen
— Textteil, vorwiegend durch Gliederung entstanden und durch
Ordnungszahlen (1.), Buchstaben mit Klammer (a)) oder
Bindestrich („n-dash“, –) gekennzeichnet
Titelblatt — Aussagekräftige Titel und Untertitel — Projektgruppe (Namen), Nennung der Verantwortlichen — Institution (gegebenenfalls mit Logo) — Datum, Semesterbezeichnung — Grafik (optional) – wenn, dann aussagekräftig!
Abstract
— Die kürzest mögliche und rein sachliche Wiedergabe dessen, worum es
im Bericht geht – Umfang i.d. Regel eine bis drei Viertelseiten.
— Abstracts können vom Bericht getrennt publiziert werden
(z.B. in Bibliografien).
— Abstracts zeigen, für welche Fragestellungen und Interessen ein Bericht
bzw. das Projekt relevant ist.
— Enthält:
— das Thema
— die wesentlichen Probleme
— die Ergebnisse
— einen Ausblick: Was lässt sich mit dem Ergebnis anfangen?
— Enthält keine Zitate, Verweise („In diesem Bericht ...“), Abbildungen
— Ist informativ nicht berichtend geschrieben!Formel eines Abstracts
— „Der (Projekt-)Bericht behandelt das Thema X im Y-Projekt.
Dieses Projekt hat zum Ziel, ... Die Probleme P1, P2 und Pn
werden mit den Methoden M1, M2 und M3 gelöst. Das führt zum
Ergebnis E, mit Bewertung B.“
— Projekt und Thema/Feld nennen
— Projektziel wiedergeben
— Exemplarische Problemstellungen nennen und sagen, wie diese
Probleme gelöst wurden (dies ist der zentralste Punkt, hier entscheidet
eine künftige Leserin oder ein Leser, ob sie oder er den Bericht liest)
— Ergebnis darlegen und kritisch bewerten.
Eine Bewertung kann sein, dass die Lösung weiter verbessert werden
muss oder dass das Problem gelöst ist, aber sich dadurch neue
Probleme ergeben.Stilfehler im Abstract — In diesem Bericht wird die Arbeit des Teams XY präsentiert. — Nach einer Vorstellung der Teamorganisation werden die Anforderungen aufgelistet. Als Hauptteil werden die Detaillösungen vorgestellt. — Ein Problem für das Organisationsteam war das fehlende Know- How sowie die Unterbesetzung. — Der Leser erhält zuerst einen Überblick über ... — Es werden die wichtigsten Anforderungen an das Bauteil dargelegt. — Various concepts are analyzed and discussed in detail until the team members agreed on the most feasible and practical solution.
Vorwort — Perspektive: Sie als Team sprechen über die Zusammenarbeit im Team und mit den Coaches und danken den Personen und Institutionen, die zum Entstehen der Arbeit beigetragen haben — Persönliche Bedeutung der Arbeit/des Projekts — Danksagungen
Diskussion: Gliederung und Benummerung — Suchen Sie den Fehler bei folgender Benummerung!
Inhaltsverzeichnisse
— Abschnittnummern und Überschriften je in einer vertikalen
Fluchlinie untereinander anordnen
1 XXXXXXXXXXXXXXXXXXXXXXXX
2 XXXXXXXXXXXXXXXXXXXXX
2.1 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
2.2 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
3 XXXXXXXXXXXXXXXXXXXXXXXXXXXXX
3.1 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
3.1.1 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
3.1.2 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
3.1.3 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
Quelle: DIN 1421 – Gliederung und Benummerung in TextenEinleitung – Zusammenfassung
— Einleitung — Zusammenfassung
— erstes Kapitel des — letztes Kapitel des Dokuments
Dokuments — fasst Resultate zusammen
— beschreibt Aufgabenstellung — Antwort auf Aufgabenstellung
und Ausgangssituation — Nutzen darlegen
— Projektmanagement: — Ausblick (was geschieht damit
Ziele, Team-Organisation und wie geht es weiter?)
(Aufbau, Arbeitsabläufe), — Empfehlungen an Stakeholder
Kommunikations-Kanäle,
— Unsicherheiten erwähnen
Projektplan, Risikoanalyse
— erklärt gewählte Gliederung — Umwege sind «lessons learned»
des Dokuments
— Perspektive: führt Leser hinaus:
— Perspektive: führt Leser ein:
Welt Bericht Bericht Welt
Aufmerksamkeitserweiterung
AufmerksamkeitsverengungEinleitung
— Fragestellung
— Ausgangssituation
— Stand der Technik/Forschung
— Projektplan mit
— Projektzielen (wie verhalten sich Ziele zueinander)
— Arbeitspaketen
— Projektplan/Meilensteine
— Team-Organisation, Kommunikationsplan
— Finanzplan
— Gegebenenfalls Risikoanalyse und -managementHauptteil
— Kapiteleinteilung entsprechend dem Vorgehen im Projekt
— Logische, nicht historische Reihenfolge!
— Darstellung anhand des Musters „Problem-Lösung“
— Was ist das Problem?
— Wie haben Sie es gelöst?
— Lösungen, Methodeneinsatz, Entscheide begründen
(=> nächste Folie)
— Jedes Kapitel genügt sich selbst, d.h. es hat eine Einleitung am
Anfang und eine Zusammenfassung am EndeText: Stilistik — Berichtsperspektive: unpersönlich statt ich/wir (ausser Vorwort) — Zeit: Perfekt: „Das Team hat beschlossen, …“ — überflüssige Wörter weg (Adjektive!) — keine langen Sätze, Sätze mit über 25 Wörtern stehen unter Verdacht — verschachtelte Nebensätze vermeiden — Absätze mit einem Satz irritieren — Verneinung nicht am Satzende — Fremdwörter wenn möglich vermeiden
Text: Stilistik Beispiel
— Für die Konstruktion einer Baugruppe beinhaltet eine Stückliste
alle Informationen der darin enthaltenen Bauteile.
— Eine Stückliste beinhaltet für die Konstruktion einer Baugruppe
alle Informationen der darin enthaltenen Bauteile.
— Die Stückliste einer Baugruppe enthält alle Informationen über
die verwendeten Bauteile und dient der Konstruktion.
— Bauprinzipien:
— Thema (bekannte) – Rhema (neue Information)
— Verschiedene Funktionen, verschiedene Sätze.Wissen zum Ausdruck bringen — Wissen ist um so sicherer, informativer bzw. wissenschaftlicher, je mehr Optionen geprüft wurden — Wir haben X gemacht. (willkürlich, nicht sehr informativ) — Wir standen vor der Entscheidung, X, Y oder Z zu machen. Wir wählten X. (informativ, aber immer noch willkürlich) — Wir standen vor der Entscheidung, X, Y oder Z zu machen. Wir wählten X, weil ... (informativ, begründet, aber nch unmethodisch/unwissenschaftlich) — Wir standen vor der Entscheidung X, Y oder Z zu machen. Hier bieten sich die Methoden M und N an bzw. die Theorien T und U. M/T gilt unter der Bedingung A als richtig (zu belegen). Also gingen wir nach M/T vor und es zeigte sich, dass Weg Y richtig ist. (nun auch wissenschaftlich)
Text: Verständlichkeit
— Hamburger Verständlichkeitskonzept
nach Langer / Schulz v. Thun / Tausch
— Ordnung/Gliederung
— Einfachheit (Wortwahl, Satzbau)
— Kürze/Prägnanz
(so knapp wie möglich so ausführlich wie nötig)
— zusätzliche Stimulans
Siehe:
Langer / Schulz v. Thun / Tausch (2006):
Sich verständlich ausdrücken. München, 8. AuflageAnordung und Gestaltung der Information — Allgemeines vor Besonderem — Normalfall vor Ausnahme — Positives vor Negativem — Thematisch Zusammengehöriges soll auch im Text nahe bei einander stehen — Logische und zeitliche Folgen einhalten (Handlungen, Vorgänge, Ereignisse) — Voraussetzungen und Folgen, Gründe und Schlüsse klar auseinander halten — Textauszeichnungen oder Marginalien (optionales Element) als Orientierungshilfe — Heute spricht man von Topic-Orientierung (für Anleitungen im internet relevant): Unter einem Titel steht genau, das
Die Topic-Orientierung
— Begriff kommt aus der technischen Dokumentation und ist vor
allem für Anleitungen im Internet relevant. Man geht davon aus,
dass Leserinnen und Leser gezielt und selektiv lesen.
— Textabsätze und Gliederungsabschnitte müssen sich selbst
genügen; ihr Verständnis soll möglichst nicht von der
Lektüre weiterer Abschnitte/Absätze abhängig sein.
— Unter einem Titel steht genau das, was der Titel Ankündigt.
— Ein Topic erklärt etwas, ist eine Anleitung oder gibt eine
Übersicht.Berechnungen — Berechnungsgänge gehören in den Anhang. — Ausnahmen sind für Ihr Thema zentrale oder innovative Berechnungen. — Einem Berechnungsgang geht möglichst eine Skizze mit den Grössen voraus. — Den Berechnungsgang übersichtlich und nachvollziehbar aufschreiben.
Anhang — umfangreiche Tabellen — grosse Diagramme — Skizzen — Technische Zeichnungen — Patente — längere mathematische Herleitungen, Berechnungsgänge — Datenblätter — Historisch ist der Anhang eine Mappe mit Zeichnungen. — Daher ist der Anhang vom Layout befreit! Ähnliche Dinge sollten ähnlich aussehen, sonst aber sind Sie frei in der Gestaltung. — Doppelseiten/Faltblätter sind möglich.
Verschiedene Zielgruppen
— allgemein (gilt für alle Zielgruppen)
— Standards einhalten; Bücher/Berichte sind eine Kulturtechnik
— Orientierung dank: Titelstruktur mit aussagekräftigen Titeln,
Abstract, Zusammenfassung(en), Illustrationen
— Management: Machbarkeit, monetäre Aspekte, Aufwand/Ertrag,
strateg. Entwicklung, SWOT, wichtigste Argumente, Geschichten
— Technik: exakte Zeichnungen, richtige Berechnungen,
Anforderungslisten, Stücklisten, Methoden, Lösungen, Optionen
— Wissenschaft: wissenschaftlichkeit, Methodik
— künftige Teams: Erfahrungen, best practices, lessons learned
— Was Zielgruppen suchen, sollte ein Topic und im Inhalts-
verzeichnis auffindbar sein.Verweise
— Textstellen sollen nicht wiederholt,
sondern zitiert werden!
— Beispiele von richtigen Verweisen:
— siehe Abschnitt 3.2
— s. Abschn. 3.2
— siehe Abschnitt 3.2 Absatz a
— siehe Abschnitt 3.2 Absatz a Aufzählung 3
— s. Abschn. 3.2 Abs. a Aufz. 3
— siehe Bild ABC001
— siehe Tabelle ABC005
— Verweise werden in der Regel am Ende eines Satzes oder
Abschnitts in Klammer vor den Punkt eingefügt (siehe 3.4.6).
— Viele Verweise verletzen das Prinzip der Topic-Orientierung.
Quelle: DIN 1421 – Gliederung und Benummerung in TextenText und Bild
— Es gibt kein Bild, keine Illustration ohne Text, weil ein Bild nicht
für sich selbst sprechen kann.
— Ein Bild, das eine ganze Spaltenbreite einnimmt, wird vom
Satzprogramm an passender Stelle eingefügt. Es sollte aber
nach der Textstelle zu stehen kommen, auf die es sich bezieht.
— Ein Bild, das als Float (siehe Abb. 1) in den Text eingefügt wird,
sollte, wenn möglich, auf der selben Seite stehen wie die
Textstelle, auf die sie sich bezieht.
Abb. 1: Floatende BilderUmgang mit Quellen
— Jede fremde Autorleistung muss
als solche gekennzeichnet
werden.
— Der Umgang mit Quellen ist eine
Frage der wissenschaftlichen
Arbeitsweise und der Gewöhnung.
— Ein Zitat ist die Wiedergabe eines Ausschnitts aus einem Werk.
— Ein Bild kann nicht zitiert, nur als ganzes Werk wiedergegeben werden.
Ist darum fast immer heikel. Für interne Publikationen wie Ihre
Berichte ist das aber kein Problem.
— Versehen Sie jedes Bild aus dem Web, aus Herstellerkatalogen, aus
Büchern mit einer Quellenangabe. Ausnahme: Logos.Im Dickicht der Zitierstile – eine Systematik
— Grundsätzlich gibt es verschiedene Systeme.
Kein Grund für ein Sektierertum!
Verwenden Sie das System, das am Institut
oder dem Organ verlangt wird.
— Ein guter Überblick über die Systeme gibt
der Quick Guide des Chicago Manual of Style:
http://www.chicagomanualofstyle.org/tools_citationguide.html (18.11.15)
— Dieser unterscheidet zwei Arten von Zitaten:
1. geisteswissenschaftlich: notes and bibliography style
Fussnote und Bibligraphie
2. naturwissenschaftlich/technisch: author-date system:
(Autor 2012, 34)Fussnoten
— im Text: Fussnotennummer22
— Wofür? Für Quellenangaben, weniger wichtige Kommentare, ...
— Wo? Am Zitat-/Satzende, unmittelbar beim entscheidenden Begriff.
— Warum? Um den Text zu entlasten, ihn schneller lesbar zu machen.
— unten auf der Seite – 2 pt kleiner als Laufschrift
— Hier ist das Team zuerst auf folgenden Irrweg geraten: ...
— Autor (Jahr), S. 23. Darauf folgt optional Ihr Kommentar
— [Website-Name: ]http://www.internetverweis.net (Datum)
— im Quellen-/Literaturverzeichnis, die kompletten Literaturangaben
— Braun, Monika (2006). Titel. In: Der Ingenieur 22, S. 234-278.
— Ziller, Thomas (2005a). Titel. Untertitel; Erscheinungsort, Verlag.
— Webadressen nur von Online-Publikationen!
— Beispiel:
Er sagte: „Was für ein Durcheinander der Zeichen, wenn der Satz
mit direkter Rede und Fussnote endet.“1Mikrotypografie 1 – DIN 5008
heiten,
Regelt die Schreibweise von Masszahlen und Massein
Währungen, Abkürzungen, Zwischenräumen, Satzzeichen
—Unterschied: Trenn-, Binde-, Gedankenstrich –
— Trennstriche macht Textverarbeitungsprogramm automatisch.
Zwei der drei Trennungen nacheinander sind die obere Grenze!
Die zulässige Anzahl lässt sich im Programm einstellen.
— 16–18 Uhr (bis) aber: FC Zürich – GC (gegen)
—Zahlen
— Gliederung: Dreierblöcke (Duden): 4 300 000, schöner 4 300 000
— Vierstellige Zahlen: 4000
— Stellen nach dem Punkt, vom Punkt ausgehend: 4 300.060 395
— Postleitzahlen nicht gliedern, Telefonnummern zweistellig gliedern
— ein- und zweisilbige Zahlen werden im Lauftext ausgeschriebenMikrotypografie 2 – DIN 5008
— Währungen
— sFr. (mit Punkt!), sfr (ohne Punkt!) oder CHF
— Die Währungseinheit kann vor oder nach gestellt werden.
„In Fließtexten ist zwar die letztgenannte Variante zu empfehlen
(250 EUR), da diese Schreibweise dem Lesefluss entspricht,
ansonsten bleibt die Entscheidung Ihnen überlassen“
(Duden-Newsletter: http://www.duden.de/deutsche_sprache/sprachberatung/newsletter/
archiv.php?id=61)
— Euro,Cent – Franken.Rappen: 19,90 €, 19.90 sFr.
— Währungen im Englischen: US$50, €4.50, falls das Euro-Zeichen
nicht zur Verfügung steht: EUR 4.50,
— richtig (deutscher Text) sind: — falsch (deutscher Text) sind:
— 400 Franken, 400 Fr. — Vierhundert Fr.
— € 59,– oder € 307,30 — 307.30 Euro
— 59 €
— Fr. 37.– oder sFr. 37.– — sFr 307.30 oder Fr. 37.-Mikrotypografie 3
— Masszahlen
— 123 456 N/cm2 (mit Leerschlag)
— 123 456 N/cm2 (schöner mit halbem Leerschlag)
— Zwischen Zahl und Mass: umbruchgeschütztes Leerzeichen
— falsch: 123‘456N/cm2
— Grad und Prozent: 37° (hingegen regelkonsistent: 37 °C)
— Prozentangaben: –0,3% (kein Leerschlag bei Minus und Prozent)
— Anführungszeichen
— deutsch: Herbert sagt: „Hallo!“ (99-66, unten-oben)
— englisch: Herbert says: “Hello!” (66-99, oben-oben)
— Apostroph (9, o) – ist nicht das gerade Zollzeichen (΄) – Tropfen
— Schrägstrich/Slash (ohne Leerzeichen gesetzt)Sie können auch lesen
