Hinweise für die Schriftform von Seminar- und Abschlussarbeiten

  • Die folgende Beschreibung ist meine persönliche Empfehlung für Arbeiten, welche ich bewerte.
  • Bewertungsmaßstäbe von Kollegen können unter Umständen abweichen.

Es empfiehlt sich folgende Aufteilung, wobei Kapitel 2 - 5 etwa gleich gewichtet sein sollten:

Titelblatt, Vortexte und Verzeichnisse
Titelblatt und Word-Vorlage
Eine Formatvorlage (für Masterarbeiten bei T1) finden Sie im T1 Formular Infocenter. Diese kann auch für andere schriftliche Arbeiten arbeiten angepasst werden.

Aus dem Titelblatt sollten folgende Informationen hervorgehen:

  • Titel (ggf. mit Untertitel),
  • Verfasser/-in mit Matrikelnummer,
  • Semester und Jahr der Erstellung,
  • Abgabedatum,
  • Erst- und Zweitprüfer,
  • Studiengang, Fakultät und Hochschule,
  • Art der Arbeit (z. B. Bachelor-/Masterarbeit)
ggf. Sperrvermerk
Ein geeigneter Text ist folgender:
Die vorliegende Bachelor Thesis mit dem Titel Titel unterliegt einem Sperrvermerk. Sie enthält zum Teil vertrauliche Informationen der Firma Name der Firma, die nicht für die Öffentlichkeit bestimmt sind. Die Arbeit darf weder als Ganzes noch in Auszügen Personen außerhalb des Prüfungs- und Evaluationsverfahrens zugänglich gemacht werden. Eine darüber hinausgehende Weitergabe oder Einsicht, sowie jegliche Veröffentlichung und Vervielfältigung benötigt die ausdrückliche schriftliche Genehmigung des Verfassers oder der Firma.



Dieser Sperrvermerk gilt bis zum Datum



Name des (Firmen)Betreuers

Namen des/der Studierenden

ggf. Danksagung / Widmung
eidesstattliche Erklärung
Ein geeigneter Text ist folgender:
Hiermit erkläre ich, dass die Arbeit selbstständig und ohne Benutzung anderer als der angegebenen Hilfsmittel angefertigt wurde. Die aus fremden Quellen direkt oder indirekt übernommenen Gedanken, sind als solche kenntlich gemacht. Die Arbeit wurde bisher keinem anderen Prüfungsamt in gleicher oder vergleichbarer Form vorgelegt und bisher auch nicht veröffentlicht.

Ort, den Datum



Namen des/der Studierenden

Abstract
  • Abstract in Deutsch und am besten auch in Englisch
  • Der Abstract sollte auf einer halben Seite (je Sprache), die Arbeit kurz umfassen.
  • Kurze Hinführung des Lesers, Umschreiben der zentrale Frage, skizzieren des Wegs und der Ergebnisse.
  • Im Gegensatz zur Zusammenfassung im letzten Kapitel (=Fazit), ist der Abstract kürzer und geht nicht tief auf die Ergebnisse ein. Insbesondere werden im Absract nicht die Kapitel explizit beschrieben, sondern es werden nur die zentralen Inhalte (Vorgehen, Ergebnisse) umrissen.
Verzeichnisse
  • Inhaltsverzeichnis
  • Abbildungsverzeichnis (kann auch vor dem Literaturverzeichnis stehen)
  • Tabellenverzeichnis (kann auch vor dem Literaturverzeichnis stehen)
  • ggf. Abkürzungsverzeichnis
  • Die Seitenzahlen von Vortext und Verzeichnissen werden römisch nummeriert.
1 Einleitung (ca. 5% des Textes, mindestens 2 Seiten)
Es empfiehlt sich die Einleitung erst zum Ende der schriftlichen Arbeit zu schreiben. Ansonsten ist nicht selten eine nochmalige Überarbeitung notwendig, wenn alle Daten und Ergebnisse der Arbeit vorliegen.
  • Hinführen zum Thema
  • Motivation (Warum ist das Lösen des Problems wichtig? Warum ist das interessant für den Leser?)
  • Aufstellen der zentralen Fragestellung. (Was ist das konkrete Problem?)
  • Zielsetzung:
    • Wie wird es angegangen?
    • Was wird gemacht? (= Übersicht über die - für den Leser - kommenden Kapitel)
  • Die Fragestellung kann in ein separates Kapitel geschrieben werden.
2 Grundlagen (ca. 15% des Textes)
Dieses und das kommende Kapitel kann bereits recht früh geschrieben werden. Das hilft auch sich frühzeitig in das Thema einzuarbeiten.
  • Welche Hintergründe und spezielles Fachwissen sind sinnvoll bzw. notwendig zu wissen?
  • Was würde ein Kommilitone im gleichen Semester noch nicht wissen, wenn dieser Ihre Arbeit nicht gemacht hätte?
  • Kann auch unterteilt werden z.B. in Hardware, Software
  • Sollte (mit dem nächsten Kapitel) auch die Grundlagen für die Analyse der Ergebnisse legen, soweit diese nicht trivial ist
3 Stand der Technik (ca. 15% des Textes)
Dieses und das vorherige Kapitel kann bereits recht früh geschrieben werden.
  • Welche Vorarbeiten und vergleichbaren Arbeiten gibt es?
  • Was wird anderswo gemacht? Warum ist das nicht ausreichend / anwendbar?
  • Ggf. ist es vorteilhaft Kapitel 2 und 3 zu einem gemeinsamen Kapitel mit max. 30 Seiten zusammenzufassen
