User Tools

Site Tools


allgemeinen_hinweise_zur_schriftlichen_arbeiten

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
allgemeinen_hinweise_zur_schriftlichen_arbeiten [2019/07/10 23:32]
tfischer
allgemeinen_hinweise_zur_schriftlichen_arbeiten [2019/09/06 22:50] (current)
tfischer
Line 1: Line 1:
 ====== Allgemeine Hinweise zu schriftlichen Arbeiten ====== ====== Allgemeine Hinweise zu schriftlichen Arbeiten ======
  
-  - Bitte achten Sie bei Ihrer Arbeit auf ein einheitliches Schriftbild,​ Absätze ​und Textsatz. +==== Aufteilung ​und Struktur ==== 
-  - Berücksichtigen Sie die korrekte Zitierung. Vermeiden Sie direkte Zitate über mehrere Absätze. + 
-  - Bitte vermeiden ​Sie Selbstreferenz im Hauptteil der Arbeit. In der Einleitung ("​Im ​Kapitel ​2analysiere ich…"​) oder bei der Zusammenfassung ​("ich habe abschießend die … betrachtet"​) ist dies sparsam angewandt möglich. 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]].+  - 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. 
 +  - Bei der Softwarevisualisierung bietet sich ein **Funktionsflussdiagramm** an, welches beschreibt, wie die Funktionen/​Module miteinander interagieren ​(also mit Darstellung ​der Schnittstellen)
   - Es empfiehlt sich folgende Aufteilung: ​   - Es empfiehlt sich folgende Aufteilung: ​
-    ​Einleitung ​\\ (Hinführen zum ThemaAufstellen der zentralen Fragestellung) +<​WRAP>​ 
-    - Grundlagen ​\\ Welche Hintergründe sind sinnvoll und notwendig zu wissen? Was würde ein Kommilitone,​ welcher nicht in Ihrem Betrieb arbeitet noch nicht wissen? ​(kann auch unterteilt werden in Hardware, Software) +<WRAP right 92% column>​ 
-    - Konzept / Design / Aufbau des Experiments / des betrachteten Systems ​\\ Hierbei steht Ihre getane Arbeit im Vordergrund. Es kann auf die Methodik, Hardware/​Software-Entwicklung eingegangen werden + 
-    - Umsetzung / Implementierung / Test  +--> Vortexte und Verzeichnisse # 
-    - Diskussion der Ergebnisse + 
-    - Fazit / Resumé / Ausblick ​\\ Dieses Kapitel sollte einem Leser, welcher die Kapitel vorher nicht gelesen hat, über 1-4 Seiten einen Eindruck vermitteln, um was es geht und welche Ergebnisse erzielt wurden. Zusätzlich können der Ausblick und Verbesserungsvorschläge enthalten sein. +--> ggf. Sperrvermerk # 
-  - Schreiben Sie keine reine Projekt-/​Produktdokumentation:​+ 
 +Ein geeigneter Text ist folgender:​ 
 +<WRAP right round box> 
 +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  
 +schriftlichen Genehmigung des Verfassers oder der <fc #​FF0000>​Firma</​fc>​ weitergegeben werden.  
 +\\ \\ 
 +Dieser Sperrvermerk gilt bis zum <fc #​FF0000>​Datum</​fc>​  
 +\\ \\ \\ 
 +------------------- 
 +<wrap group> 
 +<wrap half column><​fc #​FF0000>​Name des (Firmen)Betreuers</​fc></​wrap>​ 
 +<wrap half column><​fc #​FF0000>​Namen des/der Studierenden</​fc></​wrap>​ 
 +</​wrap>​ 
 + 
 +</​WRAP>​ 
 + 
 +<--  
 +  * ggf. Danksagung 
 + 
 +--> eidesstattliche Erklärung # 
 + 
 +Ein geeigneter Text ist folgender:​ 
 +<WRAP right round box> 
 +Hiermit erkläre ich, dass die Bachelorarbeit 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. 
 +\\ \\ 
 +<fc #​FF0000>​Ort</​fc>,​ den <fc #​FF0000>​Datum</​fc>​  
 +\\ \\ \\ 
 +------------------- 
 +<fc #​FF0000>​Namen des/der Studierenden</​fc>​ 
 +</​WRAP>​ 
 + 
 +<​-- ​  
 +  * 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. 
 +  * Verzeichnisse:​ Inhaltsverzeichnis,​ Abbildungsverzeichnis,​ Tabellenverzeichnis,​ ggf. Abkürzungsverzeichnis 
 +  * Die Seiten mit Vortext und Verzeichnissen werden römisch nummeriert. 
 + 
 +<--  
 +--> 1. Einleitung # 
 +  * Hinführen zum Thema 
 +  * Aufstellen der zentralen Fragestellung. Letzteres kann auch in ein separates Kapitel geschrieben werden. ​ 
 + 
 +<--  
 + 
 +--> 2. Grundlagen ​
 +  * Welche Hintergründe sind sinnvoll und notwendig zu wissen? ​ 
 +  * Was würde ein Kommilitone,​ welcher nicht in Ihrem Betrieb arbeitet noch nicht wissen? ​ 
 +  * kann auch unterteilt werden in Hardware, Software 
 +  * Sollte (mit dem nächsten Kapitelauch die Grundlagen für die Analyse der Ergebnisse legen, soweit diese nicht trivial ist 
 + 
 +<--  
 + 
 +--> 3. Stand der Technik # 
 +  * Welche Vorarbeiten und vergleichbaren Arbeiten gibt es? 
 +  * Ggf. ist es vorteilhaft Kapitel 2. und 3. zusammenzufassen 
 + 
 +<--  
 + 
 +--> 4. Konzept / Design / Aufbau des Experiments / des betrachteten Systems ​
 +  * Hierbei steht Ihre getane Arbeit im Vordergrund. ​ 
 +  * Es kann auf die Methodik, Hardware/​Software-Entwicklung eingegangen werden 
 + 
 +<--  
 + 
 +--> 5. Umsetzung / Implementierung / Test # 
 + 
 +<-
 + 
 +--> 6. Diskussion der Ergebnisse ​# 
 + 
 +<-
 + 
 +--> 7. Fazit / Resumé / Ausblick ​
 +  * Dieses Kapitel sollte einem Leser, welcher die Kapitel vorher nicht gelesen hat, über 1-4 Seiten einen Eindruck vermitteln, um was es geht und welche Ergebnisse erzielt wurden. ​ 
 +  * 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. 
 + 
 +<-- 
 +</​WRAP>​ 
 +</​WRAP>​ 
 +    
 + 
 +---- 
 +   
 +   
 +==== Schreibstil ==== 
 + 
 +  - Schreiben Sie **keine reine Projekt-/​Produktdokumentation**:
     - 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]]). ​
