Show last authors
1 //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.//
2
3 **Table of Contents**
4
5
6
7 {{toc/}}
8
9
10
11 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 Bachelor-/Master-/Studien-/Diplomarbeiten. Die Hinweise können aber auch bei der Anfertigung von Praktikumsberichten - oder auch Promotionsarbeiten - hilfreich sein.
12
13 = 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"]] =
14
15 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.
16
17 Betreuer sind auch Menschen. Sie helfen Ihnen gerne bei der inhaltlichen Arbeit; weniger gerne spielen sie "Antreiber", oder haben das Gefühl, dass ihre Hinweise/Ratschläge/Informationen (incl. der Hinweise auf dieser Seite) nicht wirklich Gehör finden. Grundsätzlich sollten Sie selbst es sein, welcher Ihre Arbeit vorantreibt, Fragen stellt, Besprechungen initiiert, Ihrem Betreuer unaufgefordert Leseproben zukommen lässt. Kurzum, der Betreuer sollte überzeugt sein, dass Ihre Arbeit "läuft".
18
19 Grundlage einer guten Kommunikation mit dem Betreuer ist erfahrungsgemäß Ihre Präsenz vor Ort. Wir sind normalerweise in der Lage, Ihnen einen Arbeitsplatz am Lehrstuhl einzuräumen, typischerweise im Labor. Sie sollten diesen Arbeitsplatz für Ihre Arbeit nutzen, und **nicht** den heimischen PC. So ergibt sich ganz von selbst ein regelmäßiger, oft informeller Austausch, z.B. im Rahmen der üblichen "Lehrstuhl-Teerunde", täglich 9:30 im Labor, zu der auch Sie herzlich eingeladen sind.
20
21 Eine Ausnahme sind Arbeiten, welche in Zusammenarbeit mit einem Industrieunternehmen angefertigt werden. Diese werden in der Regel fachlich primär von dort betreut und Sie sollten Ihren Arbeitsplatz bei dem Unternehmen haben. Hier sollten Sie den universitären Betreuer mit regelmäßigen Fortschrittsberichten (E-Mail alle 4-6 Wochen) über den Fortgang Ihrer Arbeiten informieren.
22
23 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.
24
25 = 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"]] =
26
27 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:
28
29 |=(((
30 Aktion
31 )))|=(((
32 Masterarbeit/Diplomarbeit
33 )))|=(((
34 Bachelorarbeit/Studienarbeit
35 )))|=(((
36 Idee
37 )))
38 |(((
39 Gliederung
40 )))|(((
41 3 Monate vor Abgabe
42 )))|(((
43 6 Wochen vor Abgabe
44 )))|(((
45 Zur Halbzeit sollte man schon einen Plan haben, welche Themen in der Arbeit grundsätzlich diskutiert werden sollen. Dies muss rechtzeitig mit dem Betreuer besprochen werden.
46 )))
47 |(((
48 1-2 Probekapitel
49 )))|(((
50 4 Wochen vor Abgabe
51 )))|(((
52 3 Wochen vor Abgabe
53 )))|(((
54 Probekapitel sollen grundsätzliche stilistische Probleme zeigen und verhindern, dass bei der Endkorrektur alles grundsätzlich anders gemacht werden muss.
55 )))
56 |(((
57 Komplette Arbeit
58 )))|(((
59 2 Wochen vor Abgabe
60 )))|(((
61 10 Tage vor Abgabe
62 )))|(((
63 Die Abgabe der kompletten Arbeit **vor** der offiziellen Abgabe dient unter anderem dazu, dass stilistische/orthographische Korrekturen noch in die Arbeit einfließen können, bevor diese offiziell abgegeben/veröffentlicht ist. Das dient nicht nur der Verbesserung der Arbeit, sondern ist auch für den Betreuer befriedigender.
64 )))
65
66 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.
67
68 = 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"]] =
69
70 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.
71
72 = 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"]] =
73
74 == 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"]] ==
75
76 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.
77
78 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.
79
80 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.
81
82 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.
83
84 == 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"]] ==
85
86 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.
87
88 = What Grade Do I Get For All This? =
89
90 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.“
91
92 Zur Beurteilung einer Diplomarbeit wird generell ein schriftliches Gutachten erstellt, welches die jeweilige Arbeit individuell würdigt (incl. Note) und an das Prüfungsamt weitergeleitet wird. Es hängt dabei von der jeweiligen Aufgabenstellung ab, welche Leistungen im Einzelfall erwartet werden; so sind z.B. die Anforderungen hinsichtlich der konkreten Umsetzung bei einer stark anwendungsbezogenen Arbeit anders als bei einer eher theoretischen Arbeit. Gewisse Anforderungen und Erwartungen hinsichtlich der Qualität der Arbeit und der Vorgehensweise des Studierenden sind jedoch allgemein gültig, und z.T. auch bereits in der jeweiligen Prüfungsordnung konkret genannt. So sieht z.B. §19(1) der Diplomprüfungsordnung vor: „Die Diplomarbeit [...] soll zeigen, dass die Kandidatin oder der Kandidat in der Lage ist, innerhalb einer vorgegebenen Frist ein Problem aus dem Fach Informatik selbständig nach wissenschaftlichen Methoden zu bearbeiten.“ Hier sind also bereits drei Kriterien genannt (Fristeinhaltung, Selbständigkeit, Wissenschaftlichkeit). Ein etwas detaillierterer Kriterien-/Bewertungskatalog ist in den beiden folgenden Tabellen angegeben. Diese sind zunächst für Diplomarbeiten ausgelegt, finden aber - mit entsprechenden Abwandlungen - auch für Studien-, Bachelor- und Masterarbeiten Anwendung.
93
94 |(((
95 **Merkmal**
96 )))|(((
97
98 )))|(((
99
100 )))|(((
101
102 )))|(((
103
104 )))|(((
105 **Punkte**
106 )))
107 |(((
108 //Qualität der Lösung//
109 )))|(((
110 Lediglich Lösungsansätze; geringes Vertrauen in die Lösung
111 )))|(((
112 Lösung von Teilproblemen
113 )))|(((
114 Vollständige Lösung; gutes Vertauen in die Lösung
115 )))|(((
116 Vollständige, gute Lösung und Behandlung zusätzlicher Fragestellungen
117 )))|(((
118
119 )))
120 |(((
121 Punkte
122 )))|(((
123 1 - 7
124 )))|(((
125 8 - 14
126 )))|(((
127 15 - 21
128 )))|(((
129 22 - 28
130 )))|(((
131 max. 28
132 )))
133 |(((
134 //Wissenschaftliche Arbeitstechnik//
135 )))|(((
136 Systemlose Durchführung; nur Literatur aus dem engsten Umfeld
137 )))|(((
138 Entwicklung einer Systematik erst nach Drängen des Betreuers; geringes Literaturvolumen
139 )))|(((
140 Selbständige Aufarbeitung der relevanten Literatur; grobe Einordung der Ergebnisse in das wissenschaftliche Umfeld
141 )))|(((
142 Selbständige und strukturierte Erfassung des Standes der Technik und der Literatur; systematische Einordung der Ergebnisse
143 )))
144 |(((
145 Punkte
146 )))|(((
147 1 - 6
148 )))|(((
149 7 - 12
150 )))|(((
151 13 - 18
152 )))|(((
153 19 - 24
154 )))|(((
155 max. 24
156 )))
157 |(((
158 //Anwesenheit und Interaktion mit Betreuer//
159 )))|(((
160 Selten anwesend, Interaktion nur auf Initiative des Betreuers; schwer erreichbar; weist nicht auf Probleme hin
161 )))|(((
162 Unregelmäßige Interaktion, jedoch generell erreichbar und häufig anwesend
163 )))|(((
164 Regelmäßige, selbst initiierte Interaktion; Stand der Arbeit generell nachvollziehbar
165 )))|(((
166 Informiert Betreuer regelmäßig über Stand der Arbeit; weist umgehend auf aufgetretene Probleme oder erreichte Zwischenziele hin; regelmäßige Anwesenheit
167 )))
168 |(((
169 Punkte
170 )))|(((
171 1 - 4
172 )))|(((
173 5 - 8
174 )))|(((
175 9 - 12
176 )))|(((
177 13 - 16
178 )))|(((
179 max. 16
180 )))
181 |(((
182 //Eigeninitiative und Zielstrebigkeit//
183 )))|(((
184 Geht schwierigen Problemen aus dem Weg; mangelnder zeitlicher Einsatz; Zeitplan wird deutlich überzogen
185 )))|(((
186 Teilweise Eigeninitiative; Zeitplan im Wesentlichen eingehalten
187 )))|(((
188 Ziel wurde mit großer Eigeninitiative erreicht; Zeitplan wurde eingehalten
189 )))|(((
190 Eigeninitiative bei der Entwicklung der Thematik, auch bei schwierigen Problemen; Zielbewusste Zeiteinteilung
191 )))
192 |(((
193 Punkte
194 )))|(((
195 1 - 4
196 )))|(((
197 5 - 8
198 )))|(((
199 9 - 12
200 )))|(((
201 13 - 16
202 )))|(((
203 max. 16
204 )))
205 |(((
206 //Qualität der Ausarbeitung//
207 )))|(((
208 Ausarbeitung mit schweren Mängeln: fehlende Systematik, Schreibfehler, schlechtes Deutsch, unübersichtliche Verzeichnisse usw.
209 )))|(((
210 Nur teilweise systematische Darstellung der Ergebnisse; Weitschweifigkeiten oder Knappheiten, aber akzeptable Gestaltung
211 )))|(((
212 Systematische, einleuchtende Gliederung, aber leichte Schwächen in Sprache und Gestaltung
213 )))|(((
214 Systematische Gliederung, flüssige Sprache, Bilder mit klarer Aussage, deutliche Darlegung der Zusammenhänge und Ergebnisse
215 )))
216 |(((
217 Punkte
218 )))|(((
219 1 - 4
220 )))|(((
221 5 - 8
222 )))|(((
223 9 - 12
224 )))|(((
225 13 - 16
226 )))|(((
227 max. 16
228 )))
229 |(((
230
231 )))|(((
232
233 )))|(((
234
235 )))|(((
236
237 )))|(((
238 **Summe**
239 )))|(((
240 max. 100
241 )))
242
243 Die Umrechnung einer Punktzahl in eine Zensur ergibt sich unter Anwendung dieses Katalogs aus der folgenden Tabelle.
244
245 |(((
246 Note
247 )))|(((
248 1,0
249 )))|(((
250 1,3
251 )))|(((
252 1,7
253 )))|(((
254 2,0
255 )))|(((
256 2,3
257 )))|(((
258 2,7
259 )))|(((
260 3,0
261 )))|(((
262 3,3
263 )))|(((
264 3,7
265 )))|(((
266 4,0
267 )))
268 |(((
269 Mindestpunktzahl
270 )))|(((
271 96
272 )))|(((
273 88
274 )))|(((
275 80
276 )))|(((
277 72
278 )))|(((
279 64
280 )))|(((
281 56
282 )))|(((
283 48
284 )))|(((
285 40
286 )))|(((
287 32
288 )))|(((
289 24
290 )))
291
292 = 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"]] =
293
294 * 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.
295 * „Einige typographische Grundregeln und ihre Umsetzung in LaTeX“ von [[(% class="icon" %) (%%)Werner Struckmann>>url:http://www.cs.tu-bs.de/ips/struck/index.html||style="text-decoration: none;" shape="rect" class="ext-link"]] (TU Braunschweig), [[(% class="icon" %) (%%)PDF>>url:http://www.cs.tu-bs.de/ips/struck/unitext/typographie.pdf||style="text-decoration: none;" shape="rect" class="ext-link"]]
296 * „Anmerkungen zur Rechtschreibung“ von [[(% class="icon" %) (%%)Werner Struckmann>>url:http://www.cs.tu-bs.de/ips/struck/index.html||style="text-decoration: none;" shape="rect" class="ext-link"]] (TU Braunschweig), [[(% class="icon" %) (%%)PDF>>url:http://www.ips.cs.tu-bs.de/struck/unitext/rechtschreibung.pdf||style="text-decoration: none;" shape="rect" class="ext-link"]]
297 * Falls Sie die Arbeit auf englisch verfassen: eine Reihe guter Ratschläge und weiterer Querverweise (wie z.B. den klassischen Strunk & White) finden sich auf [[(% class="icon" %) (%%)Henning Schulzrinnes>>url:http://www.cs.columbia.edu/~~hgs/||style="text-decoration: none;" shape="rect" class="ext-link"]] Seite „[[(% class="icon" %) (%%)Writing Technical Articles>>url:http://www.cs.columbia.edu/~~hgs/etc/writing-style.html||style="text-decoration: none;" shape="rect" class="ext-link"]]“.
298 * [[(% class="icon" %) (%%)Wie schreibe ich eine gute Diplomarbeit?>>url:http://www.informatik.uni-oldenburg.de/studium/azwa/wie.html||style="text-decoration: none;" shape="rect" class="ext-link"]] - Eine Anleitung der Uni-Oldenburg, z.T. spezifisch für Oldenburg; auch dort gibt es noch weiterführende Links.