Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

Link zu dieser Vergleichsansicht

Beide Seiten der vorigen Revision Vorhergehende Überarbeitung
Nächste Überarbeitung 		Vorhergehende Überarbeitung
studentische_arbeiten:allgemeinen_hinweise_zur_schriftlichen_arbeiten [2022/03/02 11:21]
tfischer [Tabelle] 		studentische_arbeiten:allgemeinen_hinweise_zur_schriftlichen_arbeiten [2023/09/29 21:32] (aktuell)
mexleadmin
Zeile 1: Zeile 1:
-====== Allgemeine Hinweise zu schriftlichen Arbeiten ======+====== Hinweise für die Schriftform von Seminar- und Abschlussarbeiten ======
  
-===== 1. Aufteilung und Struktur =====+  * 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: +===== 1 Aufteilung und Struktur ===== 
 + 
 +Es empfiehlt sich folgende Aufteilung, wobei Kapitel 2 - 5 etwa gleich gewichtet sein sollten: 
 <WRAP> <WRAP>
 <WRAP right 92% column> <WRAP right 92% column>
Zeile 11: Zeile 14:
 --> Titelblatt und Word-Vorlage # --> Titelblatt und Word-Vorlage #
 Eine Formatvorlage (für Masterarbeiten bei T1) finden Sie im [[https://www.hs-heilbronn.de/14768395/formular-und-infocenter|T1 Formular Infocenter]]. Diese kann auch für andere schriftliche Arbeiten arbeiten angepasst werden. Eine Formatvorlage (für Masterarbeiten bei T1) finden Sie im [[https://www.hs-heilbronn.de/14768395/formular-und-infocenter|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)
 +
 <--  <-- 
  
Zeile 16: Zeile 29:
  
 Ein geeigneter Text ist folgender: Ein geeigneter Text ist folgender:
-<WRAP right round box>+<callout>
 Die vorliegende Bachelor Thesis enthält zum Teil vertrauliche Informationen, die nicht  Die vorliegende Bachelor Thesis enthält zum Teil vertrauliche Informationen, die nicht 
 für die Öffentlichkeit bestimmt sind. Der Inhalt darf daher nur mit der ausdrücklichen  für die Öffentlichkeit bestimmt sind. Der Inhalt darf daher nur mit der ausdrücklichen 
Zeile 24: Zeile 37:
 \\ \\ \\ \\ \\ \\
 ------------------- -------------------
-<wrap group> +<WRAP group> 
-<wrap half column><fc #FF0000>Name des (Firmen)Betreuers</fc></wrap> +<WRAP half column><fc #FF0000>Name des (Firmen)Betreuers</fc></WRAP> 
-<wrap half column><fc #FF0000>Namen des/der Studierenden</fc></wrap> +<WRAP half column><fc #FF0000>Namen des/der Studierenden</fc></WRAP>
-</wrap> +
 </WRAP> </WRAP>
 +
 +</callout>
  
 <--  <-- 
-  * ggf. Danksagung+ 
 +--> ggf. Danksagung / Widmung # 
 + 
 +<---
  
 --> eidesstattliche Erklärung # --> eidesstattliche Erklärung #
  
 Ein geeigneter Text ist folgender: Ein geeigneter Text ist folgender:
-<WRAP right round box>+<callout>
 Hiermit erkläre ich, dass die Bachelorarbeit selbstständig und ohne Benutzung  Hiermit erkläre ich, dass die Bachelorarbeit selbstständig und ohne Benutzung 
 anderer als der angegebenen Hilfsmittel angefertigt wurde.  anderer als der angegebenen Hilfsmittel angefertigt wurde. 
Zeile 48: Zeile 64:
 ------------------- -------------------
 <fc #FF0000>Namen des/der Studierenden</fc> <fc #FF0000>Namen des/der Studierenden</fc>
-</WRAP>+</callout>
  
 <--   <--  
-  * Abstract + 
 +--> Abstract # 
     * Abstract in Deutsch und am besten auch in Englisch     * Abstract in Deutsch und am besten auch in Englisch
     * Der Abstract sollte auf einer halben Seite (je Sprache), die Arbeit kurz umfassen.      * 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.      * 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. +    * 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, Tabellenverzeichnis, ggf. Abkürzungsverzeichnis \\ Diese Verzeichnisse können auch vor dem Literaturverzeichnis stehen. + 
-  * Die Seiten mit Vortext und Verzeichnissen werden römisch nummeriert.+<-- 
 + 
 +--> 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 #+--> 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   * Hinführen zum Thema
-  * Motivation (Warum ist das Lösen des Problems wichtig?) +  * Motivation (Warum ist das Lösen des Problems wichtig? Warum ist das interessant für den Leser?) 
-  * Aufstellen der zentralen Fragestellung.  +  * Aufstellen der zentralen Fragestellung. (Was ist das konkrete Problem?) 
-    * Was ist das konkrete Problem?+  * Zielsetzung:
     * Wie wird es angegangen?     * Wie wird es angegangen?
-    * Was wird gemacht?  +    * Was wird gemacht? (= Übersicht über die - für den Leser - kommenden Kapitel) 
-    * Die Fragestellung kann in ein separates Kapitel geschrieben werden. +  * Die Fragestellung kann in ein separates Kapitel geschrieben werden. 
  
 <--  <-- 
  
---> 2. Grundlagen # +--> 2 Grundlagen (ca. 15% des Textes) # 
-  * Welche Hintergründe sind sinnvoll und notwendig zu wissen?  + 
-  * Was würde ein Kommilitone, welcher nicht in Ihrem Betrieb arbeitet noch nicht wissen?  +Dieses und das kommende Kapitel kann bereits recht früh geschrieben werden. Das hilft auch sich frühzeitig in das Thema einzuarbeiten. 
-  * kann auch unterteilt werden in Hardware, Software+ 
 +  * 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   * 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 #+--> 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?   * Welche Vorarbeiten und vergleichbaren Arbeiten gibt es?
-  * Ggf. ist es vorteilhaft Kapitel 2. und 3. zusammenzufassen+  * 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. Konzept / Design / Aufbau des Experiments / des betrachteten Systems #+--> 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.    * Hierbei steht Ihre getane Arbeit im Vordergrund. 
-  * Es kann auf die Methodik, Hardware/Software-Entwicklung eingegangen werden+  * 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 #+--> 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 #+--> 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 / Resumé / Ausblick # +--> 7 Fazit / Resümee / Ausblick (2 ... 4 Seiten) # 
-  * Dieses Kapitel sollte einem Leser, welcher die Kapitel vorher nicht gelesen hat, über 2-4 Seiten (ca. 5% des Gesamtumfangs der Arbeit) einen Eindruck vermitteln, um was es geht und welche Ergebnisse erzielt wurden. +  * 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.   * Im Gegensatz zum Abstract wird hier auch ausführlicher auf die Ergebnisse eingegangen.
-  * 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?+  * 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.   * Zusätzlich können der Ausblick und Verbesserungsvorschläge enthalten sein.
  
Zeile 109: Zeile 166:
 --> Literaturverzeichnis # --> Literaturverzeichnis #
  
 +  * Das Literaturverzeichnis wird an das Ende der Arbeit gestellt 
 +  * weitere Aspekte zum Literaturverzeichnis sind unter [[allgemeinen_hinweise_zur_schriftlichen_arbeiten#zitierung_und_quellen|Zitierung und Quellen]] detailliert beschrieben
  
 <-- <--
Zeile 116: Zeile 174:
   * Im Anhang sollten Dinge Einzug finden, die nicht unbedingt für das Verständnis notwendig, aber für den Leser interessant sind.    * 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   * Beispiele dafür sind: CAD-Pläne, weiterführende Schaltpläne, ausführliche Tabellen
-  * Die Anhänge sollten alphabetisch bezeichnet werden (z.B. "A. Schaltpläne des Gesamtsystems"). +  * 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"... 
  
 <-- <--
Zeile 124: Zeile 183:
  
 ~~PAGEBREAK~~ ~~CLEARFIX~~ ~~PAGEBREAK~~ ~~CLEARFIX~~
-===== 2. Allgemeine Form der schriftlichen Arbeit =====+===== 2 Allgemeine Form der schriftlichen Arbeit =====
  
 ==== 2.1 Kapitelaufteilung und Thesisthema ==== ==== 2.1 Kapitelaufteilung und Thesisthema ====
Zeile 137: Zeile 196:
   - 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.   - 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.
   - 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.   - 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.
 +  - 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.
   - Damit ergibt sich etwa folgender Bereich für die schriftlichen Arbeiten (ohne Anhang und Verzeichnisse):   - Damit ergibt sich etwa folgender Bereich für die schriftlichen Arbeiten (ohne Anhang und Verzeichnisse):
     - Laborarbeit: ca. 20..30 Seiten      - Laborarbeit: ca. 20..30 Seiten 
     - Seminararbeit: 30...40 Seiten     - Seminararbeit: 30...40 Seiten
     - Bachelor-/Masterarbeit: 50...80 Seiten      - Bachelor-/Masterarbeit: 50...80 Seiten 
-  - 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,2 ... 1,5-zeilig ist gut), keine zu große oder kleine Schriftgröße (10..12 optimal).+  - 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). 
 +  - Bitte klären Sie mit mir rechtzeitig die weiteren Schritte, falls Sie von den Maßzahlen für den Umfang abweichen
  
-==== 2.3 Buchbindung ====+==== 2.3 Format ==== 
 + 
 +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 ((Herzlichen Dank an Markus Krautter für diese Zusammenfassung)) 
 + 
 +  - 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.  
 +  - Für das Textbild sollte die als Formatierung der **Blocksatz** gewählt werden. Es sollte die **automatische Silbentrennung** eingeschalten werden 
 +  - 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. 
 +  - **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.  
 +  - 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. 
 +  - Die Formatierung sollte nicht mit Zeilenvorschüben umgesetzt werden. Dafür gibt es Seitenumbrüche.  
 +  - Alle Überschriften sollten in **schwarzer Schriftfarbe und fett in Cambria oder Calibri** geschrieben werden. \\  Es empfiehlt sich sechs Formatvorlagen für Überschriften anzulegen:  
 +    - drei Überschriften mit Nummerierung für den Hauptteil \\ Mehr als drei nummerierte Überschriftsebenen, die im Inhaltsverzeichnis auftauchen sind nicht empfehlenswert. 
 +      - Ü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. 
 +      - Ü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.  
 +      - Ü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.  
 +    - zwei Überschriften auf Ebene 1 ohne Nummerierung 
 +      - eine, für die Kapitel welche dem Inhaltsverzeichnis liegen und dort somit nicht aufgeführt ist (z.B. Abstract).  
 +      - eine weitere, die im Inhaltsverzeichnis aufgeführt ist (z.B. für den Titel "Anhang")  
 +      - beide haben ansonsten das gleiche Format, wie die anderen Überschriften auf Ebene 1. 
 +    - 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.  
 +    - Die Nummerierung sollte "1", "1.1", "1.1.1" sein, d.h. Punkte werden nur zwischen den Zahlen geschrieben, nicht am Ende.  
 +  -  Weitere Formatvorlagen 
 +    - 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.  
 +    - 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. 
 +    - Es empfielht sich für das Inhaltsverzeichnis folgende Formatvorlagen anzulegen: 
 +      - 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.  
 +      - 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.  
 +      - 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.  
 +  - 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).  
 +  - 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. 
 + 
 +==== 2.4 Buchbindung ====
 Ebenso wenig gibt es eine Vorgabe für die Bindung. Persönlich ist für mich ein PDF ausreichend.  Ebenso wenig gibt es eine Vorgabe für die Bindung. Persönlich ist für mich ein PDF ausreichend. 
  
Zeile 155: Zeile 248:
  
 Schreiben Sie **keine reine Projekt-/Produktdokumentation oder Anleitung **: Schreiben Sie **keine reine Projekt-/Produktdokumentation oder Anleitung **:
-  - Eine Beschreibung des Projektplans, sowie des Projektverlaufs ist nicht Inhalt der schriftlichen Arbeit. Falls als notwendig erachtet, kann dies im Anhang Platz finden.+  - 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.
   - Versuchen Sie eine rein chronologische Darstellung zu vermeiden und bevorzugen Sie eine technisch geeignete Darstellung (z.B. [[https://de.wikipedia.org/wiki/EVA-Prinzip|EVA-Prinzip]]).    - Versuchen Sie eine rein chronologische Darstellung zu vermeiden und bevorzugen Sie eine technisch geeignete Darstellung (z.B. [[https://de.wikipedia.org/wiki/EVA-Prinzip|EVA-Prinzip]]). 
   - 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.   - 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.
Zeile 161: Zeile 254:
   - **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 [[https://www.vwl.uni-mannheim.de/media/Fakultaeten/vwl/Dokumente/Leitfaden_Selbstreferenz.pdf|Universitäten]].   - **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 [[https://www.vwl.uni-mannheim.de/media/Fakultaeten/vwl/Dokumente/Leitfaden_Selbstreferenz.pdf|Universitäten]].
   - Beachten Sie, dass Argumente nachvollziehbar sein sollten.    - Beachten Sie, dass Argumente nachvollziehbar sein sollten. 
 +  - Abkürzungen
 +    - Technische Abkürzungen sollten bei der ersten Verwendung ausgeschrieben und kurz erklärt werden, z.B. USB (engl. Universal Serial Bus).
 +    - Falls der Begriff in einem kommenden Kapitel detaillierter beschrieben werden, ist eine Referenz auf das Kapitel sinnvoll.
 +    - nicht-fachliche Abkürzungen, wie ggü. für gegenüber, sollten vermieden werden.
  
 ==== 3.2 Tabellen, Diagramme und Bilder ==== ==== 3.2 Tabellen, Diagramme und Bilder ====
Zeile 166: Zeile 263:
 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. 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.
  
-  - Jedes Diagramm, jedes Bild, jede Tabelle muss im Fließtext referenziert werden. +  - Jedes Diagramm, jedes Bild, jede Tabelle, jedes Code-Listing muss im Fließtext referenziert werden.  
 +    - 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.  
 +    - Mit dieser Funktion können auch Querverweise auf den Anhang oder andere Kapitel referenziert werden.  
 +  - Bilder haben Bildunterschriften, Tabellen haben Tabellenüberschriften. Es empfiehlt sich hierfür eine Formatvorlage zu verwenden. 
   - 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.   - 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.
   - 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.ä.   - 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.ä.
 +  - Ggf. Strichstärke ist die in Diagrammen zu erhöhen, damit diese nachher als Print noch gut zu erkennen sind. 
   - 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.   - 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.
   - 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.   - 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.
   - Zitierte Bilder und Tabellen:   - Zitierte Bilder und Tabellen:
-    - Bilder und Tabellen können generell auch als Zitat eingefügt und als solches hervorgehoben werden. +    - Bilder und Tabellen können generell auch als Zitat eingefügt werden. Diese müssen dann als solches hervorgehoben werden. 
     - 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.     - 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.
     - Bei einfachen Bilder und Tabellen auf Englisch empfiehlt sich die eigene Überarbeitung mit entsprechendem Hinweis, z.B. "in Anlehnung an" oder "Eigene Darstellung nach".      - Bei einfachen Bilder und Tabellen auf Englisch empfiehlt sich die eigene Überarbeitung mit entsprechendem Hinweis, z.B. "in Anlehnung an" oder "Eigene Darstellung nach". 
-    - Komplexere Bilder oder z.B. Messkurven auf Englisch sollten übernommen werden. Es empfiehlt sich hierbei eine Beschreibung der englischen Achsen im Text oder im Abbildungstext hinzuzufügen.+    - 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.
  
 ==== 3.3 Aufzählungen und Listen ==== ==== 3.3 Aufzählungen und Listen ====
-  - Vermeiden Sie zu lange Aufzählungen und Listen. Diese sind eher für Präsentationsslides geeignet. Optimal ist, wenn diese auf eine 1/2 bis 1 Seite passen+  - 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.
   - 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.)    - 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.) 
   - Bitte achten Sie bei Ihrer Arbeit auf ein **einheitliches Schriftbild, Absätze und Textsatz**.    - Bitte achten Sie bei Ihrer Arbeit auf ein **einheitliches Schriftbild, Absätze und Textsatz**. 
Zeile 193: Zeile 294:
     - Bei Onlinequellen bietet es sich an diese über die [[https://web.archive.org/save/|WaybackMachine]] dauerhaft abzuspeichern. So kann ein permanenter Link erstellt werden.     - Bei Onlinequellen bietet es sich an diese über die [[https://web.archive.org/save/|WaybackMachine]] dauerhaft abzuspeichern. So kann ein permanenter Link erstellt werden.
   - Bei Literatur-Quellen wie Büchern und Magazinen sollte die Seite mit angegeben werden, z.B. als ''pp. 302-304''.   - Bei Literatur-Quellen wie Büchern und Magazinen sollte die Seite mit angegeben werden, z.B. als ''pp. 302-304''.
 +  - 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. 
 +  - Die Einträge im Literaturverzeichnis sind alphabetisch nach Autor zu sortieren. 
 +  - 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. 
  
 ==== 3.5 Verzeichnisse ==== ==== 3.5 Verzeichnisse ====
 +
   - Erstellen Sie **kompakte Verzeichnisse** (Inhalts- und Abbildungsverzeichnis, soweit notwendig auch Tabellen-, Formel-, Listing- oder Abkürzungsverzeichnis).    - Erstellen Sie **kompakte Verzeichnisse** (Inhalts- und Abbildungsverzeichnis, soweit notwendig auch Tabellen-, Formel-, Listing- oder Abkürzungsverzeichnis). 
-  - 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).+  - 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.  
 +  - 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). <wrap anchor #abbildungstext_word />
   - 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 [[https://answers.microsoft.com/de-de/msoffice/forum/all/erweiterte-beschriftung-ohne-dass-es-im/331af25a-aa36-4c7e-8855-703807d01886|Teil des Textes im Verzeichnis]] dargestellt werden kann.   - 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 [[https://answers.microsoft.com/de-de/msoffice/forum/all/erweiterte-beschriftung-ohne-dass-es-im/331af25a-aa36-4c7e-8855-703807d01886|Teil des Textes im Verzeichnis]] dargestellt werden kann.
 +  - Speziell beim Inhaltsverzeichnis / Kapitelaufteilung
 +    - Sätze und Fragen sind für Überschiften eher ungeeignet. Auch Verben sollten substantiviert werden: Statt "4.1 Elektronik entwickeln" $\rightarrow$ "4.1 Elektronikentwicklung"
 +    - Vermeiden Sie unausgewogene Kapitelaufteilung (z.B. 4.1, 4.2 und 4.3 nur eine Seite, aber 4.4 zehn Seiten)
 +    - Bitte keine Unterkapitel einzeln stellen (z.B. 4.1 ohne 4.2, 4.3 ...). Entweder mindestens zwei Unterkapitel, oder gar keine
 +    - 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).
 +  - Für den Inhalt des Abkürzungsverzeichnis ist es auchreichend eine einfache Tabelle einzufügen. 
  
 ==== 3.6 Sprache ==== ==== 3.6 Sprache ====
Zeile 208: Zeile 320:
     - Bei Textinhalten in eigenen Bildern sollte so wie hier für Fließtext beschrieben vorgegangen werden     - Bei Textinhalten in eigenen Bildern sollte so wie hier für Fließtext beschrieben vorgegangen werden
     - Bei einfachen, referenzierten Bildern empfiehlt sich diese nachzuzeichnen       - Bei einfachen, referenzierten Bildern empfiehlt sich diese nachzuzeichnen  
 +  - Umgang mit Zahlen im Text: 
 +    - Es gibt keine festen Regularien für das Ausschreiben von Zahlen (mehr). 
 +    - Der Anhaltspunkt "alle Zahlen unter 13 werden als Wort ausgeschrieben" ist sinnvoll.
 +    - Ausnahmen: 
 +      - Als gezifferte Zahl: Kapitel- und Datumsangaben (Kapitel 5, 17. August), 
 +      - Als ausgeschriebene Zahl: runde Zahlen (zwanzig)
 +    - Für weitere Details kann sich nach den Hinweisen unter [[https://www.scribbr.de/wissenschaftliches-schreiben/zahlen-in-wissenschaftlichen-arbeiten/|Scribbr]] gehalten werden.
   - Umsetzung im Text   - Umsetzung im Text
     - Bitte beachten Sie die deutsche Rechtschreibung und Grammatik:     - Bitte beachten Sie die deutsche Rechtschreibung und Grammatik:
Zeile 219: Zeile 338:
     - Wortdopplungen und Konsistenz      - Wortdopplungen und Konsistenz 
       - 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).       - 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).
-      - 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.)+      - 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).
     - Vermeiden Sie zu lange und verschachtelte Sätze. Sätze über mehr als zwei Zeilen sind in der Regel nicht leicht erfassbar.     - Vermeiden Sie zu lange und verschachtelte Sätze. Sätze über mehr als zwei Zeilen sind in der Regel nicht leicht erfassbar.
  
Zeile 226: Zeile 345:
   - Alle neuen Variablen und Parameter sollten direkt bei der Formel im Fließtext beschrieben werden.   - Alle neuen Variablen und Parameter sollten direkt bei der Formel im Fließtext beschrieben werden.
   - 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.   - 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.
 +  - In Word ist es sinnvoll Formel wie folgt in einer Tabelle einzufügen. \\ {{drawio>studentische_arbeiten:Formel.svg}}
 +    - Die Tabellenränder sind dabei unsichtbar zu machen: 
 +    - Diese einmalig angelegte Tabelle kann am besten als Tabellenvorlage abspeichern. 
 +    - Es ist sinnvoll die Eigenschaften der Tabelle so einzustellen, dass kein Zeilenumbruch innerhalb der Tabelle stattfindet, Details dazu finden sich z.B. [[https://praxistipps.chip.de/word-tabelle-bei-seitenumbruch-nicht-teilen_93397|hier]].
 +  - 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. 
  
-===== 4. Lessons-Learned =====+===== 4 Lessons-Learned =====
  
 ^Kommentar^Schlecht-Beispiel^Gut-Beispiel^ ^Kommentar^Schlecht-Beispiel^Gut-Beispiel^
Zeile 248: Zeile 372:
 \\ \\
  
-===== 5. Übersetzungstabelle Umgangssprache - wissenschaftlicher Text =====+===== 5 Übersetzungstabelle Umgangssprache - wissenschaftlicher Text =====
  
 Folgende Tabelle soll ausländischen Studenten helfen, die geeignete Sprache für einen wissenschaftlichen Text zu finden Folgende Tabelle soll ausländischen Studenten helfen, die geeignete Sprache für einen wissenschaftlichen Text zu finden
Zeile 262: Zeile 386:
 | langweilig        | monoton, zeitintensiv                                   | | langweilig        | monoton, zeitintensiv                                   |
 | eher              | vielmehr                                                | | eher              | vielmehr                                                |
 +| glücklicherweise  | ... bietet Vorteile (für die Anwendung), ist geeignet   |
 +
  
 +===== 6 Weiterführende Quellen =====
 +  - [[https://www.thm.de/iem/images/user/dschul-910/Hinweise_zur_Abschlussarbeit.pdf|Allgemeine Hinweise der TH Mittelhessen zum Verfassen von Arbeiten]]
 +  - [[https://www.th-nuernberg.de/fileadmin/global/Gelenkte_Doks/StabSt/QuL/QuL_0080_INFO_Leitfaden_Verfassen_wissenschaftlicher_Arbeiten_public.pdf|Leitfaden der TH Nürnberg]]