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
allgemeinen_hinweise_zur_schriftlichen_arbeiten [2020/01/14 12:18]
tfischer
allgemeinen_hinweise_zur_schriftlichen_arbeiten [2020/09/14 08:15] (aktuell)
tfischer
Zeile 1: Zeile 1:
 ====== Allgemeine Hinweise zu schriftlichen Arbeiten ====== ====== Allgemeine Hinweise zu schriftlichen Arbeiten ======
  
-==== Aufteilung und Struktur ====+===== 1. Aufteilung und Struktur ​=====
  
   - Nutzen Sie **Diagramme und Bilder**. In der ingenieursmäßigen Arbeit werden Unterlagen häufig zunächst durchgeblättert,​ bis zum relevanten Kapitel. Dabei bieten Diagramme und Bilder gute Anhaltspunkte.   - Nutzen Sie **Diagramme und Bilder**. In der ingenieursmäßigen Arbeit werden Unterlagen häufig zunächst durchgeblättert,​ bis zum relevanten Kapitel. Dabei bieten Diagramme und Bilder gute Anhaltspunkte.
Zeile 9: Zeile 9:
 <WRAP right 92% column> <WRAP right 92% column>
  
---> Vortexte und Verzeichnisse #+--> ​Titelblatt, ​Vortexte und Verzeichnisse # 
 + 
 +--> 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 Bachelorarbeiten angepasst werden. 
 +<​-- ​
  
 --> ggf. Sperrvermerk # --> ggf. Sperrvermerk #
Zeile 52: Zeile 56:
     * 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. Kurze Hinführung des Lesers, Umschreiben der zentrale Frage, skizzieren des Wegs und der Ergebnisse.     * 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.
-  * Verzeichnisse:​ Inhaltsverzeichnis,​ Abbildungsverzeichnis,​ Tabellenverzeichnis,​ ggf. Abkürzungsverzeichnis+  * 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.   * Die Seiten mit Vortext und Verzeichnissen werden römisch nummeriert.
  
Zeile 94: Zeile 98:
   * 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?   * 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.
 +
 +<--
 +
 +--> Literaturverzeichnis #
 +<--
 +
 +--> 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
 +  * Die Anhänge sollten alphabetisch bezeichnet werden (z.B. "A. Schaltpläne des Gesamtsystems"​). ​
  
 <-- <--
Zeile 100: Zeile 114:
        
  
 +~~PAGEBREAK~~ ~~CLEARFIX~~
 ---- ----
-   +===== 2. Länge der schriftlichen Arbeit ​===== 
-   +Eine feste Vorgabe für die Länge der Abschlussarbeit gibt es nicht.  
-==== Schreibstil ​====+  - Beachten Sie aber, das die Arbeit von lesbarer Länge sein soll - eine Länge von mehr als 80-100 Seiten (ohne Anhang) ist dies nicht. 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. Damit wird i.d.R. die Seitenanzahl mehr als 40-50 Seiten werden. Bitte versuchen Sie den geforderten Umfang darzustellen,​ um auch selbst Ihre Arbeit würdig zu präsentieren. 
 +  - 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).
  
-  ​- Schreiben Sie **keine reine Projekt-/​Produktdokumentation**:​+---- 
 +===== 3. Schreibstil ===== 
 + 
 +  ​- Schreiben Sie **keine reine Projekt-/​Produktdokumentation ​oder Anleitung ​**:
     - Eine Beschreibung des Projektplans,​ sowie des Projektverlaufs ist nicht Inhalt der Abschlussarbeit. Falls als notwendig erachtet, kann dies im Anhang Platz finden.     - Eine Beschreibung des Projektplans,​ sowie des Projektverlaufs ist nicht Inhalt der Abschlussarbeit. Falls als notwendig erachtet, kann dies 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]]). ​