4 Methodik / Konzept / Design / Aufbau des Experiments oder des betrachteten Systems (ca. 20% des Textes)
Es hilft dieses Kapitel wären der praktischen Arbeit mit Stichpunkten zu füttern. Sobald die finale Konzeption klar ist, kann das Kapitel feingranular ausgearbeitet werden.
  • Hierbei steht Ihre getane Arbeit im Vordergrund.
  • Es sollte auf die Methodik, oder Hardware/Software-Entwicklung eingegangen werden. Hierbei stehen folgende Fragen im Vordergrund:
    • Warum wurden bestimmt Entscheidungen getroffen?
    • Hätte es Alternativen gegeben?
5 Umsetzung / Implementierung / Test (ca. 20% des Textes)
  • Dieses Kapitel ist keine Dokumentation oder Tätigkeitsbeschreibung!
  • Beispiele der konkreten Umsetzung
  • Keine vollständigen Quelltexte abdrucken!
  • Wie kann die umgesetzte Arbeit bewertet / evaluiert / getestet werden?
6 Diskussion der Ergebnisse (ca. 5 ... 10% des Textes)
Dieses Kapitel kann auch ein Unterkapitel des vorherigen sein.
  • Welche Ergebnisse wurden erwartet?
  • Welche wurden gemessen / erkannt?
  • Diskutieren Sie die Zahlen / Ergebnisse!
  • Gab es Abweichungen? Wie lassen sich diese erklären?
7 Fazit / Resümee / Ausblick (2 ... 4 Seiten)
  • Dieses Kapitel sollte einem Leser, welcher die Kapitel vorher nicht gelesen hat, kurz (ca. 5% des Gesamtumfangs der Arbeit) einen Eindruck vermitteln, um was es geht und welche Ergebnisse erzielt wurden.
  • Im Gegensatz zum Abstract wird hier auch ausführlicher auf die Ergebnisse eingegangen.
  • Es hilft hier dem Leser Referenzen auf die vorherigen Kapitel einzufügen
  • Wichtig: es geht nicht um Ihr persönliches Fazit (also kein: „es konnten viele verschiedene Fähigkeiten des Studiums genutzt werden“), sondern um das ingenieurswissenschaftliche Fazit. Was hat ihre Arbeit ermögliche, was vorher so noch nicht da war? Wie konnte die zentrale Fragestellung beantwortet werden?
  • Zusätzlich können der Ausblick und Verbesserungsvorschläge enthalten sein.
Literaturverzeichnis
  • Das Literaturverzeichnis wird an das Ende der Arbeit gestellt
  • weitere Aspekte zum Literaturverzeichnis sind unter Zitierung und Quellen detailliert beschrieben
Anhang
  • Im Anhang sollten Dinge Einzug finden, die nicht unbedingt für das Verständnis notwendig, aber für den Leser interessant sind.
  • Beispiele dafür sind: CAD-Pläne, weiterführende Schaltpläne, ausführliche Tabellen
  • Der Anhang sollte ein eigenes Inhaltsverzeichnis haben
  • Die Anhänge sollten alphabetisch oder mit „Anhang“ bezeichnet werden. z.B. erste Anhangsseite mit Anhangsverzeichnis und anschließend „Anhang A: Schaltpläne des Gesamtsystems“, „Anhang B: Programmausschnitte“…

Gelegentlich kommt es vor, dass nach der Hälfte der Zeit nicht die Hälfte der geplanten Arbeit umgesetzt ist.
Hierzu lohnt sich Blick auf das „magische Dreieck des Projektmanagements“: Dies besagt, dass Kosten (und damit Mitarbeiteranzahl) , Zeit und Qualität (und damit Zielerreichung) miteinander verzahnt sind. Das bedeutet prinzipiell auch, dass in der Regel ein Mangel in einer Dimension durch ein Mehr in einer anderen Dimension kompensiert werden kann. Bei den studentischen Arbeiten ist nun aber die Mitarbeiteranzahl (einer) und die Zeitdauer (nach SPO) fest vorgegeben. Dies kann die anfängliche Zielerreichung unter Umständen erschweren.
Beachten Sie deswegen Folgendes für das Gesamtbild der Arbeit (Die Aussagen gelten für mich als Betreuer und kann bei anderen Professoren abweichen!):

  • Das Ziel wird zunächst zu Beginn mit dem Betreuer in der Firma und mit mir abgestimmt (nach der SPO von MR über die Projekt).
  • Das anfängliche „Arbeitsthema der Thesis“ kann sich im Laufe der Zeit ändern. Falls dies das Bild der Arbeit ändert, sollte dies mit beiden Betreuern abgeklärt werden.
    Beispiel:
    Eine Konzeption, Softwareumsetzung und Test war vorgesehen; für vollständige Test war keine Zeit mehr, da die Softwareumsetzung sich erweitert hatte.
  • Wichtig ist in jedem Fall: Die Arbeit soll einen vollständigen Eindruck machen. D.h. die Kapitel sollten nach Seitenzahlen ein gleichmäßiges Gewicht haben.
    zum vorherig genannten Beispiel:
    In diesem Fall kann es sinnvoll sein, kein sehr kurzes Kapitel „Test“ einzufügen, sondern dieses in die Implementierung einzubinden. Dann kann im Ausblick auf die notwendigen detaillierten Tests eingegangen werden. Ggf. sollte dann der Titel korrigiert (z.B. von „Entwicklung eines …“ zu „Konzeptionierung eines …“).
  • Weiterhin ist sinnvoll, dass ein roter Faden in der schriftlichen Arbeit sichtbar wird: Die Einleitung soll gut zur zentralen Fragestellung hinleiten, Grundlagen und Stand der Technik sollen die notwendigen Vorkenntnisse verdeutlichen, die Kapitel Konzept, Umsetzung und Ergebnisse sollten Schritt für Schritt zur konkreten Lösung führen.

