Technische Berichte schreiben - ETH Z...werden mit den Methoden M1, M2 und M3 gelöst. Das führt...

transcript

|Christian Schorno | cschorno@ethz.ch

Praxiskurs Produktentwicklung 2018 (Version 1)

Technische Berichte schreiben

Zielgruppen: Für wen schreiben Sie die Berichte eigentlich?

Struktur/Aufbau eines technischen Berichts: Wohin gehört der Überblick über den Stand der Forschung? –a) ins Vorwort, b) in die Einleitung, c) in ein separates Kapitel, d) in den Anhang?

Richtig zitieren: Fussnoten, eckige Klammern oder wie?

Mikrotypografie u. a. die Schreibweise von Masszahlen: Was ist richtig? – 9,3Nm/s, 9.3Nm/s, 9,3 Nm/s, 9.3 Nm/s

Vier Themen

|Christian Schorno | cschorno@ethz.ch 3

Zielgruppen

Management: Machbarkeit, monetäre Aspekte, Aufwand/Ertrag, strateg. Entwicklung, SWOT, wichtigste Argumente, GeschichtenTechnik: exakte Zeichnungen, richtige Berechnungen, Anforderungslisten, Stücklisten, Methoden, Lösungen, OptionenWissenschaft: Theorie, Methodik, Anbindung an Forschungkünftige Teams: «best practices», «lessons learned»

Verschiedene Zielgruppen

Management: Machbarkeit, monetäre Aspekte, Aufwand/Ertrag, strateg. Entwicklung, SWOT, wichtigste Argumente, GeschichtenTechnik: exakte Zeichnungen, richtige Berechnungen, Anforderungslisten, Stücklisten, Methoden, Lösungen, OptionenWissenschaft: Theorie, Methodik, Anbindung an Forschungkünftige Teams: «best practices», «lessons learned»

Verschiedene Zielgruppen

«best practices»:⇒ Bedienen Sie diese Bedürfnisse systematisch!⇒ Arbeiten Sie mit Verweisen aus der Einleitung in die Zielgruppen-relevanten Teile!

— Bücher/Berichte sind eine Kulturtechnik— ihre Gestaltung, Struktur und Form, sind durch

Standards/Normen geregelt— Verständlichkeits-Faktoren schaffen Orientierung, z.B.:

— Titelstruktur mit aussagekräftigen Titeln— Abstract— Zusammenfassung(en)— Illustrationen,denn Berichte werden nicht von vorn nach hinten gelesen, sondern selektiv.

zielgruppenunabhängig

Struktur

im Kern: Einleitung, Hauptteil, Zusammenfassung

Inhaltliche Struktur eines Dokuments

Inhalt, gegliedert & nummeriert1 Einleitung1.1 Projektziele 1.2 Team...2 Konzept...3 Design... 7 Zusammenfassung

Einleitung – Zusammenfassung

Aufmerksamkeitverengung

bei Leser/-inAufmerksamkeiterweiterungbei Leser/-in

Welt WeltEinleitung ZusammenfassungHauptteil

Einleitung – Zusammenfassung

Einleitung— erstes Kapitel des Dokuments— beschreibt Aufgabenstellung

und Ausgangssituation— Projektmanagement:

Ziele, Team-Organisation (Aufbau, Arbeitsabläufe), Kommunikations-Kanäle, Projektplan, Risikoanalyse

— erklärt gewählte Gliederung des Dokuments

Zusammenfassung— letztes Kapitel des Dokuments— fasst Resultate zusammen— Antwort auf Aufgabenstellung— Nutzen darlegen— Ausblick – was geschieht

damit und wie geht es weiter?— Empfehlungen an Stakeholder— Unsicherheiten erwähnen— Umwege sind «lessons

learned»

— Titel-/Deckblatt— Abstract— Vorwort (optional)— Inhaltsverzeichnis— Abkürzungen (optional)— Einleitung— Hauptteil— Zusammenfassung— Literaturverzeichnis— Anhang

Inhaltliche Struktur eines Dokuments

Titelei (römische Seitenzahlen)

Inhalt, gegliedert und nummeriert

Verzeichisteil und Anhang

Fehlerhafte Benummerung

