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 [2024/08/30 00:33]
mexleadmin [3.3 Aufzählungen und Listen] 		studentische_arbeiten:allgemeinen_hinweise_zur_schriftlichen_arbeiten [2024/09/19 22:29] (aktuell)
mexleadmin [3.2 Tabellen, Diagramme und Bilder]
Zeile 230: Zeile 230:
     - Die Nummerierung sollte "1", "1.1", "1.1.1" sein, d.h. Punkte werden nur zwischen den Zahlen geschrieben, nicht am Ende.      - Die Nummerierung sollte "1", "1.1", "1.1.1" sein, d.h. Punkte werden nur zwischen den Zahlen geschrieben, nicht am Ende. 
   -  Weitere Formatvorlagen   -  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. +    - Im Normalfall werden zusätzlich die Formatvorlagen „Inhaltsverzeichnisüberschrift“ und z.B. „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.     - 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:     - Es empfielht sich für das Inhaltsverzeichnis folgende Formatvorlagen anzulegen:
Zeile 274: Zeile 274:
   - Ggf. Strichstärke ist die in Diagrammen zu erhöhen, damit diese nachher als Print noch gut zu erkennen sind.    - 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.+  - Code Listings 
 +    - 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. 
 +    - Statt Code Listings bieten sich bei der Softwarevisualisierung **Funktionsflussdiagramme**, UML-Klassen/Objektdiagramme oder Ablaufdiagramme an. Gut ist eine Beschreibung, //wie// die Funktionen/Module miteinander interagieren (also mit Darstellung der Schnittstellen).  
 +    - Falls Sie Code einfügen (als Code-Snippets oder im Anhang), so sollten Zeilennummern und Syntax Highlighting genutzt werden. Dazu gibt es z.B. den Weg über %%Notepad++%% (siehe {{https://www.youtube.com/watch?v=d90qrJL7VvQ&ab_channel=PickUpBrain|Video}}).
   - Zitierte Bilder und Tabellen:   - Zitierte Bilder und Tabellen:
     - Bilder und Tabellen können generell auch als Zitat eingefügt werden. Diese müssen dann als solches hervorgehoben werden.      - Bilder und Tabellen können generell auch als Zitat eingefügt werden. Diese müssen dann als solches hervorgehoben werden. 
Zeile 287: Zeile 290:
     - Vermeiden Sie {{wpde>Hurenkind_und_Schusterjunge|Hurenkinder und Schusterjungen}}.     - Vermeiden Sie {{wpde>Hurenkind_und_Schusterjunge|Hurenkinder und Schusterjungen}}.
     - 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.     - 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.
 +
  
 ==== 3.4 Zitierung und Quellen ==== ==== 3.4 Zitierung und Quellen ====
 Berücksichtigen Sie die **korrekte Zitierung**. Berücksichtigen Sie die **korrekte Zitierung**.
  
 +  - Persönlich bevorzuge ich die {{https://journals.ieeeauthorcenter.ieee.org/wp-content/uploads/sites/7/IEEE_Reference_Guide.pdf|Zitierweise nach IEEE}}, also konkret die Verwendung von Zahlen in eckigen Klammern ''[11]''. 
   - 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?"   - 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?"
   - Vermeiden Sie direkte Zitate, insbesondere über mehrere Zeilen. Generell sollte man sich hier fragen:  "Warum ist gerade diese Referenz als direktes Zitat wichtig?"   - Vermeiden Sie direkte Zitate, insbesondere über mehrere Zeilen. Generell sollte man sich hier fragen:  "Warum ist gerade diese Referenz als direktes Zitat wichtig?"
Zeile 297: Zeile 302:
     - 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. +  - Für die Verwaltung und automatisch Generierung des Literaturverzeichnisses sollte ein Literaturverwaltungsprogramm verwendet werden 
 +    - Für Citavi steht **keine** Campus-Lizenz für Studierende mehr zur Verfügung. 
 +    - Als Alternative bietet sich [[https://www.zotero.org/|ZOTERO]] an.
   - Die Einträge im Literaturverzeichnis sind alphabetisch nach Autor zu sortieren.    - 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. +  - 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. 
  
 <alert type="danger"> <alert type="danger">
Zeile 372: Zeile 379:
     - Zwischen Zahlenwert und Einheit ist ein Leerschritt einzufügen (in Word idealerweise ein geschütztes Leerzeichen durch ''<Strg>+<Umschalt>+<Leertaste>'') \\ beachte aber: ein Winkel von $20°$ ist korrekt geschrieben, eine Temperatur von $20°\rm C$ nicht     - Zwischen Zahlenwert und Einheit ist ein Leerschritt einzufügen (in Word idealerweise ein geschütztes Leerzeichen durch ''<Strg>+<Umschalt>+<Leertaste>'') \\ beachte aber: ein Winkel von $20°$ ist korrekt geschrieben, eine Temperatur von $20°\rm C$ nicht
  
-==== 3.8 Peculiarities of theses written in English ====+==== 3.8 Peculiarities of Theses written in English ====
   - Use appropriate English chapter titles, e.g.    - Use appropriate English chapter titles, e.g. 
     - Acknowledgement (for the German Danksagung),     - Acknowledgement (for the German Danksagung),