
Berner Fachhochschule
Hochschule für Technik und Informatik
Berichte
schreiben
Inhalt
1 RICHTLINIE
TECHNISCHER BERICHT
1.1 EINFÜHRUNG BERICHTE SCHREIBEN
1.1.1 Verschiedene Formen der Berichte
1.1.2 Das unterschiedliche Zielpublikum
1.1.3 Voraussetzungen und weiteres Vorgehen
1.3.1 Gliederung eines Berichtes
1.4.2 Literaturverzeichnis, Quellenangaben
1.4.3 Beispiele zu Abstract und
Zusammenfassung
Kurt Steudler
lic. rer. pol. / dipl. El. Ing FH
EKT und NMG
In einer arbeitsteiligen Wirtschaft ist der Ingenieur immer wieder gefordert, technische und wissenschaftliche Berichte zu schreiben.
Der Bericht dient dazu, die Ergebnisse der eigenen Arbeit vor einem weiten Publikum auszubreiten.
Oft hängen weitere Beschäftigung und Beförderung von dieser Selbstdarstellung ab. Es versteht sich daraus von selbst, dass für das Schreiben von Berichten genügend Zeit und Sorgfalt aufzuwenden ist.
Der schreibende Ingenieur wird sich vor allem mit Messprotokollen und Messberichten, den eigentlichen technischen Berichten (Projekt- und Diplomarbeiten), Systembeschreibungen, Bedienungsanleitungen und anderen Publikationen zu beschäftigen haben.
Weitere Formen können sein: Protokolle, Referate, Seminararbeiten, Aufsätze, Rezensionen, Beiträge zu Sammelwerken.
Der vorliegende Aufsatz befasst sich mit dem technischen Bericht.
|
|
Messprotokolle Messberichte |
Technischer
Bericht Kurzbericht |
Publikationen |
|
Richten sich
hierarchisch an |
Unmittelbar vorgesetzte
Stellen |
Vorgesetzte
Stellen. Geschäfts- und Konzernleitungen. |
Fachzeitschriften, Zeitungen,
Bücher |
|
Richten sich
inhaltlich an |
Fachpersonen |
Fachpersonen und
technisch interessierte Laien |
technisch interessierte
Laien |
|
Zweck |
Archivierung |
Grundlage zu
einer Entscheidfindung |
Marketing |
|
Sprache |
technisch -
wissenschaftlich |
technisch -
wissenschaftlich |
für Laien;
technisch korrekt |
|
Struktur |
einfach,
vollständig und korrekt |
wird beschrieben |
angemessen |
Auf das unterschiedliche Zielpublikum ist mit der gewählten Sprache und einer geeigneten Struktur Rücksicht zu nehmen. Besonders hohe Anforderungen stellt der Technische Bericht.
Das Übermitteln von Informationen weist zwei Phasen auf. Zunächst wird die Information vom Autor zu Papier gebracht. Später nehmen andere Menschen die Information vom Papier auf.
Beide Phasen können Mängel aufweisen. Im Zentrum steht immer der Leser. Der fachlich kompetente Autor macht sich ein Bild von seinem Leser und spricht diesen technisch und sprachlich optimal an.
Werden die
Früchte der geleisteten Arbeit nicht oder ungenügend wahrgenommen, ist nie der Leser das Problem, sondern der
Schreiber.
Einfache und klare Sätze in der Gegenwartsform lassen technische Inhalte lebendig erscheinen.
Das Vorbereiten und Abfassen eines Berichtes benötigt immer mehr Zeit, als gemeinhin angenommen wird. Es ist geeignet, 10% bis 25% der gesamten Projektzeit für das Schreiben des Berichtes vorzusehen.
Das Schreiben eines Berichtes oder eines Kurzberichtes beginnt mit der Arbeit (Diplomarbeit, Projektarbeit, Praktikumsversuch). Ein sauberes Konzept und erste Vorstellungen über die Struktur des Berichtes helfen, alle wichtigen Unterlagen zu sammeln und zu ordnen. Wesentliche Teile eines Berichtes lassen sich bereits im Verlauf der Arbeiten erstellen. Einen unabdingbaren Beitrag leistet dabei das Laborheft.
Auf das Laborheft und den Bericht wird in den folgenden Kapiteln näher eingegangen.
Das Laborheft stellt das „Technische Tagebuch“ während der Arbeit (Diplomarbeit, Projektarbeit, Praktikumsversuch) dar. Das Laborheft gilt als tägliches Arbeitsmittel und enthält alle Notizen und direkten Eintragungen, die mit der laufenden Arbeit anfallen.
Das Laborheft enthält keine Reinschriften durch Abschreiben von Sudelblättern und dergleichen, sondern unmittelbar eigenhändig geschriebenen Text. Zudem ist das Laborheft ein gebundenes Heft (kein Schnellhefter, keine losen Blätter).
Die Qualität des Laborheftes misst sich an zwei Kriterien:
· Einem Arbeitskollegen oder Kommilitonen muss es gelingen, die bereits geleistete Arbeit ohne Fremdhilfe vollständig nachzuvollziehen (Versuchsaufbauten mit den gleichen Geräten und gleichen Resultaten) und
· es muss Ihnen gelingen den Bericht aufgrund der Angaben im Laborheft zu verfassen.
Soweit während der Arbeiten lose Blätter anfallen (Kopien von Datenblättern, Listings, Fotos, Diagramme, Kopien aus Büchern), werden diese in das Laborheft geklebt.
Lose Blätter, die später dem Bericht beigegeben werden, können in einem Projektordner abgelegt sein. Bei grösseren Arbeiten (Projekt- und Diplomarbeiten) ist es sinnvoll, parallel zum Laborheft einen Projektordner zu führen (Schnellhefter mit Register).
· Das Laborheft zeichnet die Ereignisse chronologisch auf. Die Eintragungen sind mit dem Datum und u.U. der Zeit versehen.
· Der Projektordner ist mit einem Register nach Themen strukturiert. Die Struktur richtet sich nach der Problemstellung. Der Projektordner ergänzt das Laborheft und erleichtert es, einen guten technischen Bericht zu schreiben.
Arbeiten, die auf dem Personal Computer erledigt werden, sind zu sichern (Disketten, Streamer, CD-R). Sicherungsdisketten sind Bestandteil des Laborheftes und dort in einem eingeklebten Couvert aufzufinden. In einem Netzwerk gelten die Arbeiten als gesichert, wenn sie nicht lokal abgelegt sind. Hinweise auf diese Ablagen finden sich im Laborheft und im Projektordner.
Der Bericht ist eine sorgfältig überarbeitete Reinschrift. Er stellt die geleistete Arbeit umfassend dar. Der Bericht weist eine interne und eine externe Stossrichtung auf.
Innerhalb einer Unternehmung, eines Konzerns dient der Bericht der Entscheidfindung. So gesehen können Ihre Anstellung, Ihre Beförderung von Ihrem Bericht abhängen.
Weiter kann der Bericht als Grundlage für eine Veröffentlichung in einer einschlägigen Zeitschrift dienen.
Der Bericht soll in Form, Darstellung und technischem
Gehalt ein den genannten Bestimmungen entsprechendes hohes Niveau aufweisen.
Ein Bericht besteht einerseits aus Teilen, die zwingend und teilweise in einer bestimmten Form vorhanden sein müssen und andererseits aus Teilen, deren Gestaltung vom Thema abhängt.
Ein Bericht besteht aus drei Teilen, nämlich dem einführenden Teil, dem Hauptteil und einem Schlussteil. Die drei Teile werden nacheinander besprochen. Je nach Umfang kann dem Bericht ein Anhang mitgegeben werden.
Der einführende Teil besteht aus Titelblatt, Zusammenfassung für die Geschäftsleitung, Inhaltsverzeichnis, technische Zusammenfassung und Einleitung zum Thema.
· Das Titelblatt ist eine eigene, erste Seite. Es enthält
Titel (und eventuell Untertitel) [3]
Blockhafte Zusammenfassung von ein bis drei Sätzen (Abstract) [4]
Autor (Autoren), Datum
Schule, Institut, Unternehmung
· Die Zusammenfassung für die Geschäftsleitung beschreibt über eine bis drei Seiten die geleistete Arbeit.
Geschildert werden die Problemstellung, die Überlegungen, die Resultate und die Empfehlungen in einer Sprache, die auch ein Ökonom versteht.
Auf Fachbegriffe wird verzichtet; trotzdem bleibt der Inhalt technisch korrekt.
· Das Inhaltsverzeichnis deckt die gute Struktur des Berichtes auf. Üblicherweise wird die Dezimalklassifikation verwendet.
Im allgemeinen dürften weniger als neun Kapitel und Unterteilungen von drei bis vier Stufen ausreichen. Jede Unterteilung enthält mindestens zwei Unterkapitel.
· Symbolverzeichnis, Quellenangaben und Literaturverzeichnis lassen sich hier oder im Schlussteil unterbringen.
· Die Einleitung zum Thema enthält
Einführung zum Thema.
Darstellung des Auftrages, der Aufgabe. Pflichtenheft.
Ausgangslage und Voraussetzungen.
Das Vorgehen (Konzept) mit
Problemanalyse, theoretischen Betrachtungen und Lösungskonzept:
Darstellung verschiedener Lösungsvarianten
Gegenüberstellung, Beurteilung, Machbarkeit
Wahl, Begründung
Zeitliche Planung
Beschreibung der verwendeten Aufbauten und Apparaturen. Angaben über die verwendeten Softwarewerkzeuge. Die geleistete Arbeit muss für Dritte nachvollziehbar sein.
Der Hauptteil beschreibt die eigentliche Arbeit. Gliederung und Inhalt ergeben sich von Fall zu Fall aus dem zu bearbeiteten Problem. Motto: „Beherrsche die Sache, dann folgen die Worte“.
Die Gliederung soll problemorientiert erfolgen und nicht Arbeitsgänge chronologisch aufzählen. Theoretische, messtechnische und praktische Arbeiten unterscheiden sich wesentlich in der Gliederung des Hauptteiles.
Allgemeine Hinweise:
· Darstellungen aller Art (Kurven, Fotos, Plots, Tabellen, Diagramme) sind treffend zu kommentieren. Denken Sie bitte an Achsbeschriftungen, Legende, Angabe der Variablen, Massstab, Parameter.
· Bei nichttheoretischen Arbeiten lassen sich umfangreiche Herleitungen auch im Anhang unterbringen.
· Tabellen, Diagramme und Grafen sollen den Hauptteil bereichern und nicht überladen. Umfangreiche Bildersammlungen sollen dem Anhang anvertraut werden.
· Messschaltungen sollen angegeben und vollständig beschrieben sein.
Der Schlussteil besteht aus Interpretation, Diskussion und Schlussbetrachtung.
Interpretation und Diskussion:
· Vergleich gemessener Resultate mit der Theorie. Vergleich mit anderen Arbeiten.
· Fehlerbetrachtung, Regressionsanalyse, Statistik.
· Diskussion von Fehlern und Abweichungen. Behauptungen müssen begründet sein.
· Kritische Beurteilung der geleisteten Arbeit bezüglich
Aufgabe, Versuchsanordnungen, Messmethoden, Vorgehen, Pflichtenheft.
Schlussbetrachtung
· Zusammenfassung der gefundenen Resultate und Interpretationen.
· Schlussfolgerungen
Was ist erledigt, welche Punkte bleiben offen.
Vorschläge und Empfehlungen für das weitere Vorgehen.
· Ort, Datum und Unterschrift.
Die Zusammenfassung richtet sich an technisch geschulte Menschen (unmittelbar Vorgesetzte, Arbeitskolleginnen, Arbeitskollegen).
Geschildert werden die Resultate, Interpretationen und die Empfehlungen in einer knappen, sachlich - technischen Sprache,
Je nach Umfang des Anhanges lohnt es sich, dem Anhang ein Inhaltsverzeichnis voranzustellen. Der Anhang enthält
· Herleitungen und Berechnungen, die nicht unmittelbar zur Arbeit gehören.
· Messreihen, Programmlistings, Diagramm-Reihen.
· Betriebsanleitung, Inbetriebnahme, Installation, soweit nicht im Hauptteil.
· Wichtige Datenblätter (nicht von gängigen Elementen).
· Bestückungspläne, Stücklisten, Schemas, soweit nicht im Hauptteil.
Zwischen Anhang und Hauptteil müssen Beziehungen (gegenseitige Verweise) vorhanden sein, sonst macht ein Anhang keinen Sinn und kann weggelassen werden.
Der Bericht ist kein Tagebuch, das Erlebnisse während der Versuchsdurchführung festhält oder Mängel an Messgeräten und dergleichen auflistet.
Der Bericht präsentiert sachlich mathematisch und messtechnisch einwandfrei begründete Resultate.
Nicht in einen Bericht gehören:
· Sätze, die ohne Informationsverlust gestrichen werden können
· Sensationsmeldungen, Superlative, Banalitäten, unsachliche Kritik
· Erlebnisberichte
· Subjektive Beurteilungen (ausser sie gehören zur Problemstellung)
· Blätter, die nicht eingeordnet werden können
Einfache und klare Sätze in der Gegenwartsform lassen technische Inhalte lebendig erscheinen.
Für Literaturverzeichnisse wird folgende Darstellungsart benutzt:
Verfassername, Komma, Vorname(n), Doppelpunkt, Buchtitel, Punkt, Verlagsort, Doppelpunkt, Verlagsname, Komma, Auflage, Komma, Jahr, Komma, Seitenhinweise, Punkt. ISB-Nummer [6] Punkt.
Bei mehreren Autorennamen:
Verfassername, Komma, Vorname(n), Strichpunkt, Verfassername, Komma, Vorname(n) Doppelpunkt, Buchtitel, Punkt, Verlagsort, Doppelpunkt, Verlagsname, Komma, Auflage, Komma, Jahr, Komma, Seitenhinweise, Punkt. ISB-Nummer Punkt.
Beispiel:
[3] Zinke, O.; Brunswig, H.: Lehrbuch der Hochfrequenztechnik, Erster Band. Berlin, Heidelberg, New York, Tokyo: Springer, 3. neubearbeitete und erweiterte Auflage, 1986, S. 46-51. ISBN 3-540-15858-8 (englisch 0-387-15858-8).
Verfassername, Komma, Vorname(n), Doppelpunkt, Aufsatztitel, Punkt, Name der Zeitschrift, Bandnummer (fett), Jahreszahl in runden Klammern, Heftnummer, Komma, S. mit erster und letzter Seite des Aufsatzes, Punkt. (ev. ISSN-Nummer [7] Punkt).
Bei mehreren Autorennamen wie oben.
Beispiel:
[2] Kirtley
,J.: Imaging magnetic fields. Spectrum 33
(1996) H.12, S.40-48.
Normalerweise wird der Verweis auf die Literatur im Bericht mit einer fortlaufenden Nummer in eckigen Klammern angebracht.: [1], [5], [6, S.237].
Weitere Möglichkeiten: [8]
· um eine sinnvolle Gruppierung anzudeuten: [C2], [C3], [E5]
· direktere Bezeichnung der Literaturstelle: [zin46], [kirt40], [waid4]
Zusammenfassung auf
dem Titelblatt (Abstract):
Untersucht wird ein aktives Durchlassfilter bezüglich seiner
charakteristischen Werte im Hörbereich.
Das Zweitor wird formal und messtechnisch betrachtet.
Zusammenfassung
für die Geschäftsleitung:
Ein
aktives Zweitor mit Durchlasseigenschaft im Hörbereich, nämlich bei 1,15 Kilohertz,
ist bezüglich seiner charakteristischen Werte formal behandelt und ausgemessen.
Die
mit einem Operationsverstärker verwirklichte, elektronische Schaltung weist mit
Q=20 eine hohe Güte auf und verstärkt das gewünschte Signal zwanzig Mal. Die gegengekoppelte
Schaltung wird aus zwei Quellen mit je 12 Volt gespiesen.
Das
aktive Durchlassfilter erfüllt die geforderten Randbedingungen. Die Schaltung
liegt in einem Versuchsaufbau vor. Für eine Produktion in grösseren
Stückzahlen wird eine Weiterentwicklung in «Surface-Mounted»-Technik empfohlen.
Beispiel
zur Schlussbetrachtung:
Untersucht
ist ein aktives Durchlassfilter, das auf einer Gegenkopplungs-Schaltung mit dem
Operationsverstärker mA 741 beruht.
Ausgemessen
ist eine Mittenfrequenz von f0 = 1,15
kHz bei einer Güte von Q = 20 und einer Verstärkung von v = 26 dB. Das Filter
weist eine Eingangsimpedanz von ZIN ³
5 kW und eine Ausgangsimpedanz von ZOUT £ 100 W auf. Bei einer Speisung von ± 12 V
darf die Eingangsspannung ue = 500 mVpp nicht überschreiten.
Die
gemessenen Werte entsprechen weitgehend den formal gefundenen Werten. Die
mathematische Herleitung ergibt eine Güte von Q = 23 bei einer Verstärkung von
v = 30 dB.
Eine
ähnlich grosse Abweichung ergibt sich aus einer Simulation mit dem Programm
P-Spice.
Die
mathematische Herleitung und die Simulation zeigen, dass die innere Verstärkung
ausreicht, um die geforderten charakteristischen Werte zu erfüllen.
Die
Unterschiede zu den gemessenen Werten erklären sich aus den in der Versuchsschaltung
verwendeten realen Elementen mit einer Toleranz von ± 5% bei den Widerständen
und ± 20% bei den Kondensatoren.
Im
Hinblick auf eine Serienfertigung muss in der Weiterentwicklung auf die Bauteiletoleranz
geachtet werden. Zudem kann eine «worst-case»-Berechnung geeignet erscheinen.
Berichte schreiben ist auch für
erfahrene Ingenieure keine einfache Aufgabe. Ein Bericht kann nie perfekt sein.
Ein klarer Bericht, leicht lesbar und gut dargestellt, ist die beste Entschädigung
für die geleistete Arbeit.
Die Liste gibt an, welche Teile zwingend zu einem Bericht gehören.
· Das Titelblatt mit Titel (und eventuell Untertitel)
Blockhafte Zusammenfassung von ein bis drei Sätzen (Abstract)
Autor (Autoren), Datum, Schule, (Institut, Unternehmung)
· Die Zusammenfassung für die Geschäftsleitung
· Das Inhaltsverzeichnis
· Hier oder im Schlussteil: Symbolverzeichnis, Quellenangaben und Literaturverzeichnis
· Die Einleitung zum Thema mit
Einführung zum Thema, Darstellung des Auftrages, Ausgangslage, Voraussetzungen, Vorgehen (Konzept), Zeitliche Planung, Beschreibung der verwendeten Aufbauten und der Softwarewerkzeuge
· Der Hauptteil beschreibt die eigentliche Arbeit. Gliederung und Inhalt ergeben sich von Fall zu Fall aus dem zu bearbeiteten Problem. Motto: „Beherrsche die Sache, dann folgen die Worte“.
· Interpretation und Diskussion:
Vergleich gemessener Resultate mit der Theorie. Vergleich mit anderen Arbeiten.
Fehlerbetrachtung, Regressionsanalyse, Statistik.
Diskussion von Fehlern und Abweichungen. Behauptungen müssen begründet sein.
Kritische Beurteilung der geleisteten Arbeit bezüglich
Aufgabe, Versuchsanordnungen, Messmethoden, Vorgehen, Pflichtenheft.
· Schlussbetrachtung:
Zusammenfassung der gefundenen Resultate und Interpretationen.
Schlussfolgerungen
· Ort, Datum und Unterschrift.
Systembeschreibungen, Bedienungsanleitungen, Betriebsanleitungen, Handbücher, Programmbeschreibungen und so weiter.
[1] Die hier vorgestellte Vorgehensweise gilt allgemein. Mit wenigen Änderungen lässt sich die Richtlinie auch im gesellschaftswissenschaftlichen Bereich anwenden.
[2] Die vorgegebene Gliederung in drei Teile liegt immer vor. Innerhalb der einzelnen Teile sind die ergänzenden Vorschriften des Institutes, der Unternehmung zu beachten.
[3] Der Titel ist ein aussagekräftiger Blickfang. Genügt der Titel zur Umschreibung des Inhaltes nicht, kann ein Untertitel zugefügt werden.
[4] Das Abstract soll das Interesse des Lesers am Thema wecken.
[5] Die Angaben lassen sich auch erweitern. Verlagsort und Verlagsname können auch in umgekehrter Reihenfolge erscheinen.
[6] Internationale
Standard Buch Nummer (seit 1973). Die Nummer vereinfacht die Buchbestellung. (International Standard Book
Number).
[7] Internationale Nummer für Periodika. Sie findet sich in den ersten oder letzten Seiten der Zeitschrift, ist aber oft noch nicht vorhanden.
[8] Die Möglichkeiten kommen eher bei umfangreichen Arbeiten zum Tragen. Der direkten Bezeichnung der Literatur kann die Seitenzahl mitgegeben werden.