Abschnittnummern und Überschriften je in einer vertikalen Fluchtlinie untereinander anordnen: 1 XXXXXXXXXXXXXXXXXXXXXXXX2 XXXXXXXXXXXXXXXXXXXXX2.1 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX2.2 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX3 XXXXXXXXXXXXXXXXXXXXXXXXXXXXX3.1 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX3.1.1 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX3.1.2 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX3.1.3 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Inhaltliche Struktur: Inhaltsverzeichnisse

DIN 1421 / ISO 2145: Gliederung und Benummerung in Texten

Abschnittnummern und Überschriften je in einer vertikalen Fluchtlinie untereinander anordnen: 1 XXXXXXXXXXXXXXXXXXXXXXXX2 XXXXXXXXXXXXXXXXXXXXX2.1 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX2.2 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX3 XXXXXXXXXXXXXXXXXXXXXXXXXXXXX3.1 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX3.1.1 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX3.1.2 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX3.1.3 XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

Inhaltliche Struktur: Inhaltsverzeichnisse

«best practice»: maximal drei Hierarchiestufen:also nicht 3.2.1.2

— Abschnitt— Textteil, entstanden durch Gliederung— gekennzeichnet durch Abschnittnummer und Überschrift— Zählnummer 0 (2.0) als Präambel/Vorbemerkung möglich— Abschnittnummer und Überschrift typografisch hervorheben

— Absatz— Textteil, entstanden durch Gliederung eines Abschnitts— «best practice»: Titel hervorgehoben ohne Nummerierung

— Aufzählungen, Listen— Textteil, vorwiegend durch Gliederung entstanden und durch

Ordnungszahlen (1.), Buchstaben mit Klammer (a)) oder Bindestrich („n-dash“, –) gekennzeichnet

Gliederung, Benummerung in Texten – DIN 1421

Gliederung von Texten [Absatztitel, ohne Nummerierung]Eine Gliederung kann den Text übersichtlicher machen und es erleich-tern, Informationen zu Teilaspekten schnell zu finden. Der Text wird dadurch in einzelne Sinnabschnitte eingeteilt, dabei steht eine klare Darstellung von Informationen in Absätzen im Vordergrund, z. B. in einem Vortrag, Referat oder in wissenschaftlichen Aufsätzen. [SInnabsatz – funktionale Definition]Bei wissenschaftlichen Texten ist eine Gliederung sehr gebräuchlich. Die oft tief gegliederten Examensarbeiten, Dissertationen und Habilitations- schriften haben strenge Formerfordernisse einzuhalten. Gute Gliede- rungen sind gekennzeichnet durch Logik der Gleich- bzw. Unterordnung aller Teile, durch Präzision der Überschriftenformulierungen sowie durch einheitlichen Überschriftenstil.[2] [SInnabsatz – Gliederung wissenschaftlicher Texte]

Absatz und Sinnabsatz

Gliederung von Texten [Absatztitel, ohne Nummerierung]Eine Gliederung kann den Text übersichtlicher machen und es erleich-tern, Informationen zu Teilaspekten schnell zu finden. Der Text wird dadurch in einzelne Sinnabschnitte eingeteilt, dabei steht eine klare Darstellung von Informationen in Absätzen im Vordergrund, z. B. in einem Vortrag, Referat oder in wissenschaftlichen Aufsätzen. [SInnabsatz – funktionale Definition]Bei wissenschaftlichen Texten ist eine Gliederung sehr gebräuchlich. Die oft tief gegliederten Examensarbeiten, Dissertationen und Habilitations- schriften haben strenge Formerfordernisse einzuhalten. Gute Gliede- rungen sind gekennzeichnet durch Logik der Gleich- bzw. Unterordnung aller Teile, durch Präzision der Überschriftenformulierungen sowie durch einheitlichen Überschriftenstil.[2] [SInnabsatz – Gliederung wissenschaftlicher Texte]

Absatz und Sinnabsatz

Jeder Sinnabsatz behandelt ein eigenständiges Thema. Das Thema kann mit einem Satz oder Stichwort wiedergegeben werden.Sinnabsätze haben mehr als einen Satz.

— Aussagekräftige Titel und Untertitel

— Projektgruppe (Namen), Nennung der Verantwortlichen