Eine feste Vorgabe für die Länge der schriftlichen Arbeiten gibt es nicht.

  1. Beachten Sie aber, das die Arbeit von lesbarer Länge sein soll. Falls dies wegen der Tiefe des Themas schwierig erscheint, sollten die nicht alle Entwicklungen dargestellt, sondern nur beispielhaft auf die wichtigsten eingegangen werden.
  2. Andererseits soll das Thema soweit beschrieben werden, dass ein Kommilitone aus dem Abschlusssemester es verstehen kann. Das gibt das Niveau und Umfang für Grundlagen, Stand der Technik, sowie Konzept vor. Bitte versuchen Sie den geforderten Umfang darzustellen, um auch selbst Ihre Arbeit würdig zu präsentieren.
  3. Es sollte darauf geachtet werden, dass ein roter Faden ersichtlich ist: Es sollte z.B. vermieden werden spezielle Grundlagen im entsprechenden Kapitel zu erklären, wenn diese nicht für die nachfolgenden Kapitel und der zentralen Frage nicht relevant ist.
  4. Damit ergibt sich etwa folgender Bereich für die schriftlichen Arbeiten (ohne Anhang und Verzeichnisse):
    1. Laborarbeit: ca. 20..30 Seiten
    2. Seminararbeit: 30…40 Seiten
    3. Bachelor-/Masterarbeit: 50…80 Seiten
  5. Der Versuch eine gewünschte Seitenanzahl durch andere als inhaltliche Methoden zu erreichen, sollte vermieden werden. D.h. keine zu schmale oder breite Seitenränder (2..2,5cm sind ausreichend), keinen zu kleinen oder großen Zeilenabstand (1,5-zeilig ist gut), keine zu große oder kleine Schriftgröße (12 optimal).
  6. Bitte klären Sie mit mir rechtzeitig die weiteren Schritte, falls Sie von den Maßzahlen für den Umfang abweichen

