<
From version < 35.1 >
edited by cmot
on 2023/07/06 13:59
To version < 23.1 >
edited by cds
on 2014/09/01 11:10
>
Change comment: There is no comment for this version

Summary

Details

Page properties
Parent
... ... @@ -1,1 +1,0 @@
1 -Writing Guides
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.cmot
1 +XWiki.cds
Content
... ... @@ -15,7 +15,7 @@
15 15  
16 16  = Interaction With Your Adviser(s) =
17 17  
18 -A good interaction with your adviser(s) is key to success. Unless you happen to have substantial work experience and to already be an expert in your field, your adviser is ahead of you in terms of experience and expertise. Take advantage of this to improve your own work.
18 +A good interaction with your adviser(s) is key to success. Unless you happen to have substantial work experience and to be already an expert in your field, your adviser is ahead of you in terms of experience and expertise. Take advantage of this to improve your own work.
19 19  
20 20  Advisers are humans. They like to help you with your thesis topic; they don't like to have to "drive" it, or to get the feeling that their advice (including the hints on this page) is ignored. You, and not your adviser, should be the one who is pushing your work, asking questions, initiating discussions, and handing over thesis/chapter drafts without having to be explicitly asked for it. In short, your adviser should be convinced that your work is on track.
21 21  
... ... @@ -23,32 +23,17 @@
23 23  
24 24  Usually, your thesis is a full-time job, also meaning **full-time presence at your desk**. In case you also have other regular work to do, discuss this with your adviser at the beginning of your thesis work.
25 25  
26 -= Thesis Proposal =
27 -
28 -The first thing to do after you familiarized yourself with the topic and problem of your thesis is to write a short proposal (~~2-4 pages). The proposal should be prepared as early as possible (within the first or second week) and should show your adviser that you understood the problem and have a rough idea how to solve it. It may be structured as follows.
29 -
30 -* Problem description
31 -* Planned Solutions/Goals
32 -** Hard requirements that have to be fulfilled by the end of your thesis
33 -** Soft requirements that can be solved if time permits
34 -* Schedule outlining your proceeding (this includes writing the thesis, see next section)
35 -
36 -You should send your thesis proposal to your advisor and (if he is not already your advisor) the professor. After you finished the proposal, you should give a short (informal) talk of about 15 minutes during our daily tea meeting presenting your topic to all members of our group.
37 -
38 38  = Timing is (Almost) Everything =
39 39  
40 -Technically, the only hard deadline that you have regarding your thesis submission is the one concerning the submission to the examination office (//Prüfungsamt//), which is at the end of the semester for Bachelor thesis and six months after registering the thesis for master thesis. However, at RTSYS (as with most other groups) we offer to look at your thesis before the official submission. This not only helps to improve your thesis, it also is more satisfying for the advisor to look at a thesis in detail if it's not just to determine a grade but also to help improve the result.
28 +Chances are your adviser has already supervised one or more theses. Take advantage of his or her experience! Send him drafts of the chapters of your thesis before submitting the final thesis. Of course, the drafts should be as good as possible from your point of view. Your adviser can only improve your drafts so much. If your draft is of low quality, (s)he can help you push it to an okay-ish level; but if the draft is already of high-quality to start with, (s)he can help you elevate it to pure awesomeness. Note that your drafts need not be complete yet: you can always hand in missing bits and pieces later on. Here's a schedule that has proven to work well regarding when to hand in what.
41 41  
42 -Thus, in your own interest, we advise //strongly// to send drafts of the chapters of your thesis to your advisor(s) before submitting the final thesis. Of course, the drafts should be as good as possible from your point of view. Your adviser can only improve your drafts so much. If your draft is of low quality, they can help you push it to an okay-ish level; but if the draft is already of high-quality to start with, they can help you elevate it to pure awesomeness. Note that your drafts need not be complete yet: you can always hand in missing bits and pieces later on.
43 -
44 -The process is usually that 1) you send a draft to the doctoral student(s) directly advising you, 2) you get feedback from them, 3) you implement that feedback, 4) you send the revised draft to the Prof. Yes, this pipeline takes time, and often there are holidays and travel plans to take into account as well, in particular for deadlines at the end of the summer semester. Here's a schedule that has proven to work well regarding when to hand in what to your direct advisors. Of course, sticking to that schedule is YOUR responsibility, you should not rely on your advisors to remind you of it.
45 -
46 -(% class="wrapped" %)
47 47  |=(((
48 48  What
49 49  )))|=(((
50 -When (AT THE LATEST)
33 +Master's Thesis
51 51  )))|=(((
35 +Bachelor's Thesis
36 +)))|=(((
52 52  Motivation
53 53  )))
54 54  |(((
... ... @@ -56,6 +56,8 @@
56 56  )))|(((
57 57  3 months before final submission
58 58  )))|(((
44 +6 weeks
45 +)))|(((
59 59  Once you are halfway through your thesis, you should have a basic idea of which topics you want to cover in your thesis. This must be discussed with your adviser.
60 60  )))
61 61  |(((
... ... @@ -63,6 +63,8 @@
63 63  )))|(((
64 64  4 weeks
65 65  )))|(((
53 +3 weeks
54 +)))|(((
66 66  The first drafts you submit are used to make you aware of basic problems of your writing style. Getting this feedback as early as possible in your writing process means that you won't have to change the whole thesis after you submit your final draft.
67 67  )))
68 68  |(((
... ... @@ -70,7 +70,9 @@
70 70  )))|(((
71 71  2 weeks
72 72  )))|(((
73 -Submitting a draft of your complete thesis **before** the final submission gives your adviser enough time to find problems and gives you enough time to incorporate corrections into your final thesis.
62 +10 days
63 +)))|(((
64 +Submitting a draft of your complete thesis **before** the final submission gives your adviser enough time to find problems and gives you enough time to incorporate corrections into your final thesis. This doesn't only improve the quality of your thesis, but also satisfies your adviser.
74 74  )))
75 75  
76 76  Theses done in collaboration with industry partners follow the same schedule. The drafts you submit to your adviser at the university, however, should previously be run past your industry adviser.
... ... @@ -81,35 +81,34 @@
81 81  
82 82  = Implementations =
83 83  
84 -The first rule of your implementation is: **"No Crashes!"** The second rule of your implementation is: **"No crashes!"** Regardless of what your code does and regardless of what the user does, your implementation should neither crash nor freeze. Whenever you make assumptions, be sure to explicitly check them. If they are not met, your code should generate (useful!) error messages instead of crashing and the user should be able to continue working with it.
75 +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.
85 85  
86 -Since you're working in an academic context, you will have less resources (less time, in particular) available than in a commercial setting. Also, your work probably won't have to compete with commercial applications. It follows that everything you develop will be less comprehensive and will have less features than a commercial product. What doesn't follow is that your implementation should be less meticulous or less documented than in a professional setting. Quite the contrary, in fact: commercially developed code often suffers from tight deadlines, the need to add new features, and at times a certain ignorance. You implementation, on the other hand, is supposed to be your masterpiece. It should reflect what you're currently capable of. Even though your software won't cause considerable economical damage or kill people, it probably won't exist in isolation. It will much rather be part of the KIELER project, which other people are supposed to use or develop further. The quality (and grade) of your thesis will be judged in part based on your implementation. Since this is the case, make use of the fact that your adviser probably has much more experience writing code than you do. Ask him or her to review your code and to give you feedback on how to improve.
77 +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.
87 87  
88 -Let's look at an example. Suppose your thesis is a proof of concept. This means that you should constrain the goals of your thesis (**in accordance with your adviser**) to a well-defined subset of the problem you're tackling. The end user should be well aware of what your implementation can do and what it cannot do. A reasonable constraint could for instance be: "The transformation only works for //pure signals//, not for //valued signals//. Hierarchy-crossing transitions cannot be drawn." An unreasonable constraint could be: "Sometimes, adding a state works; other times, the software crashes." If you notice while working on your implementation that you won't be able to make certain goals, talk to your adviser. Together, you will constrain the problem further. This will allow you to solve the more constrained problem properly instead of not solving the more general problem at all. You colleagues or successors will be glad to be able to start from a smaller, but well-developed code base and add features to it instead of having to try to get your code to a reasonable quality standard — or throwing it away and starting over.
79 +Zur Verdeutlichung: wenn Ihre Arbeit eine Machbarkeitsstudie (//proof of concept//) sein soll, bedeutet dies, dass Sie Ihre Arbei**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//, kein//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 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.
89 89  
90 -The bottom line: write clean and proper code that adheres to our coding guidelines and document it. The quality and the readability of your code and of your documentation will influence your grade.
81 +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.
91 91  
92 -== Reviews and Ratings ==
83 +== Reviews and 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"]] ==
93 93  
94 -To make sure that code is of a certain quality, it must be run through design and code reviews. The way this works is explained [[on this page>>doc:KIELER.Review Process]]. The reviews are not only intended to improve the quality of your code, but also to give feedback to you as a programmer to help you improve.
85 +More often than not, you will write code as part of your thesis. To make sure that code is of a certain quality, it must be run through design and code reviews. The way this works is explained [[on this page>>doc:KIELER.Review Process]]. The reviews are not only intended to improve the quality of your code, but also to give feedback to you as a programmer to help you improve.
95 95  
96 96  = What Grade Do I Get For All This? =
97 97  
98 -Zur Beurteilung einer Abschlussarbeit wird generell ein schriftliches Gutachten erstellt, welches die jeweilige Arbeit individuell 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. §11(5) der Bachelorprüfungsordnung vor: „Die Note der Bachelorarbeit berücksichtigt die Problembearbeitung, die Bachelorarbeit und den Abschlussvortrag einschließlich der sich anschließenden Aussprache."
89 +Die Benotung studentischer Arbeiten richtet sich zunächst nach der jeweils anzuwendenen Studienordnung; 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.
99 99  
100 -Ein etwas detaillierterer Kriterien-/Bewertungskatalog ist in den beiden folgenden Tabellen angegeben. Diese sind zunächst für Bachelorarbeiten ausgelegt, finden aber - mit entsprechenden Abwandlungen - auch für Masterarbeiten Anwendung.
91 +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.
101 101  
102 -(% class="wrapped" %)
103 103  |(((
104 104  **Merkmal**
105 105  )))|(((
106 -\\
96 +
107 107  )))|(((
108 -\\
98 +
109 109  )))|(((
110 -\\
100 +
111 111  )))|(((
112 -\\
102 +
113 113  )))|(((
114 114  **Punkte**
115 115  )))
... ... @@ -124,7 +124,7 @@
124 124  )))|(((
125 125  Vollständige, gute Lösung und Behandlung zusätzlicher Fragestellungen
126 126  )))|(((
127 -\\
117 +
128 128  )))
129 129  |(((
130 130  Punkte
... ... @@ -164,9 +164,9 @@
164 164  max. 24
165 165  )))
166 166  |(((
167 -//Interaktion mit Betreuer//
157 +//Anwesenheit und Interaktion mit Betreuer//
168 168  )))|(((
169 -Interaktion nur auf Initiative des Betreuers; schwer erreichbar; selten anwesend, weist nicht auf Probleme hin
159 +Selten anwesend, Interaktion nur auf Initiative des Betreuers; schwer erreichbar; weist nicht auf Probleme hin
170 170  )))|(((
171 171  Unregelmäßige Interaktion, jedoch generell erreichbar und häufig anwesend
172 172  )))|(((
... ... @@ -212,7 +212,7 @@
212 212  max. 16
213 213  )))
214 214  |(((
215 -//Aufbau und sprachliche Qualität der Ausarbeitung//
205 +//Qualität der Ausarbeitung//
216 216  )))|(((
217 217  Ausarbeitung mit schweren Mängeln: fehlende Systematik, Schreibfehler, schlechtes Deutsch, unübersichtliche Verzeichnisse usw.
218 218  )))|(((
... ... @@ -236,13 +236,13 @@
236 236  max. 16
237 237  )))
238 238  |(((
239 -\\
229 +
240 240  )))|(((
241 -\\
231 +
242 242  )))|(((
243 -\\
233 +
244 244  )))|(((
245 -\\
235 +
246 246  )))|(((
247 247  **Summe**
248 248  )))|(((
... ... @@ -251,7 +251,6 @@
251 251  
252 252  Die Umrechnung einer Punktzahl in eine Zensur ergibt sich unter Anwendung dieses Katalogs aus der folgenden Tabelle.
253 253  
254 -(% class="wrapped" %)
255 255  |(((
256 256  Note
257 257  )))|(((
... ... @@ -299,10 +299,6 @@
299 299  24
300 300  )))
301 301  
302 -= RtSys Stammtisch =
303 -
304 -Every student who is going to write a thesis and hence is considered an integral part of our group is more than welcome to join our [[doc:RTSYS.Rtsys Group Wiki.RtSys Stammtisch.WebHome]]. We will meet monthly in different restaurants in Kiel to have dinner and a good time together. Please ask your advisor or other students to invite you
305 -
306 306  = Further Links =
307 307  
308 308  * Prof. Luttenberger at the [[Communication Systems Group>>url:http://www.comsys.informatik.uni-kiel.de/||shape="rect"]] regularly offers a very good course on writing and presenting scientific work.
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -6160527
1 +9471804
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/RTSYS/pages/6160527/Writing and Grading Theses
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/RTSYS/pages/9471804/Writing and Grading Theses