— Institution (gegebenenfalls mit Logo)

— Datum, Semesterbezeichnung— Grafik (optional) – wenn, dann

aussagekräftig!

Titelblatt

Abstract

— Die kürzest mögliche und rein sachliche Wiedergabe dessen, worum es im Bericht geht.

— Enthält:: Thema, wesentlichen Probleme, Ergebnisse, Ausblick: Was lässt sich mit dem Ergebnis anfangen?

— Umfang i.d. Regel eine bis drei Viertelseiten.— Abstracts können vom Bericht getrennt publiziert werden

(z.B. in Bibliografien) ⇒ enthalten deshalb keine Zitate, Verweise („In diesem Bericht ...“).

— Ist informativ nicht berichtend geschrieben!— Abstracts zeigen, für welche Fragestellungen und

Interessen der Bericht bzw. das Projekt relevant ist.

„Der (Projekt-)Bericht behandelt das Thema X im Feld F. 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.“— Eine bis drei exemplarische Problemstellungen nennen

und darstellen, wie diese Probleme gelöst wurden.— Das 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.

Formel für Abstract

In diesem Bericht wird die Arbeit des Teams XY präsentiert. Nach einer Vorstellung der Teamorganisation werden die Anforderungen aufgelistet.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 teammembers agreed on the most feasible and practical solution.

Stilfehler aus Abstracts

— Danksagungen— Bedeutung der Arbeit bzw.

des Projekts für Sie— Kommunikations-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.

Vorwort

— Fragestellung— Ausgangssituation— Stand der Technik/Forschung— Projektplan mit

— Projektzielen (Wie verhalten sich Ziele zueinander?)— Arbeitspaketen— Projektplan/Meilensteine— Team-Organisation, Kommunikationsplan— Finanzplan— Risikoanalyse und -management (optional)

Einleitung

— Kapiteleinteilung entsprechend Vorgehen im Projekt: 0 Einleitung1 Ideen/Konzept/Markt-Leistung, 2 Entwurf3 Realisierung4 Test5 Zusammenfassung

— innerhalb dieser Kapitel:— eher logische als historische Reihenfolge — Darstellung anhand des Musters «Problem-Lösung»— Jedes Kapitel genügt sich selbst, d. h. hat Einleitung am Anfang

und Zusammenfassung am Ende.24

Hauptteil

Wissen ist um so sicherer/informativer/wissenschaftlicher, je mehr Optionen Sie geprüft haben.— Wir haben X gemacht. – willkürlich, nicht informativ, unmethodisch— Wir standen vor der Entscheidung, X, Y oder Z zu machen. Wir

wählten X. – willkürlich, informativ, unmethodisch— Wir standen vor der Entscheidung, X, Y oder Z zu machen. Wir

wählten X, weil ... – begründet, informativ, unmethodisch— Wir standen vor der Entscheidung X, Y oder Z zu machen. Aus der

Literatur bieten sich hier die Methoden M und N an (bzw. die Theorien T und U). Nach M und U entscheidet man sich für x, weil … – begründet, informativ, methodisch

Wissen(schaftlichkeit) zum Ausdruck bringen

Hamburger Verständlichkeitskonzept— 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. AuflageSchulz v. Thun (2010, 48. Auflage): Miteinander reden 1: Störungen und Klärungen: Allgemeine Psychologie der Kommunikation

Text: Verständlichkeit

— 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 27

Anordung und Gestaltung der Information

— Subjekt (wer berichtet?): unpersönlich (man, Sache, Probleme als Subjekt) statt ich/wir, aber im Projektbericht ist «wir» möglich

— Zeit: Perfekt – Vergangenheit — überflüssige Wörter weg (Füllwörter, Adjektive!)— keine langen Sätze— verschachtelte Nebensätze vermeiden— Verneinung nicht am Satzende— Fremdwörter vermeiden

Text: Stilistik

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.

Text: Stilistik Beispiel Struktur

Studien über das Schreiben von Ingenieuren basieren z.T. auf sehr heterogenen Forschungsansätzen.

Studien über das Schreiben von Ingenieuren basieren auf sehr heterogenen Forschungsansätzen.

Studien über das Schreiben von Ingenieuren basieren auf heterogenen Forschungsansätzen.