Eine feste Vorgabe für die das Format der schriftlichen Arbeiten gibt es nicht. Aber diese sollte konsistent und leserlich sein. Folgende Empfehlung sollte eingehalten werden 1)

  1. Für den Fließtext empfiehlt sich die Schriftgröße 12 in Times New Roman oder Arial mit einem Zeilenabstand von 1,5. Die schriftfarbe sollte schwarz sein.
  2. Für das Textbild sollte die als Formatierung der Blocksatz gewählt werden. Es sollte die automatische Silbentrennung eingeschalten werden
  3. Für die Seitenränder sind zwei Möglichkeiten empfohlen: Für eine pdf-Dokument ist symmetrisch links/rechts 2,5 cm vorteilhaft. Alternativ kann auch die asymmetrische Variante für den Ausdruck genutzt werden, d.h. links/rechts 3,0/2,0 cm, auf den ungeraden Seiten. Bei den geraden Seiten sind dann die Seitenränder zu vertauschen. Oben sind 3 cm und unten 2,5 cm vorzusehen.
  4. Kopf-/Fußzeile werden auf den ersten beiden Seiten nicht angezeigt. Bei den Seiten mit Fließtext sollte der Titel des aktuellen Kapitel (ohne Nummerierung) in Kopfzeile angezeigt werden. Hierfür muss ggf. mit Abschnittswechseln und -umbrüchen gearbeitet werden, um verschiedene Überschriftstypen (z.B. Anhang) sauber in der Kopfzeile anzeigen zu können.
  5. Die Seitennummerierung für den Anfang des Dokuments (einschließlich der Verzeichnisse) ist römisch; die Nummerierung beginnt bei Seite 1 (Deckblatt). Im Hauptteil (ab der Einleitung) ist die Nummerierung arabisch, beginnend bei 1.
  6. Die Formatierung sollte nicht mit Zeilenvorschüben umgesetzt werden. Dafür gibt es Seitenumbrüche.
  7. Alle Überschriften sollten in schwarzer Schriftfarbe und fett in Cambria oder Calibri geschrieben werden.
    Es empfiehlt sich sechs Formatvorlagen für Überschriften anzulegen:
    1. drei Überschriften mit Nummerierung für den Hauptteil
      Mehr als drei nummerierte Überschriftsebenen, die im Inhaltsverzeichnis auftauchen sind nicht empfehlenswert.
      1. Überschrift auf Ebene 1 in Schriftgröße 16, mit 0,8 cm hängendem Einzug und einem Abstand von 6 Pt. vor bzw. 14 Pt. danach. Diese Überschriften sollten automatisch auf neuer Seite beginnen.
      2. Überschrift auf Ebene 2 in Schriftgröße 14, mit 1,0 cm hängendem Einzug und einem Abstand von 8 Pt. vor bzw. 8 Pt. danach.
      3. Überschrift auf Ebene 3 in Schriftgröße 13, mit 1,4 cm hängendem Einzug und einem Abstand von 6 Pt. vor bzw. 6 Pt. danach.
    2. zwei Überschriften auf Ebene 1 ohne Nummerierung
      1. eine, für die Kapitel welche dem Inhaltsverzeichnis liegen und dort somit nicht aufgeführt ist (z.B. Abstract).
      2. eine weitere, die im Inhaltsverzeichnis aufgeführt ist (z.B. für den Titel „Anhang“)
      3. beide haben ansonsten das gleiche Format, wie die anderen Überschriften auf Ebene 1.
    3. eine Überschrift mit Nummerierung für die Kapitel im Anhang. Diese sollten mit „A“ oder „Anhang“ beginnen, z.B. „Anhang 1“. Sie sollten auf Ebene 4 sein in Schriftgröße 12, mit 1,8 cm hängendem Einzug und einem Abstand von 4 Pt. vor bzw. 2 Pt. danach.
    4. Die Nummerierung sollte „1“, „1.1“, „1.1.1“ sein, d.h. Punkte werden nur zwischen den Zahlen geschrieben, nicht am Ende.
  8. Weitere Formatvorlagen
    1. Im Normalfall werden zusätzlich die Formatvorlagen „Inhaltsverzeichnisüberschrift“ und „Citavi Bibliography Heading“ gebraucht. Diese sollte wie Überschrift auf Ebene 1 formatiert und entsprechend im Inhaltverzeichnis berücksichtigt werden.
    2. Für die Beschriftung von Bildern sollte die Schriftgröße 10, Ausrichtung mittig, sowie ein Abstand von 0 Pt. vor bzw. 10 Pt. danach gewählt werden. Hierbei sollte das Wort „Abbildung “ der Nummerierung voranstehen. Entsprechendes sollte für Tabellen und Codings gewählt werden.
    3. Es empfielht sich für das Inhaltsverzeichnis folgende Formatvorlagen anzulegen:
      1. Für Überschriften auf Ebene 1: fette Schrift der Schriftgröße 12, mit einem Einzug links von 0 cm und rechts von 1 cm, sowie eiem Sondereinzug hängend 0,6 cm. Der Zeilenabstand sollte einfach und davor und danach 6 Pt. sein.
      2. Für Überschriften auf Ebene 2: Schrift der Schriftgröße 12, mit einem Einzug links von 0.6 cm und rechts von 1 cm, sowie eiem Sondereinzug hängend 0,8 cm. Der Zeilenabstand sollte 1,5-fach und davor und danach 0 Pt. sein.
      3. Für Überschriften auf Ebene 3: Schrift der Schriftgröße 12, mit einem Einzug links von 1.4 cm und rechts von 1 cm, sowie eiem Sondereinzug hängend 1,1 cm. Der Zeilenabstand sollte 1,5-fach und davor und danach 0 Pt. sein.
  9. Die hängenden Einzüge der Überschriften sind nur ein erster Richtwert. Kommt in der Nummerierung einer Ebene eine zweistellige Zahl vor, muss der Einzug ggf. entsprechend angepasst werden. Es sollte darauf geachtet werden, dass eingerückte, niedrigere Ebenen bündig mit dem Beginn des Texts darüber sind (siehe Formatvorlage).
  10. Das Trennzeichen zwischen Nummerierung und Beginn der Unter- bzw. Überschrift sollte ein Tabstopp sein. Dann wird die Überschrift korrekt eingerückt, wenn diese über mehrere Zeilen geht.

Es gibt keine Vorgabe für die Bindung. Persönlich ist für mich ein PDF ausreichend.

Falls Sie aber eine gebunden Form abgeben wollen, sind hier einige Infos dazu:

  • Ich habe schon einiges erhalten: sowohl Hard- als auch Softcover. Hardcover macht ein schöneres Bild im Regal. Da aber die meisten Arbeiten einer Geheimhaltung unterliegen, zählt das wohl vornehmlich für den Betreuer in der Firma. Das Hardcover ist merklich teurer im Vergleich zu den anderen Varianten.
  • Die Ringlochbindung wird eher selten verwendet. Diese hat aber auch einen gewissen Vorteil, da für eine Weiternutzung ein klassisches „Fotokopieren“ damit leichter möglich ist.

Schreiben Sie keine reine Projekt-/Produktdokumentation oder Anleitung :

  1. Eine Beschreibung des Projektplans, sowie des Projektverlaufs sind nicht Inhalt der schriftlichen Arbeit. Falls diese als wichtig erachtet werden, können sie im Anhang Platz finden.
  2. Versuchen Sie eine rein chronologische Darstellung zu vermeiden und bevorzugen Sie eine technisch geeignete Darstellung (z.B. EVA-Prinzip).
  3. Wenn ein einzelnes, zentrales Tool genutzt wurde: (Ingenieurs)wissenschaftlich ist es i.d.R. besser Grundlagen der Wert auf die Konzepte zu legen und die Umsetzung in Tools nur zu skizzieren. Eine reine Schritt-für-Schritt Erklärung eines Tools sollte für den Hauptteil vermieden werden, kann aber gut im Anhang beigefügt werden.
  4. Wenn Sie unsicher sind, wie Ihre Arbeit strukturiert werden soll, hilft der Vergleich mit vorhandenen (Abschluss)Arbeiten. Suchen Sie nach ähnlichen Arbeiten z.B. mit einem ähnlichen Suchstring wie: bachelorarbeit „Bluetooth low energy“ filetype:pdf
  5. Kein „ich“, „wir“, „mein“, „unser“: Bitte vermeiden Sie Selbstreferenz im Hauptteil der Arbeit. In der Einleitung („Im Kapitel 2. analysiere ich…“) oder bei der Zusammenfassung („ich habe abschießend die … betrachtet“) ist dies sparsam angewandt möglich. Es sollte auch vermieden werden, die Sachverhalte mit „man“ zu überspezifisch zu umschreiben (siehe Lessons Learned). Wie die Verwendung von „ich“ umgehen werden kann, finden Sie z.B. mit der Suche nach „Ich Form Bachelorarbeit“ oder bei diversen Universitäten.
  6. Beachten Sie, dass Argumente nachvollziehbar sein sollten.
  7. Abkürzungen
    1. Technische Abkürzungen sollten bei der ersten Verwendung ausgeschrieben und kurz erklärt werden, z.B. USB (engl. Universal Serial Bus).
    2. Falls der Begriff in einem kommenden Kapitel detaillierter beschrieben werden, ist eine Referenz auf das Kapitel sinnvoll.
    3. nicht-fachliche Abkürzungen, wie ggü. für gegenüber, sollten vermieden werden.