-  - Nutzen ​Sie Diagramme und Bilder. In der ingenieursmäßigen ​Arbeit ​werden Unterlagen häufig zunächst durchgeblättertbis zum relevanten KapitelDabei bieten ​Diagramme ​und Bilder ​gute Anhaltspunkte+  - Versuchen ​Sie die Arbeit ​so zu schreibendass ein Kommilitone diese verstehen könnteKomplexe Sachverhalte sollten also erklärt werden (z.B. durch Beispiele, Vergleich, ​DiagrammeBilder)
-  - Bei der Softwarevisualisierung bietet sich ein Funktionsflussdiagramm anwelches beschreibtwie die Funktionen/​Module miteinander interagieren ​(also mit Darstellung ​der Schnittstellen)+  - Bitte achten Sie bei Ihrer Arbeit auf ein **einheitliches SchriftbildAbsätze und Textsatz**. 
 +  - Berücksichtigen Sie die **korrekte Zitierung**. Vermeiden Sie direkte Zitate über mehrere Absätze. 
 +  - **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 ==== 
  
 ^Kommentar^Schlecht-Beispiel^Gut-Beispiel^ ^Kommentar^Schlecht-Beispiel^Gut-Beispiel^
Line 27: Line 126:
 ^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 \\
-in Sachen blablub</​font>​ noch nicht ausreichend."​ \\   2. "Ein <font inherit/​inherit;;#​c0392b;;​inherit>​Hinweis eines Kollegen</​font>​ ergab blablub"​ \\   3. "Die Entwicklung <font inherit/​inherit;;#​c0392b;;​inherit>​hat 4 Wochen gedauert</​font>"​ \\   4. "<​font inherit/​inherit;;#​c0392b;;​inherit>​Die bessere Software war zu teuer. Deswegen wurde trotzdem die alte Software verwendet</​font>"​ \\   5. "Nach dem Start waren <font inherit/​inherit;;#​c0392b;;​inherit>​komische und ungesunde Geräusche</​font>​ zu hören."​|1. weg lassen \\   ​2. ​weg lassen ​\\   3. weg lassen \\   4. weg lassen oder über "​finanzielle Vorgaben/​Randbedingungen"​ umschreiben \\   5. über "​ungewöhnliche Geräuschkulisse"​ oder "​akustisch auffällige Probleme"​ umschreiben| +in Sachen blablub</​font>​ noch nicht ausreichend."​ \\   2. "Ein <font inherit/​inherit;;#​c0392b;;​inherit>​Hinweis eines Kollegen</​font>​ ergab blablub"​ \\   3. "Die Entwicklung <font inherit/​inherit;;#​c0392b;;​inherit>​hat 4 Wochen gedauert</​font>"​ \\   4. "<​font inherit/​inherit;;#​c0392b;;​inherit>​Die bessere Software war zu teuer. Deswegen wurde trotzdem die alte Software verwendet</​font>"​ \\   5. "Nach dem Start waren <font inherit/​inherit;;#​c0392b;;​inherit>​komische und ungesunde Geräusche</​font>​ 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. "<​font inherit/​inherit;;#​c0392b;;​inherit>​Das erste Programm war noch sehr unübersichtlich geschrieben und damit wartungsintensiv. Dieses wurde in mehrere Funktionen unterteilt.</​font>"​| ​  +^Vermeiden Sie eine offensichtlich chronologische Darstellung der Fehler der Entwicklung. Stattdessen sind funktional aufeinander aufbauende Darstellungen empfohlen.|1. "<​font inherit/​inherit;;#​c0392b;;​inherit>​Das erste Programm war noch sehr unübersichtlich geschrieben und damit wartungsintensiv. Dieses wurde dann in mehrere Funktionen unterteilt.</​font>"​| 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 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 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. |
 \\ \\
  
  
allgemeinen_hinweise_zur_schriftlichen_arbeiten.1562801554.txt.gz · Last modified: 2019/07/10 23:32 by tfischer