Text: Stilistik Beispiel Kürze

weg mit Weichmachern und Füllwörtern!

— zentrale Berechnungen gehören in den Bericht, nebensächliche in den Anhang!

— einem Berechnungsgang geht Skizze mit den Grössen voraus!

— übersichtlich und nachvollziehbar aufschreiben31

Berechnungen

— umfangreiche Tabellen— grosse Diagramme— Skizzen— Technische Zeichnungen— Patente— längere mathematische Herleitungen,

Berechnungsgänge— Datenblätter

Anhang

— 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 Aufzählung 3— s. Abschn. 3.2 Abs. a Aufz. 3— siehe Bild ABC001— siehe Tabelle 5

— Verweise kommen ans Ende eines Satzes oder Abschnitts in Klammer vor dem Punkt (siehe 3.4.6).

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 Aufzählung 3— s. Abschn. 3.2 Abs. a Aufz. 3— siehe Bild ABC001— siehe Tabelle 5

— Verweise kommen ans Ende eines Satzes oder Abschnitts in Klammer vor dem Punkt (siehe 3.4.6).

Verweise

Quelle: DIN 1421 – Gliederung und Benummerung in Texten

Richtig Zitieren

— Jede fremde Autorleistung muss als solche gekenn-zeichnet werden.

— Ein Zitat ist die aus-schnittweise Wiedergabe aus einem anderen Werk.

— Aus einem Text kann man zitieren. Ein Bild kann nicht zitiert, nur als ganzes Werk wiedergegeben werden. — kein Problem für Ihre nicht publizierten Berichte: Versehen Sie

jedes Bild aus dem Web, aus Herstellerkatalogen, aus Büchern mit einer Quellenangabe. Ausnahme: Logos.

— Der Umgang mit Quellen ist eine Frage der wissenschaftlichen Arbeitsweise und der Gewöhnung.

Umgang mit Quellen

— Grundsätzlich gibt es verschiedene Systeme. Kein Grund für ein Sektierertum! Verwenden Sie das System, das am Institut oder vom Organ verlangt wird.

— Ein guter Überblick über die Systeme gibt der Quick Guide des Chicago Manual of Style: http://www.chicagomanualofstyle.org/ (18.11.15)

— Dieser unterscheidet zwei grundsätzliche Zitier-Arten:1. die geisteswissenschaftliche: Fussnote und Bibliografie

(«notes and bibliography style»)2. die naturwissenschaftliche/technische: Angabe im Lauftext

[Autor 2012, 34] («author-date system»)37

Im Dickicht der Zitierstile – eine Systematik

— Komponente 1: Fussnotennummer22 im Text— Wofür? – Für Quellenangaben, für Kommentare, für Exkurse ...— Wo? – Am Zitat-/Satzende nach dem Punkt und

Abführungszeichen, beim entscheidenden Begriff. — Warum? – Um Text zu entlasten, ihn schneller lesbar zu machen.

— Komponente 2: die Fussnote— unten auf der Seite – 2 pt kleiner als Laufschrift— Quelle auf notwendige Essenz verkürzt (Auffindbarkeit als

Kriterium): Autor, Jahr, Seite— Komponente 3: Bibliografie

— komplette Literaturangaben alphabetisch nach Autor geordnet, — Webadressen nur von Online-Publikationen!

Fussnoten und Bibliografie

— Fussnotenzeichen— Er sagte: „Was für ein Zeichen-Durcheinander, wenn der Satz

mit direkter Rede und Fussnote endet.“1

— Fussnoten— Exkurs: «Das Team ist zuerst auf folgenden Irrweg geraten: ...»— Quellenangabe mit oder ohne Kommentar:

Autor (Jahr), S. 23. Die Beobachtung XY des Autors war für eine wichtige Erfahrung für ...

— Link: http://www.siemens.de (Datum).— Bibliografie

— Braun, Monika (2006). Titel. In: Der Ingenieur 22, S. 234–278.— Ziller, Thomas (2005a). Titel. Untertitel; Erscheinungsort,

Verlag. 39

Beispiele von Fussnoten und Bibliografie

— Fussnotenzeichen und Fussnote\footnote{Text der Fussnote}