Nutzen Sie Tabellen, Diagramme und Bilder. Diese beleben die Arbeit und helfen bei der Vermittlung der schriftlichen Inhalte. Versuchen Sie die Arbeit so zu schreiben, dass ein Kommilitone diese verstehen könnte. Komplexe Sachverhalte sollten also erklärt werden (z.B. durch Beispiele, Vergleich, Diagramme, Bilder). Zudem werden häufig in der ingenieursmäßigen Arbeit Unterlagen zunächst durchgeblättert, bis zum relevanten Kapitel. Auch dabei bieten Diagramme und Bilder gute Anhaltspunkte.

  1. Jedes Diagramm, jedes Bild, jede Tabelle, jedes Code-Listing muss im Fließtext referenziert werden.
    1. Diese Referenzen sollten als Feld im Text eingefügt werden, nur so werden diese automatisch aktualisiert. Die Funktion ist in Word im Reiter „Referenzen“ unter Beschriftungen → Querverweis, zu finden. Die Option „Als Link einfügen“ macht diese später auch klickbar.
    2. Mit dieser Funktion können auch Querverweise auf den Anhang oder andere Kapitel referenziert werden.
  2. Bilder haben Bildunterschriften, Tabellen haben Tabellenüberschriften. Es empfiehlt sich hierfür eine Formatvorlage zu verwenden.
  3. Nutzen Sie in Diagrammen, Bildern und Tabellen Farben und Formen mit Bedacht. So hilft in Tabellen mit Gewichtungen und Vergleichen die Verwendung der Farben hellrot, hellgelb und hellgrün als Hintergrund für niedrige bis hohe Wertigkeiten. Optimal ist eine konsistente Nutzung von solchen Konventionen.
  4. Vermeiden Sie zu pixelige Bilder, zu kleine / zu große Schrift in Bildern (optimal ist etwas kleiner als die Schriftgröße im Fließtext), Bilder mit Mauszeigern, Rechtschreibkorrekturmarkern o.ä.
  5. Ggf. Strichstärke ist die in Diagrammen zu erhöhen, damit diese nachher als Print noch gut zu erkennen sind.
  6. Prüfen Sie ob das Diagramm / Bild das Wesentliche gut zu sehen ist, ansonsten ist es sinnvoll die Komponente zu vergrößern bzw. nur einen Ausschnitt davon zu nutzen. Ggf. kann eine Markierung (Rahmen, Schattierung o.ä.) helfen.
  7. Bei der Softwarevisualisierung bieten sich Funktionsflussdiagramme, UML-Klassen/Objektdiagramme oder Ablaufdiagramme an. Gut ist eine Beschreibung, wie die Funktionen/Module miteinander interagieren (also mit Darstellung der Schnittstellen). Ich empfehle (lange) Code-Ausschnitte zu vermeiden.
    Begründung: Da häufig Teile des Codes relevant sind, welche aber den Code-Kontext benötigen, ist man verleitet den Code-Kontext einzufügen. Dieser wiederum beinhaltet aber meist auch andere nicht relevante Passagen. Dies erzeugt beim Leser eine erhöhte „visual load“ beim Verständnisaufbau.
  8. Zitierte Bilder und Tabellen:
    1. Bilder und Tabellen können generell auch als Zitat eingefügt werden. Diese müssen dann als solches hervorgehoben werden.
    2. Bei längeren Tabellen oder komplexeren Bildern ist - wie beim Textzitat - zu beachten, ob eine eigene Gestaltung den Fokus besser eignet, um den Leser auf die wichtigen Bereiche zu leiten.
    3. Bei einfachen Bilder und Tabellen auf Englisch empfiehlt sich die eigene Überarbeitung mit entsprechendem Hinweis, z.B. „in Anlehnung an“ oder „Eigene Darstellung nach“.
    4. Komplexere Bilder oder z.B. Messkurven auf Englisch sollten übernommen werden. Es empfiehlt sich hierbei eine Beschreibung der englischen Achsen im Fließtext oder im Abbildungstext hinzuzufügen.
  1. Vermeiden Sie zu lange und zu viele Aufzählungen und Listen. Diese sind eher für Präsentationsslides geeignet. Optimal ist, wenn diese auf eine 1/2 bis 1 Seite passen und wenn nicht auf jeder zweiten Seite eine vorkommt.
  2. Halten Sie die Form bei Aufzählungen und Listen konsistent. Dies betrifft u.a. Groß-/Kleinschreibung am Satzanfang und die Ausformulierung der einzelnen Punkte (Halbsatz, Satz, substantivierte Verben, etc.)
  3. Bitte achten Sie bei Ihrer Arbeit auf ein einheitliches Schriftbild, Absätze und Textsatz.
    1. Absätze sollten eine ausgewogene Länge haben und sich durch ein zusammenhängendes Thema auszeichnen. Die Anzahl der ein- oder zweizeilige Absätze sollte gering gehalten werden. Zu lange Absätze erzeugen das Gefühl einer „Textwüste“ - hier empfiehlt sich eine Aufteilung in mehrere Absätze.