-  ​- 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). +    - 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. 
-  - Jedes Diagramm, jedes Bild, jede Tabelle muss im Fließtext referenziert werden.  +    - 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 
-  - Bitte achten Sie bei Ihrer Arbeit auf ein **einheitliches Schriftbild,​ Absätze und Textsatz**. +  - Nutzen Sie **Tabellen, Diagramme und Bilder**: 
-  - Berücksichtigen Sie die **korrekte Zitierung**. Vermeiden Sie direkte Zitate über mehrere Zeilen. +    ​- 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). 
-  - Verwenden Sie für Zitate ​möglichst nur (ingenieurs)wissenschaftliche Quellen, also Lehrbücher,​ Datenblätter,​ etc. Digitale ​Wissenspeicher, wie Wikipedia können verwendet werden. Fragen Sie sich aber immer: "Warum ist gerade diese Referenz wichtig?"​+    - Jedes Diagramm, jedes Bild, jede Tabelle muss im Fließtext referenziert werden. ​ 
 +    - 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.ä. 
 +    - 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. 
 +  - Aufzählungen und Listen 
 +    - Vermeiden Sie zu lange Aufzählungen und Listen. Optimal ist, wenn diese auf eine 1/2 bis 1 Seite passen 
 +    - 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**. ​Vermeiden Sie {{wpde>​Hurenkind_und_Schusterjunge|Hurenkinder und Schusterjungen}} 
 +  ​- Zitierung und Quellen 
 +    ​- Berücksichtigen Sie die **korrekte Zitierung**. 
 +    - Vermeiden Sie direkte Zitate über mehrere Zeilen. 
 +    - 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?"​ 
 +    - Geben Sie Bei Referenzen zu Onlinequellen an, wann Sie diese abgerufen haben. z.B. [Zugriff am 01.01.2020] 
 +  - Erstellen Sie ein **kompaktes Abbildungsverzeichnis**. Vermeiden Sie lange Beschreibungen und Referenzen ​ (z.B. [15] in "​Abbildung 2: Eingabeprinzip [15]"​). Falls Sie Word nutzen, finden Sie ein geeignetes Vorgehen dazu [[https://​answers.microsoft.com/​de-de/​msoffice/​forum/​all/​erweiterte-beschriftung-ohne-dass-es-im/​331af25a-aa36-4c7e-8855-703807d01886|hier]]
   - **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]].
  
-==== Lessons-Learned ==== +===== 4. Lessons-Learned =====
  
 ^Kommentar^Schlecht-Beispiel^Gut-Beispiel^ ^Kommentar^Schlecht-Beispiel^Gut-Beispiel^
Zeile 125: Zeile 157:
 4. https:<​nowiki>//</​nowiki>​some-webpage-somewhere.com/​images?​q=tbn:​sdfu389udvworuer89vufo48uerjceo8w7udwrjfoivu89ez \\ 4. https:<​nowiki>//</​nowiki>​some-webpage-somewhere.com/​images?​q=tbn:​sdfu389udvworuer89vufo48uerjceo8w7udwrjfoivu89ez \\
 )</​font>"​|"​Abbildung 1 Komponente blablub [2]"​| ​ )</​font>"​|"​Abbildung 1 Komponente blablub [2]"​| ​
-^Vermeiden Sie Umgangssprache!|1. "Dies wurde <font inherit/​inherit;;#​c0392b;;​inherit>​ein wenig</​font>​ getestet."​\\ 2. "Bei der Wiederholung muss <font inherit/​inherit;;#​c0392b;;​inherit>​nachgeschaut</​font>​ werden, ob blablub. " \\ 3. "Es wurde <font inherit/​inherit;;#​c0392b;;​inherit>​viel ausprobiert</​font>"​ \\   4. "<​font inherit/​inherit;;#​c0392b;;​inherit>​Zufällig</​font>​ wurde gefunden, dass blablub"​|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| ​+^Vermeiden Sie Umgangssprache!|1. "Dies wurde <font inherit/​inherit;;#​c0392b;;​inherit>​ein wenig</​font>​ getestet."​\\ 2. "Bei der Wiederholung muss <font inherit/​inherit;;#​c0392b;;​inherit>​nachgeschaut</​font>​ werden, ob blablub. " \\ 3. "Es wurde <font inherit/​inherit;;#​c0392b;;​inherit>​viel ausprobiert</​font>"​ \\   4. "<​font inherit/​inherit;;#​c0392b;;​inherit>​Zufällig</​font>​ wurde gefunden, dass blablub" \\ 5. "Es muss <font inherit/​inherit;;#​c0392b;;​inherit>​nämlich</​font>​ ..." |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 <font inherit/​inherit;;#​c0392b;;​inherit>​kann</​font>​ das blablub angeschalten werden." ​ |1. "Zur Spannungsmessung muss das blablub eingeschaltet sein." ​ |  ^Nutzen Sie passende Modalverben. \\ Ist die Tätigkeit zur Zielereichung notwendig?​|1. "Zur Spannungsmessung <font inherit/​inherit;;#​c0392b;;​inherit>​kann</​font>​ das blablub angeschalten werden." ​ |1. "Zur Spannungsmessung muss das blablub eingeschaltet sein." ​ | 
 ^ Vermeiden Sie zu persönliche und unsachliche Beschreibungen.|1. "Hier waren aber <font inherit/​inherit;;#​c0392b;;​inherit>​meine Kenntnisse \\ ^ Vermeiden Sie zu persönliche und unsachliche Beschreibungen.|1. "Hier waren aber <font inherit/​inherit;;#​c0392b;;​inherit>​meine Kenntnisse \\
