Unterschiede
Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
Beide Seiten der vorigen Revision Vorhergehende Überarbeitung Nächste Überarbeitung | Vorhergehende Überarbeitung Letzte Überarbeitung Beide Seiten der Revision | ||
studentische_arbeiten:allgemeinen_hinweise_zur_schriftlichen_arbeiten [2022/04/27 23:17] tfischer [3.5 Verzeichnisse] |
studentische_arbeiten:allgemeinen_hinweise_zur_schriftlichen_arbeiten [2023/09/29 21:31] mexleadmin [3.6 Sprache] |
||
---|---|---|---|
Zeile 1: | Zeile 1: | ||
- | ====== | + | ====== Hinweise |
+ | |||
+ | * 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. | ||
===== 1. Aufteilung und Struktur ===== | ===== 1. Aufteilung und Struktur ===== | ||
Zeile 26: | 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 vorliegende Bachelor Thesis enthält zum Teil vertrauliche Informationen, | ||
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 34: | Zeile 37: | ||
\\ \\ \\ | \\ \\ \\ | ||
------------------- | ------------------- | ||
- | <wrap group> | + | <WRAP group> |
- | <wrap half column>< | + | <WRAP half column>< |
- | <wrap half column>< | + | <WRAP half column>< |
- | </ | + | |
</ | </ | ||
+ | |||
+ | </ | ||
< | < | ||
+ | |||
--> ggf. Danksagung / Widmung # | --> ggf. Danksagung / Widmung # | ||
Zeile 49: | Zeile 53: | ||
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 60: | Zeile 64: | ||
------------------- | ------------------- | ||
<fc # | <fc # | ||
- | </WRAP> | + | </callout> |
< | < | ||
Zeile 80: | Zeile 84: | ||
* ggf. Abkürzungsverzeichnis | * ggf. Abkürzungsverzeichnis | ||
- | * Die Seiten mit Vortext und Verzeichnissen werden römisch nummeriert. | + | * Die Seitenzahlen von Vortext und Verzeichnissen werden römisch nummeriert. |
<-- | <-- | ||
Zeile 170: | 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, | * Beispiele dafür sind: CAD-Pläne, weiterführende Schaltpläne, | ||
- | * Die Anhänge sollten alphabetisch bezeichnet werden | + | |
+ | | ||
<-- | <-- | ||
Zeile 197: | Zeile 202: | ||
- Bachelor-/ | - Bachelor-/ | ||
- 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), | - 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), | ||
+ | - 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/ | ||
+ | - **Kopf-/ | ||
+ | - 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, | ||
+ | - Ü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 " | ||
+ | - 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 " | ||
+ | - Die Nummerierung sollte " | ||
+ | - 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 " | ||
+ | - 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, | ||
+ | - Das Trennzeichen zwischen Nummerierung und Beginn der Unter- bzw. Überschrift sollte ein Tabstopp sein. Dann wird die Überschrift korrekt eingerückt, | ||
+ | |||
+ | ==== 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 216: | Zeile 254: | ||
- **Kein " | - **Kein " | ||
- Beachten Sie, dass Argumente nachvollziehbar sein sollten. | - Beachten Sie, dass Argumente nachvollziehbar sein sollten. | ||
- | - Abkürzungen sollten bei der ersten Verwendung ausgeschrieben und kurz erklärt werden. Falls diese in einem kommenden Kapitel detaillierter beschrieben werden, ist eine Referenz auf das Kapitel sinnvoll. | + | - Abkürzungen |
+ | - Technische | ||
+ | - Falls der Begriff | ||
+ | - nicht-fachliche Abkürzungen, | ||
==== 3.2 Tabellen, Diagramme und Bilder ==== | ==== 3.2 Tabellen, Diagramme und Bilder ==== | ||
Zeile 222: | 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, | 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, | ||
- | - Jedes Diagramm, jedes Bild, jede Tabelle muss im Fließtext referenziert werden. | + | - Jedes Diagramm, jedes Bild, jede Tabelle, jedes Code-Listing |
+ | - 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, | ||
+ | - Mit dieser Funktion können auch Querverweise auf den Anhang oder andere Kapitel referenziert werden. | ||
+ | - Bilder haben Bildunterschriften, | ||
- 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), | - Vermeiden Sie zu pixelige Bilder, zu kleine / zu große Schrift in Bildern (optimal ist etwas kleiner als die Schriftgröße im Fließtext), | ||
+ | - 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**, | - Bei der Softwarevisualisierung bieten sich **Funktionsflussdiagramme**, | ||
- Zitierte Bilder und Tabellen: | - Zitierte Bilder und Tabellen: | ||
- | - Bilder und Tabellen können generell auch als Zitat eingefügt | + | - Bilder und Tabellen können generell auch als Zitat eingefügt |
- 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 " | - Bei einfachen Bilder und Tabellen auf Englisch empfiehlt sich die eigene Überarbeitung mit entsprechendem Hinweis, z.B. "in Anlehnung an" oder " | ||
- | - 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 |
==== 3.3 Aufzählungen und Listen ==== | ==== 3.3 Aufzählungen und Listen ==== | ||
Zeile 249: | Zeile 294: | ||
- Bei Onlinequellen bietet es sich an diese über die [[https:// | - Bei Onlinequellen bietet es sich an diese über die [[https:// | ||
- Bei Literatur-Quellen wie Büchern und Magazinen sollte die Seite mit angegeben werden, z.B. als '' | - Bei Literatur-Quellen wie Büchern und Magazinen sollte die Seite mit angegeben werden, z.B. als '' | ||
+ | - 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, | - Erstellen Sie **kompakte Verzeichnisse** (Inhalts- und Abbildungsverzeichnis, | ||
- | - 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). | + | |
+ | | ||
- Vermeiden Sie aber auch lange Beschreibungen und Referenzen (z.B. '' | - Vermeiden Sie aber auch lange Beschreibungen und Referenzen (z.B. '' | ||
- Speziell beim Inhaltsverzeichnis / Kapitelaufteilung | - Speziell beim Inhaltsverzeichnis / Kapitelaufteilung | ||
Zeile 259: | Zeile 309: | ||
- Bitte keine Unterkapitel einzeln stellen (z.B. 4.1 ohne 4.2, 4.3 ...). Entweder mindestens zwei Unterkapitel, | - Bitte keine Unterkapitel einzeln stellen (z.B. 4.1 ohne 4.2, 4.3 ...). Entweder mindestens zwei Unterkapitel, | ||
- 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). | - 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 269: | 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" | ||
+ | - 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:// | ||
- Umsetzung im Text | - Umsetzung im Text | ||
- Bitte beachten Sie die deutsche Rechtschreibung und Grammatik: | - Bitte beachten Sie die deutsche Rechtschreibung und Grammatik: | ||
Zeile 280: | 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. Es bietet sich beim wiederholten Lesen eine Suche und Umschreibung der häufigsten Standardwörter an (dies/ | + | - 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, |
- 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 287: | 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> | ||
+ | - 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, | ||
+ | - Beachten Sie die Normen zur korrekten Schreibung von Formeln und physikalischen Größen. So werden unter anderem Formelzeichen werden kursiv dargestellt, | ||
===== 4. Lessons-Learned ===== | ===== 4. Lessons-Learned ===== |