Berücksichtigen Sie die korrekte Zitierung.

  1. Verwenden Sie möglichst nur (ingenieurs)wissenschaftliche Quellen, also Lehrbücher, Datenblätter, etc. Digitale Wissensspeicher, wie Wikipedia können verwendet werden. Fragen Sie sich aber immer: „Warum ist gerade diese Referenz wichtig?“
  2. Vermeiden Sie direkte Zitate, insbesondere über mehrere Zeilen. Generell sollte man sich hier fragen: „Warum ist gerade diese Referenz als direktes Zitat wichtig?“
  3. Onlinequellen:
    1. Geben Sie bei Referenzen zu Onlinequellen an, wann Sie diese abgerufen haben. z.B. [Zugriff am 01.01.2020]
    2. Bei Onlinequellen bietet es sich an diese über die WaybackMachine dauerhaft abzuspeichern. So kann ein permanenter Link erstellt werden.
  4. Bei Literatur-Quellen wie Büchern und Magazinen sollte die Seite mit angegeben werden, z.B. als pp. 302-304.
  5. Für die Verwaltung und automatisch Generierung des Literaturverzeichnisses sollte ein Literaturverwaltungsprogramm wie Citavi verwendet verwenden. Für dieses steht eine Campus-Lizenz für Studierende zur Verfügung. Citavi kann komfortabel als Add-In in Word verwendet werden.
  6. Die Einträge im Literaturverzeichnis sind alphabetisch nach Autor zu sortieren.
  7. Aus Gründen der Performance ist es bei Word sinnvoll, die Referenzen im Text erst bei Fertigstellung des Dokuments als Links (Literaturangaben sind im PDF klickbar) zu deklarieren. Dies ist in den Einstellungen von Citavi möglich.
  1. Erstellen Sie kompakte Verzeichnisse (Inhalts- und Abbildungsverzeichnis, soweit notwendig auch Tabellen-, Formel-, Listing- oder Abkürzungsverzeichnis).
  2. Nutzen Sie die Möglichkeit die VErzeichnisse für Inhalt, Abbildungen und Tabellen automatisch erstellen zu lassen (mittels Formatvorlagen). Hierbei sollten die Eigenschaften des Verzeichnisses im Dokument so eingestellt werden, dass die Referenz als Hyperlinks eingefügt wird. Dann können in der fertigen PDF-Version die Einträge der Verzeichnisse angeklickt werden.
  3. Nutzen Sie für das Verzeichnis kurze, markante und unterscheidende Texte - also kein: Übersicht 1, Übersicht 2, oder Systemdarstellung (sofern dies die einzigen Worte wären).
  4. Vermeiden Sie aber auch lange Beschreibungen und Referenzen (z.B. [15] in Abbildung 2: Eingabeprinzip [15]) im Verzeichnis. Falls Sie Word nutzen, gibt es eine Methode, mit der nur ein Teil des Textes im Verzeichnis dargestellt werden kann.
  5. Speziell beim Inhaltsverzeichnis / Kapitelaufteilung
    1. Sätze und Fragen sind für Überschiften eher ungeeignet. Auch Verben sollten substantiviert werden: Statt „4.1 Elektronik entwickeln“ $\rightarrow$ „4.1 Elektronikentwicklung“
    2. Vermeiden Sie unausgewogene Kapitelaufteilung (z.B. 4.1, 4.2 und 4.3 nur eine Seite, aber 4.4 zehn Seiten)
    3. Bitte keine Unterkapitel einzeln stellen (z.B. 4.1 ohne 4.2, 4.3 …). Entweder mindestens zwei Unterkapitel, oder gar keine
    4. Auch nur einmalig verwendete Unter-Unter-Unterkapitel sind unpassend (z.B. 4.2.1.1 und 4.2.1.2 aber sonst in keinem anderen Kapitel so tiefe Unterkapitel).
  6. Für den Inhalt des Abkürzungsverzeichnis ist es auchreichend eine einfache Tabelle einzufügen.
  1. gewählte Sprache:
    1. Als allgemeine Sprache der schriftlichen Arbeiten ist Deutsch zu wählen. Etwaige Abweichungen sind mit den Betreuern durchzusprechen.
    2. Englischsprachige Fachwörter sollten beim ersten Erscheinen im Text mindestens in Klammern erklärt werden.
    3. Bei verschiedenen Feldern haben sich englische Fachwörter verfestigt (z.B. Server und Client). Diese sollten natürlich auch so verwendet werden.
      Ansonsten empfiehlt es sich die deutschen Fachwörter zu nutzen. Im Zweifelsfall hilft ein Blick in die Fachliteratur, ob ein Fachwort sich auf Englisch bereits eingebürgert hat.
    4. Ein englisches Abstract neben dem deutschen Abstract kann beigefügt werden.
  2. Sprache in Bildern und Tabellen:
    1. Bei Textinhalten in eigenen Bildern sollte so wie hier für Fließtext beschrieben vorgegangen werden
    2. Bei einfachen, referenzierten Bildern empfiehlt sich diese nachzuzeichnen
  3. Umgang mit Zahlen im Text:
    1. Es gibt keine festen Regularien für das Ausschreiben von Zahlen (mehr).
    2. Der Anhaltspunkt „alle Zahlen unter 13 werden als Wort ausgeschrieben“ ist sinnvoll.
    3. Ausnahmen:
      1. Als gezifferte Zahl: Kapitel- und Datumsangaben (Kapitel 5, 17. August),
      2. Als ausgeschriebene Zahl: runde Zahlen (zwanzig)
    4. Für weitere Details kann sich nach den Hinweisen unter Scribbr gehalten werden.
  4. Umsetzung im Text
    1. Bitte beachten Sie die deutsche Rechtschreibung und Grammatik:
      1. Substantive werden groß geschrieben: der Stecker, die relevanten Hochvoltkomponenten
      2. Nicht substantivierte Adverbien und Adjektive werden klein geschrieben: die relevanten Hochvoltkomponenten, allgemeine Sicherheit, der zweite Stecker
      3. Substantivierte Adverbien und Adjektive werden groß geschrieben: Im Allgemeinen, Zum Zweiten
      4. Alle Sätze haben ein Verb und je nach Satzform Hilfsverben.
    2. Zusammengesetzte Substantive
      1. Die Sprache Deutsch lebt von zusammengesetzten Substantiven, wie Produktivitätssteigerungsmerkmale. Empfohlen wird dies bei geläufigen Wörtern (z.B. Zeitersparnis, Platinenentwicklung) so zu verwenden.
      2. Bei Fachwörtern kann davon abgewichen werden. Hier wird ein Bindestrich empfohlen: z.B. Debugging-Hardware, Development-Modul
        Ansonsten läuft man in Gefahr doppeldeutige Sätze zu schreiben, Z.B.: Beim Wechsel von Spritzguss zu Druckguss ist zu beachten, dass das Gehäuse negativ günstig beeinflusst wird (hier war ein Gehäusenegativ gemeint, wobei der Fachbegriff Form wäre)
    3. Wortdopplungen und Konsistenz
      1. Es sollten für gleiche Dinge die gleichen Fachwörter verwendet werden, insbesondere sollte dieses auch gleich geschrieben werden (also z.B. nicht einmal Design-Thinking Prozess und einmal Design Thinking Prozess).
      2. Im Gegensatz dazu empfiehlt es sich beim Satzbau und anderen Wörtern etwas Abwechslung in den Text zu bringen. Also z.B. nicht: So wurde Blabla umgesetzt. So wurde dann mit der Umsetzung Blabla erreicht. So konnte dieser Teil an weitere angebunden werden. Es bietet sich beim wiederholten Lesen eine Suche und Umschreibung der häufigsten Standardwörter an (allerdings, allgemein, auch, aufgrund, außerdem, beispielsweise, bereits, beschreiben/beschrieben, bietet die Möglichkeit, da/damit/dabei, darstellen/dargestellt, dazu, deshalb, deutlich, dies/diese/dieser, dienen/dient, direkt, durch, durchführen/durchgeführt, ebenfalls, entsprechend, immer, im Zuge der/des, hier/hierbei/hiermit, nach/nachdem, neben, noch, nun, um, sowie/somit/sogar, verwenden, weiterhin, zunächst, zudem, zusätzlich).
    4. Vermeiden Sie zu lange und verschachtelte Sätze. Sätze über mehr als zwei Zeilen sind in der Regel nicht leicht erfassbar.
  1. Allgemein sollten Formeln, die weiterverwendet werden müssen, mit einer Referenz gekennzeichnet werden z.B. (1.1) oder (1-1) für die erste Formel in Kapitel 1.
  2. Alle neuen Variablen und Parameter sollten direkt bei der Formel im Fließtext beschrieben werden.
  3. Falls neue Formelzeichen angelegt werden müssen, sollte der Buchstabe mit bedacht gewählt werden. $C$ ist für Kontanten nicht immer die beste Wahl.
  4. In Word ist es sinnvoll Formel wie folgt in einer Tabelle einzufügen.
    studentische_arbeiten:formel.svg
    1. Die Tabellenränder sind dabei unsichtbar zu machen:
    2. Diese einmalig angelegte Tabelle kann am besten als Tabellenvorlage abspeichern.
    3. Es ist sinnvoll die Eigenschaften der Tabelle so einzustellen, dass kein Zeilenumbruch innerhalb der Tabelle stattfindet, Details dazu finden sich z.B. hier.
  5. Beachten Sie die Normen zur korrekten Schreibung von Formeln und physikalischen Größen. So werden unter anderem Formelzeichen werden kursiv dargestellt, Einheiten und Indizes normal.