— Bibliografie wenig Quellen\begin{thebibliography}

\bibitem ... \bibitem ...

\end{thebibliography}— Bibliografie mit vielen Quellen ⇒ Verwenden von BibTeX

siehe z. B.: https://eden.one/bibliographien-mit-latex (18.11.18)

Fussnoten und Bibliografie in LaTeX

Mikrotypografie

Die Norm regelt die Schreibweise von Masszahlen und Masseinheiten, Währungen, Abkürzungen, Zwischenräumen und Satzzeichen.

Empfohlene online Referenz: din-5008-richtlinien.de

Mikrotypografie – DIN 5008

— Gliederung in Dreierblöcke (nicht bei vier Stellen): 43 300 000 aber 4000 – im Englischen 43,300,00/4,000

— schmale Leerzeichen sind typografisch schönervergleichen Sie: 4 300 000 – 4 300 000 (⇨ Wikipedia)

— Leerzeichen müssen umbruchgeschützt seinLaTeX: «Ein Beispiel sieht z.\,B.\ so aus.»

— in der CH Punkt oder Komma, in D Komma: 4.3 bzw. 4,3im Englischen Punkt (Komma für Gliederung benutzt)

— Stellen nach dem Punkt, vom Punkt ausgehend gliedern: 43 300.060 395

— ein- und zweisilbige Zahlen im Lauftext ausschreiben— ⇨ Wikipedia 43

Mikrotypografie 1 – Zahlen DIN 1333 und

— 123 456 N/cm2 (mit Leerschlag)— 123 456 N/cm2 (schöner mit halbem Leerschlag)— zwischen Zahl und Mass: umbruchgeschütztes Leerzeichen— Englisch: 123’456 N/cm2

— Grad und Prozent: 37° (hingegen regelkonsistent: 37 °C)— Prozentzahlen: 0,37% (ohne Leerschlag)— negative Zahlen: –0,37 N/cm2 (Minus ohne Leerschlag)

Mikrotypografie 2 – Zahl + Mass = Masszahlen

— 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)

— Euro,Cent – Franken.Rappen: 19,90 €, 19.90 sFr.— im Englischen: US$50, €4.50, 1,054.30

Mikrotypografie 3 – Währungen DIN 5008

— 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.

— Bindestriche für Worverbindungen: Mehrzweck-Maschinespeziell mit Fremdwortkomponente: Shopping-Center

— Gedankenstrich unterbricht Syntax: «Plötzlich – ein gellender Aufschrei!» «Das Bild – sein bekanntestes – wurde verkauft.»

— 16–18 Uhr (bis) aber: FC Zürich – GC (gegen)— Englisch: «My son—the teacher—would like to meet you.»

— Schrägstrich/Slash— Mitarbeiter/-innen (de und en ohne Leerzeichen)

Mikrotypografie 4 – Striche

— Anführungszeichen— deutsch: Herbert sagt: „Hallo!“ (99-66, unten-oben)— englisch: Herbert says: “Hello!” (66-99, oben-oben)

— Apostroph – ΄ (9, oben)ist nicht das gerade Zollzeichen – ‘ (Tropfen)

Mikrotypografie 5 – Anführungszeichen etc.

Tools & Literatur

Overleaf – Online LaTeX Editor

⇒ Overleaf

Quelltext nach dem Arbeiten lokal sichern!

Overleaf – Online LaTeX Editor

Dokument

Linda Spencer: «Writing Well in the 21st Century. The Five Essentials». Lanham 2014.Purdue University: Online Writing Lab. Online Nachschlegewerk (seit 1994).Christoph Prevezanos: «Technisches Schreiben für Informatiker, Akademiker, Techniker und den Berufsalltag». München 2013.Lutz Hering, Klaus-Geert Heyne, Heike Hering: «Technische Berichte: Verständlich gliedern, gut gestalten, überzeugend vortragen». Wiesbaden, 2009.Institut für Raum- und Landschaftsentwicklung IRL der ETH: «Verfassen technisch-wissenschaftlicher Berichte». PDF, Online, undatiert (2002 oder später).

Literatur zum Thema

Technische Berichte schreiben - ETH Z...werden mit den Methoden M1, M2 und M3 gelöst. Das führt...

Documents