Changes for page Writing and Grading Theses
Last modified by Niklas Rentz on 2023/10/10 10:45
Summary
-
Page properties (3 modified, 0 added, 0 removed)
-
Objects (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Title
-
... ... @@ -1,1 +1,1 @@ 1 - Hinweisezur Anfertigungvon Abschlussarbeiten1 +Writing and Grading Theses - Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. tig1 +XWiki.cds - Content
-
... ... @@ -1,5 +3,3 @@ 1 -= Hinweise zur Anfertigung und Benotung von Abschlussarbeiten[[url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#HinweisezurAnfertigungundBenotungvonAbschlussarbeiten||style="text-decoration: none;" title="Link to this section" shape="rect" class="anchor"]] = 2 - 3 3 //Note: Most of this page is in German. Future additions should be done in English. At some point, some good soul might translate the German "legacy documentation" to English as well.// 4 4 5 5 ... ... @@ -51,8 +51,7 @@ 51 51 52 52 Diese Seite gibt Hinweise, welche bei der Anfertigung einer studentischen Arbeit an der AG Echtzeitsysteme und Eingebettete Systeme beachtet werden sollten. Dies betrifft in erster Linie Studien-/Diplom-/Bachelor-/Masterarbeiten; die Hinweise können aber auch bei der Anfertigung von Praktikumsberichten - oder auch Promotionsarbeiten - hilfreich sein. 53 53 54 -(% style="" %) 55 -== Interaktion mit dem Betreuer[[url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#InteraktionmitdemBetreuer||style="text-decoration: none;" title="Link to this section" shape="rect" class="anchor"]] == 52 += Interaktion mit dem Betreuer[[url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#InteraktionmitdemBetreuer||style="text-decoration: none;" title="Link to this section" shape="rect" class="anchor"]] = 56 56 57 57 Eine gute Zusammenarbeit mit Ihrem Betreuer (dies können auch mehrere sein) ist ein wesentlicher Schlüssel für eine erfolgreiche Arbeit. Ihr Betreuer sollte Ihnen an Erfahrung und Fachwissen voraus sein - nutzen Sie dies, um zu lernen und Ihre Arbeit zu verbessern. 58 58 ... ... @@ -64,7 +64,6 @@ 64 64 65 65 Ihre Diplomarbeit ist ein Vollzeitjob; Sie sollten also im Normalfall täglich am Arbeitsplatz sein. Wenn Sie daneben einer regelmäßigen Arbeit nachgehen, sollten Sie mit dem Betreuer absprechen, wie dies mit der Anfertigung Ihrer Abschlussarbeit vereinbart werden kann. 66 66 67 -(% style="" %) 68 68 === Zeitlicher Ablauf[[url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#ZeitlicherAblauf||style="text-decoration: none;" title="Link to this section" shape="rect" class="anchor"]] === 69 69 70 70 Sie sollten insbesondere bei der Anfertigung der schriftlichen Ausfertigung auf die Erfahrungen des Betreuers zugreifen. Sie sollten dem Betreuer also Entwürfe Ihrer Arbeit zukommen lassen, bevor Sie die zu benotende Endversion einreichen. Ihre Entwürfe sollten dabei aus Ihrer Sicht möglichst reif sein, müssen aber noch keineswegs vollständig sein. Eine bewährte Sequenz von abzuliefernden Dokumenten ist: ... ... @@ -72,9 +72,9 @@ 72 72 |((( 73 73 Aktion 74 74 )))|((( 75 - Diplomarbeit/Masterarbeit71 +Masterarbeit/Diplomarbeit 76 76 )))|((( 77 - Studienarbeit/Bachelorarbeit73 +Bachelorarbeit/Studienarbeit 78 78 )))|((( 79 79 Idee 80 80 ))) ... ... @@ -108,15 +108,12 @@ 108 108 109 109 Für Arbeiten, welche in Zusammenarbeit mit einem Industrieunternehmen angefertigt werden, gilt diese Sequenz ebenso; Sie sollten hier jedoch Entwürfe, welche Sie dem universitären Betreuer zukommen lassen, vorher entsprechend von Ihrem Betreuer aus dem Unternehmen durchsehen lassen. 110 110 111 -(% style="" %) 112 112 === Notizen[[url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#Notizen||style="text-decoration: none;" title="Link to this section" shape="rect" class="anchor"]] === 113 113 114 114 Machen Sie sich während Ihrer gesamten theoretischen Arbeit Notizen darüber, was Sie gerade tun, wie Sie es tun und insbesondere: warum Sie es tun. Im Moment des Tuns ist alles noch klar, aber sobald es ans Schreiben geht wird es nicht mehr so klar sein. Tun Sie sich also einen Gefallen und schreiben Sie Notizen. Die Arbeit ist auch insofern schon nicht umsonst, als dass die Notizen eine prima Grundlage für Teile Ihrer schriftlichen Ausarbeitung werden. 115 115 116 -(% style="" %) 117 117 == Hinweise zu Implementierungen[[url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#HinweisezuImplementierungen||style="text-decoration: none;" title="Link to this section" shape="rect" class="anchor"]] == 118 118 119 -(% style="" %) 120 120 === Allgemeines[[url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#Allgemeines||style="text-decoration: none;" title="Link to this section" shape="rect" class="anchor"]] === 121 121 122 122 Erste Regel: **"No Crashes!"** Egal was Ihr System tut und welche Nutzereingaben geschehen, die Implementierung sollte nicht abstürzen oder einfrieren. Wo Annahmen gemacht werden, sollten diese explizit überprüft werden. Im Falle der Nichteinhaltung sollte eine brauchbare Fehlermeldung generiert werden, und der Anwender sollte weiter mit der Implementierung arbeiten können. ... ... @@ -123,21 +123,16 @@ 123 123 124 124 Generell: Ihre Arbeit wird sehr wahrscheinlich auch einen praktischen Teil enthalten, in welcher Sie Software oder Hardware entwickeln oder erweitern sollen. Das akademische Umfeld Ihrer Arbeit bedeutet in der Regel, dass für diese Entwicklung weniger Ressourcen - insbesondere zeitliche Ressourcen - als in einem kommerziellen Umfeld zur Verfügung stehen, und dass sich Ihre Arbeit nicht am Markt behaupten muss. Die Konsequenz daraus ist, dass Ihre Arbeit in der Regel weniger umfangreich sein sollte und weniger Features bieten sollte als ein kommerzielles Produkt. Die Konsequenz ist nicht, dass Sie ihre Implementierung weniger sorgfältig vornehmen sollen, oder schlechter dokumentieren sollen, als dies in einem professionellem Umfeld der Fall wäre. Im Gegenteil - während bei kommerziellen Produkten der Termindruck, die Notwendigkeit zu ständigen Neuentwicklungen, und zum Teil eine gewisse Ignoranz auf Kunden- und/oder Entwicklerseite den Qualitätsstandard senken können, sollte die von Ihnen hier erstellte Implementierung Ihr „Meisterstück“ sein, welches zeigt, wozu Sie (im positiven Sinne) fähig sind. Es gilt hier zwar, dass Produktfehler keinen erheblichen wirtschaftlichen Schaden verursachen können oder gar Menschenleben gefährden können; jedoch ist auch hier Ihre Arbeit in der Regel nicht isoliert und „nur“ Teil Ihrer Ausarbeitung, sondern etwas, was andere anwenden und weiterentwickeln sollen. Die Qualität (und Benotung) Ihrer Arbeit wird (unter anderem) an der Qualität Ihrer Entwicklung gemessen. 125 125 126 -Zur Verdeutlichung: wenn Ihre Arbeit eine Machbarkeitsstudie (//proof of concept//) sein soll, bedeutet dies, dass Sie Ihre Arbeit **in Absprache mit dem Betreuer** auf eine wohldefinierte Teilmenge des Gesamtproblems einschränken sollen. Es sollte für den Anwender klar erkennbar und vorhersagbar sein, was Ihre Implementierung leistet und was nicht. Sinnvolle Einschränkungen können zum Beispiel sein: „die Transformation betrachtet nur //pure signals//, keine //valued signals// ... Es können keine hierarchieübergreifenden Transitionen gezeichnet werden“. Keine sinnvolle Einschränkung ist: „Mal funktioniert das Einfügen eines Zustands - mal stürzt das System ab .“ Wenn im Laufe Ihrer Implementierungsarbeit ersichtlich wird, dass bestimmte Implementierungsziele nicht erreicht werden können (aufgrund falscher Einschätzung des Problems, oder aufgrund schlechter Ressourcenplanung), sollte sofort mit dem Betreuer abgesprochen werden, wie das Problem sinnvollerweise eingeschränkt werden könnte; es sollte nicht zu einer schlampigen Entwicklung führen. Schließlich gilt: es ist für etwaige Teamkollegen/Nachfolger von Ihnen eine wesentlich dankbarere Aufgabe, auf Ihrer kleinen, sauber entwickelten Arbeit aufzusetzen und diese um neue Features zu erweitern, als zu versuchen, Ihre große, defekte Arbeit auf einen brauchbaren Qualitätsstandard anzuheben - oder diese ganz wegzuschmeißen und von vorne anzufangen.119 +Zur Verdeutlichung: wenn Ihre Arbeit eine Machbarkeitsstudie (//proof of concept//) sein soll, bedeutet dies, dass Sie Ihre Arbeit **in Absprache mit dem Betreuer** auf eine wohldefinierte Teilmenge des Gesamtproblems einschränken sollen. Es sollte für den Anwender klar erkennbar und vorhersagbar sein, was Ihre Implementierung leistet und was nicht. Sinnvolle Einschränkungen können zum Beispiel sein: „die Transformation betrachtet nur //pure signals//, keine //valued signals// ... Es können keine hierarchieübergreifenden Transitionen gezeichnet werden“. Keine sinnvolle Einschränkung ist: „Mal funktioniert das Einfügen eines Zustands - mal stürzt das System ab“. Wenn im Laufe Ihrer Implementierungsarbeit ersichtlich wird, dass bestimmte Implementierungsziele nicht erreicht werden können (aufgrund falscher Einschätzung des Problems, oder aufgrund schlechter Ressourcenplanung), sollte sofort mit dem Betreuer abgesprochen werden, wie das Problem sinnvollerweise eingeschränkt werden könnte; es sollte nicht zu einer schlampigen Entwicklung führen. Schließlich gilt: es ist für etwaige Teamkollegen/Nachfolger von Ihnen eine wesentlich dankbarere Aufgabe, auf Ihrer kleinen, sauber entwickelten Arbeit aufzusetzen und diese um neue Features zu erweitern, als zu versuchen, Ihre große, defekte Arbeit auf einen brauchbaren Qualitätsstandard anzuheben - oder diese ganz wegzuschmeißen und von vorne anzufangen. 127 127 128 128 Grundsätzlich gilt: Die Software ist „sauber“ zu schreiben und zu dokumentieren, unter Beachtung eines evtl. vorhandenen Projekthandbuchs. Die Qualität und Leserlichkeit Ihrer Software sowie der Dokumentation geht in die Bewertung Ihrer Arbeit mit ein. 129 129 130 -(% style="" %) 131 131 === Reviews und Ratings[[url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#ReviewsundRatings||style="text-decoration: none;" title="Link to this section" shape="rect" class="anchor"]] === 132 132 133 -Ist die Implementierung Teil des KIELER Projekts, so müssen zur Erhaltung des Qualitätsstandards Design und Code Reviews durchgeführt werden. Wie dies praktisch abläuft und wie die sich daraus ergebenden Ratings aussehen wird auf der KIELER Projektseite erläutert [[(% class="icon" %) (%%)https:~~/~~/rtsys.informatik.uni-kiel.de/trac/kieler/wiki/Help/SoftwarePractice/Reviews>>url:https://rtsys.informatik.uni-kiel.de/trac/kieler/wiki/Help/SoftwarePractice/Reviews||style="text-decoration: none;" shape="rect" class="ext-link"]].125 +Ist die Implementierung Teil des KIELER Projekts, so müssen zur Erhaltung des Qualitätsstandards Design und Code Reviews durchgeführt werden. Wie dies praktisch abläuft und wie die sich daraus ergebenden Ratings aussehen wird auf der KIELER Projektseite erläutert. 134 134 135 -Alle Java-Klassen die Teil der Implementierung sind müssen nach Abschluss der studentischen Arbeit zumindest die Rating Stufe //yellow// erreicht haben. Die Stufe //green// ist wünschenswert, da sie einen Nachweis einiger der im vorigen Abschnitt genannten Anforderungen bietet, aber nicht zwingend erforderlich. Die Stufe //blue// zu erreichen ist innerhalb des Zeitraums der studentischen Arbeit nicht möglich, weil dies eine mittelfristige Bewährung der Implementierung innerhalb des KIELER Projekts voraussetzt. 136 - 137 -(% style="" %) 138 138 == Hinweise zur Ausarbeitung[[url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#HinweisezurAusarbeitung||style="text-decoration: none;" title="Link to this section" shape="rect" class="anchor"]] == 139 139 140 -(% style="" %) 141 141 === Umfang[[url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#Umfang||style="text-decoration: none;" title="Link to this section" shape="rect" class="anchor"]] === 142 142 143 143 Folgendes sind grobe Richtwerte für den Umfang der Arbeit, ohne Titelseite, Inhalts-/Abbildungsverzeichnis, leere Seiten, Bibliographie, Anhänge, etc. ... ... @@ -145,11 +145,12 @@ 145 145 * Studien-/Bachelorarbeit: 30-50 Seiten. 146 146 * Diplom-/Masterarbeit: 70-120 Seiten. 147 147 148 -(% style="" %) 149 149 === Sprache der Arbeit[[url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#SprachederArbeit||style="text-decoration: none;" title="Link to this section" shape="rect" class="anchor"]] === 150 150 151 -Sie können die Arbeit auf Deutsch oder Englisch verfassen. Falls Sie die Arbeit nicht in Ihrer Muttersprache schreiben, wäre es hilfreich, wenn ein muttersprachlicher (oder ähnlich qualifizierter) Korrekturleser Ihre Arbeit auf sprachliche Richtigkeit korrigieren könnte, bevor Sie die Arbeit Ihrem Betreuer geben. Software sollte generell auf Englisch geschrieben werden - d.h., Kommentare, Variablen-/Klassen-/Paketnamen etc. sollten englisch sein.138 +Sie können die Arbeit auf Deutsch oder Englisch verfassen. Falls Sie die Arbeit nicht in Ihrer Muttersprache schreiben, wäre es hilfreich, wenn ein muttersprachlicher (oder ähnlich qualifizierter) Korrekturleser Ihre Arbeit auf sprachliche Richtigkeit korrigieren könnte, bevor Sie die Arbeit Ihrem Betreuer geben. 152 152 140 +Software sollte generell auf Englisch geschrieben werden - d.h., Kommentare, Variablen-/Klassen-/Paketnamen etc. sollten englisch sein. 141 + 153 153 ==== Hinweise für englischsprachige Arbeiten[[url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#HinweisefürenglischsprachigeArbeiten||style="text-decoration: none;" title="Link to this section" shape="rect" class="anchor"]] ==== 154 154 155 155 * Lesen und beherzigen Sie Strunk & White (siehe unten). ... ... @@ -195,11 +195,14 @@ 195 195 196 196 >„The following section illustrates .... In Section 2.3, we describe .... This chapter includes too many sections.“ 197 197 198 -(% style="" %) 199 199 === Allgemeine Hinweise[[url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#AllgemeineHinweise||style="text-decoration: none;" title="Link to this section" shape="rect" class="anchor"]] === 200 200 201 -Grundsätzlich steht es Ihnen frei, wie Sie Ihre Arbeit erstellen - mit [[(% class="icon" %) (%%)LaTeX>>url:http://de.wikipedia.org/wiki/LaTeX||style="text-decoration: none;" shape="rect" class="ext-link"]] oder einem Office-Paket (oder auch handschriftlich). Es wird jedoch dringend nahe gelegt, LaTeX zu verwenden, da hiermit auch größere Arbeiten mit umfangreichen Querverweisen etc. (relativ) problemlos zu erstellen sind und ein konsistent gutes Layout erzeugt werden kann. Auch gibt es hierzu eine recht umfassende technische Unterstützung, incl. Templates und einer gemeinsam gepflegten Bibliographie-Datenbank. In folgenden Hinweisen wird deswegen angenommen, dass Sie LaTeX verwenden, sowie BibTeX für die Bibliographie. Beides wird weiter unten erläutert. Sollten Sie nicht LaTeX verwenden, bzw. nicht die hier zur Verfügung gestellten Templates, ist eine technische Unterstützung Ihrer Arbeit nur eingeschränkt möglich.189 +Grundsätzlich steht es Ihnen frei, wie Sie Ihre Arbeit erstellen - mit [[(% class="icon" %) (%%)LaTeX>>url:http://de.wikipedia.org/wiki/LaTeX||style="text-decoration: none;" shape="rect" class="ext-link"]] oder einem Office-Paket (oder auch handschriftlich). Es wird jedoch dringend nahe gelegt, LaTeX zu verwenden, da hiermit auch größere Arbeiten mit umfangreichen Querverweisen etc. (relativ) problemlos zu erstellen sind und ein konsistent gutes Layout erzeugt werden kann. Auch gibt es hierzu eine recht umfassende technische Unterstützung, incl. Templates und einer gemeinsam gepflegten Bibliographie-Datenbank. In folgenden Hinweisen wird deswegen angenommen, dass Sie LaTeX verwenden, sowie BibTeX für die Bibliographie. Beides wird weiter unten erläutert. 202 202 191 +Das Layout Ihrer Arbeit sollte der Kiel Computer Science Series (KCSS) entsprechen. Auf der KCSS-Seite sind ein LaTeX-Stylefile und umfangreiche Dokumentation hierzu verfügbar. 192 + 193 +Sollten Sie nicht LaTeX verwenden, bzw. nicht den KCSS-Style, ist eine technische Unterstützung Ihrer Arbeit nur eingeschränkt möglich. 194 + 203 203 Um ggf. elektronischen Zugang auf Ihre sowie anderweitige weitere Nutzung Ihrer Arbeit zu ermöglichen, sollten eine PDF-Version, sowie auch die LaTeX-Sourcen, Graphiken, etc., im Subversion-System der Gruppe eingecheckt werden. 204 204 205 205 ==== Rechtschreibprüfung[[url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#Rechtschreibprüfung||style="text-decoration: none;" title="Link to this section" shape="rect" class="anchor"]] ==== ... ... @@ -465,7 +465,6 @@ 465 465 * Wesentliche Teile, die im Text wichtig sind, nicht im Anhang verstecken. 466 466 * Anleitungen (z.B. //How-To//s) gehören in den Anhang. 467 467 468 -(% style="" %) 469 469 === Technische Umsetzung[[url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#TechnischeUmsetzung||style="text-decoration: none;" title="Link to this section" shape="rect" class="anchor"]] === 470 470 471 471 ==== Editor/IDE[[url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#EditorIDE||style="text-decoration: none;" title="Link to this section" shape="rect" class="anchor"]] ==== ... ... @@ -548,12 +548,10 @@ 548 548 549 549 Note: The name of this file should follow the canonical naming scheme used in subversion ([[Subversion/Structure >>url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Subversion/Structure||style="text-decoration: none;" shape="rect" class="wiki"]]), even if your thesis is for some reason not in the subversion system. 550 550 551 -(% style="" %) 552 552 === Source Code[[url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#SourceCode||style="text-decoration: none;" title="Link to this section" shape="rect" class="anchor"]] === 553 553 554 554 Von Ihnen im Laufe der Arbeit entwickelte Software (oder Hardware-Beschreibungen) sind Teil Ihrer Arbeit. Dies bedeutet: Die Software sollte als Listing in Ihrer Ausarbeitung erscheinen; typischerweise (wenn es sich um mehr als ca. zwei Seiten handelt) als Anhang, mit angemessen kleiner Schriftgröße, evt. zweispaltig. Es sollte eine Übersicht über die Software in geeigneter Form gegeben werden, z.B. in Form von Klassendiagrammen mit Erläuterungen. Hinweise zum Einbinden von Code in LaTeX finden sich in dem[[(% class="icon" %) (%%)Beispieldokument>>url:http://www.informatik.uni-kiel.de/~~rt-kiel/kiel/documents/papers/example.tar.gz||style="text-decoration: none;" shape="rect" class="ext-link"]] (s.o.). 555 555 556 -(% style="" %) 557 557 == Hinweise zur Benotung[[url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#HinweisezurBenotung||style="text-decoration: none;" title="Link to this section" shape="rect" class="anchor"]] == 558 558 559 559 Die Benotung studentischer Arbeiten richtet sich zunächst nach der jeweils anzuwendenen Studienordnung; für eine Diplomarbeit im Diplomstudiengang Informatik sieht z.B. §20(2) der Diplomprüfungsordnung vor: „Die Diplomarbeit ist von der Lehrkraft, die sie ausgegeben hat und einer oder einem weiteren Prüfungsberechtigten zu beurteilen.“ ... ... @@ -758,7 +758,6 @@ 758 758 24 759 759 ))) 760 760 761 -(% style="" %) 762 762 == Weiterführende Hinweise[[url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#WeiterführendeHinweise||style="text-decoration: none;" title="Link to this section" shape="rect" class="anchor"]] == 763 763 764 764 * Eine sehr zu empfehlende, einführende Veranstaltung zur Präsentation und Erstellung wissenschaftlicher Arbeiten („Dokumentieren und Präsentieren“) bietet regelmäßig (ca. alle zwei Jahre) Prof. Luttenberger am Lehrstuhl für [[(% class="icon" %) (%%)Kommunikationssysteme>>url:http://www.comsys.informatik.uni-kiel.de/||style="text-decoration: none;" shape="rect" class="ext-link"]] an.
- Confluence.Code.ConfluencePageClass[0]
-
- Id
-
... ... @@ -1,1 +1,1 @@ 1 -7700 8701 +7700963 - URL
-
... ... @@ -1,1 +1,1 @@ 1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/RTSYS/pages/7700 870/Hinweisezur Anfertigungvon Abschlussarbeiten1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/RTSYS/pages/7700963/Writing and Grading Theses