Zeile 132: Zeile 164:
 ^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 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 <font inherit/​inherit;;#​c0392b;;​inherit>​designed</​font>​."​ \\   2. "Die Software wurde <font inherit/​inherit;;#​c0392b;;​inherit>​upgedatet</​font>​."​|1. "Ein Boarddesign wurde entwickelt"​ oder "Ein Platinenlayout wurde entwickelt"​ \\   2. "Die Software wurde aktualisiert"​ oder "Das Softwareupdate wurde ausgeführt"​| ​ ^Vermeiden Sie "​denglisch",​ speziell Beugung englischer Wörter.|1. "Es wurde ein Board <font inherit/​inherit;;#​c0392b;;​inherit>​designed</​font>​."​ \\   2. "Die Software wurde <font inherit/​inherit;;#​c0392b;;​inherit>​upgedatet</​font>​."​|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> <font inherit/​inherit;;#​c0392b;;​inherit>​entwickelt</​font>​. Als zweites wird <B> <font inherit/​inherit;;#​c0392b;;​inherit>​entwickelt</​font>​. \\ 2. Im Folgenden müssen <font inherit/​inherit;;#​c0392b;;​inherit>​die,​ die</​font>​ vorher ... \\ 3. Damit verbinden sich <​Dummy1>​ <font inherit/​inherit;;#​c0392b;;​inherit>​und</​font>​ <​Dummy2>​ <font inherit/​inherit;;#​c0392b;;​inherit>​und</​font>​ es ergibt sich <​Dummy3>​. \\ 4. Der <​Dummy1>,​ <font inherit/​inherit;;#​c0392b;;​inherit>​der</​font>​ in den <​Dummy2>​ eingesetzt wird, <font inherit/​inherit;;#​c0392b;;​inherit>​der</​font>​ ... 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. <font inherit/​inherit;;#​c0392b;;​inherit>​Wir haben uns geeinigt</​font>​ 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 unklare Begründungen für Entscheidungen | 1. <font inherit/​inherit;;#​c0392b;;​inherit>​Wir haben uns geeinigt</​font>​ 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. <font inherit/​inherit;;#​c0392b;;​inherit>​Man hat sich geeinigt</​font>​ 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. <font inherit/​inherit;;#​c0392b;;​inherit>​Man hat sich geeinigt</​font>​ 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. |
 \\ \\
  
 +===== 5. Übersetzungstabelle Umgangssprache - wissenschaftlicher Text =====
 +
 +Folgende Tabelle soll ausländischen Studenten helfen, die geeignete Sprache für einen wissenschaftlichen Text zu finden
 +
 +^ Umgangssprache ​                                                                                              ^ wissenschaftliche Umschreibung ​                                                              ^
 +| ein wenig                                                                                                    | im geringen Umfang, gering ​                                                                  |
 +| nachschauen ​                                                                                                 | betrachten, überprüfen,​ suchen, analysieren ​                                                 |
 +| ausprobieren ​                                                                                                | Versuch durchführen,​ testen ​                                                                 |
 +| zufällig ​                                                                                                    | mittels Trial-and-Error ​                                                                     |
 +| erstmal ​                                                                                                     | zunächst ​                                                                                    |
 +| drauf                                                                                                        | darauf, \\ auf dem ...                                                                       |