KommentarSchlecht-BeispielGut-Beispiel
Fügen Sie Links und Verweise auf Quellen immer als Zitat/Referenzen ein.„Abbildung 1 Komponente blablub (
1. https://some-webpage-somewhere.com/images?q=tbn:lsdkfjero87w93jldkvo8ewur323u398vdjoi7u398u9wef8z
2. https://some-webpage-somewhere.com/images?q=tbn:sdklfjwoei23487dj4o8vu3lkjsoifjdf8v4lskdvjlkj4o8fdv98d
3. https://some-webpage-somewhere.com/images?q=tbn:sdc9u3jf8dfvusdjvoeriu8dvjsdfl4jif9ievuzsuvje4o9er8uv
4. https://some-webpage-somewhere.com/images?q=tbn:sdfu389udvworuer89vufo48uerjceo8w7udwrjfoivu89ez
)
„Abbildung 1 Komponente blablub [2]„
Vermeiden Sie Umgangssprache!1. „Dies wurde ein wenig getestet.“
2. „Bei der Wiederholung muss nachgeschaut werden, ob blablub. “
3. „Es wurde viel ausprobiert
4. “Zufällig wurde gefunden, dass blablub“
5. „Es muss nämlich …“
1. Die zweite Variante wurde im geringen Umfang getestet.
2. „Bei der Wiederholung muss überprüft werden, ob blablub.“
3. weglassen, oder mit Trial-and-Error umschreiben
4. weglassen
5. So muss …
Nutzen Sie passende Modalverben.
Ist die Tätigkeit zur Zielereichung notwendig?
1. „Zur Spannungsmessung kann das blablub angeschalten werden.“ 1. „Zur Spannungsmessung muss das blablub eingeschaltet sein.“
Vermeiden Sie zu persönliche und unsachliche Beschreibungen.1. „Hier waren aber meine Kenntnisse
in Sachen blablub
noch nicht ausreichend.“
2. „Ein Hinweis eines Kollegen ergab blablub“
3. „Die Entwicklung hat 4 Wochen gedauert
4. “Die bessere Software war zu teuer. Deswegen wurde trotzdem die alte Software verwendet
5. „Nach dem Start waren komische und ungesunde Geräusche zu hören.“
1. weg lassen
2. Ist diese Info auch in der Literatur verfügbar? --> Literaturstelle zitieren,
Wurde der Kollege über die Zitierung informiert?
--> Zitieren im Literaturverzeichnis als „Persönliches Gespräch mit Herrn Max Mustermann (ggf. bei der Veranstaltung Musterkonferenz), Musterstadt. [Eigenes Gesprächsprotokoll]“
3. weg lassen
4. weg lassen oder über „finanzielle Vorgaben/Randbedingungen“ umschreiben
5. über „ungewöhnliche Geräuschkulisse“ oder „akustisch auffällige Probleme“ umschreiben
Vermeiden Sie eine offensichtlich chronologische Darstellung der Fehler der Entwicklung. Stattdessen sind funktional aufeinander aufbauende Darstellungen empfohlen.1. „Das erste Programm war noch sehr unübersichtlich geschrieben und damit wartungsintensiv. Dieses wurde dann in mehrere Funktionen unterteilt. In „Stand der Technik“ die bisherige Version beschreiben. In folgenden Kapiteln die Verbesserungen beschreiben
Vermeiden Sie die Erklärung von Trivialitäten„Der Befehl for(int a=0; a<10;a++) ist der Beginn einer Schleife. Dabei ist der Integerwert a die Zählvariable, welche mit int a=0 deklariert und mit dem Wert 0 initialisiert wird.“
Vermeiden Sie „denglisch“, speziell Beugung englischer Wörter.1. „Es wurde ein Board designed.“
2. „Die Software wurde upgedatet.“
1. „Ein Boarddesign wurde entwickelt“ oder „Ein Platinenlayout wurde entwickelt“
2. „Die Software wurde aktualisiert“ oder „Das Softwareupdate wurde ausgeführt“
Vermeiden Sie mehrfache Verwendung von Wörtern, die keine Fachwörter sind 1. Als erstes wird <A> entwickelt. Als zweites wird <B> entwickelt.
2. Im Folgenden müssen die, die vorher …
3. Damit verbinden sich <Dummy1> und <Dummy2> und es ergibt sich <Dummy3>.
4. Der <Dummy1>, der in den <Dummy2> eingesetzt wird, der … empfängt. (Referenz auf Objekte unklar)
1. Die Komponenten <B> wird nach <A> entwickelt..
2. Im Folgenden müssen diejenigen, welche vorher
3.Entweder zwei separate Sätze bilden oder ein „und“ durch ein „sowie“ ersetzen
4. Zwei Sätze bilden: Der <Dummy1>, der in den <Dummy2> eingesetzt wird. <Dummy2> empfängt …
Vermeiden Sie unklare Begründungen für Entscheidungen 1. Wir haben uns geeinigt das Bauteil xxx zu nutzen. 1. Es wurde das Bauteil xxx genutzt, da dieses in Bezug auf das kompakte Raumangebot und die Kosten den besten Kompromiss dargestellt hat.
Vermeiden Sie überspezifische Umschreibung mit „man“ statt „ich“ 1. Man hat sich geeinigt das Bauteil xxx zu nutzen. 1. Es wurde das Bauteil xxx genutzt, da dieses in Bezug auf das kompakte Raumangebot und die Kosten den besten Kompromiss dargestellt hat.


Folgende Tabelle soll ausländischen Studenten helfen, die geeignete Sprache für einen wissenschaftlichen Text zu finden

Umgangssprache wissenschaftliche Umschreibung
ein wenig, etwas im geringen Umfang, gering, zum Teil, in gewissem Maße
nachschauen betrachten, überprüfen, suchen, analysieren
ausprobieren Versuch durchführen, testen
zufällig mittels Trial-and-Error
erstmal zunächst
drauf darauf,
auf dem …
nämlich indem, so, und zwar,
langweilig monoton, zeitintensiv
eher vielmehr
glücklicherweise … bietet Vorteile (für die Anwendung), ist geeignet

1)
Herzlichen Dank an Markus Krautter für diese Zusammenfassung