Changes for page Writing and Grading Theses
Last modified by Niklas Rentz on 2023/10/10 10:45
Change comment:
There is no comment for this version
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 - Hinweise zurAnfertigungundBenotungvon Abschlussarbeiten1 +Writing and Grading Theses - Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki. rvh1 +XWiki.cds - Content
-
... ... @@ -1,550 +1,103 @@ 1 - //Note: Most of this page isinGerman.Futureadditions shouldbedonein English.Atsomepoint,somegoodsoulmighttranslatetheGerman"legacydocumentation"to Englishaswell.//1 +This page is the collected wisdom and advice after supervising about 100 theses, from short study reports to dissertations. We recommend to study it **before** you start with your thesis work. Some topics are discussed on these separate pages: 2 2 3 - 4 4 5 -(% class="wiki-toc" %) 6 -((( 7 -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;" shape="rect"]] 8 -11. [[Interaktion mit dem Betreuer>>url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#InteraktionmitdemBetreuer||style="text-decoration: none;" shape="rect"]] 9 -111. [[Zeitlicher Ablauf>>url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#ZeitlicherAblauf||style="text-decoration: none;" shape="rect"]] 10 -111. [[Notizen>>url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#Notizen||style="text-decoration: none;" shape="rect"]] 11 -11. [[Hinweise zu Implementierungen>>url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#HinweisezuImplementierungen||style="text-decoration: none;" shape="rect"]] 12 -111. [[Allgemeines>>url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#Allgemeines||style="text-decoration: none;" shape="rect"]] 13 -111. [[Reviews und Ratings>>url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#ReviewsundRatings||style="text-decoration: none;" shape="rect"]] 14 -11. [[Hinweise zur Ausarbeitung>>url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#HinweisezurAusarbeitung||style="text-decoration: none;" shape="rect"]] 15 -111. [[Umfang>>url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#Umfang||style="text-decoration: none;" shape="rect"]] 16 -111. [[Sprache der Arbeit>>url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#SprachederArbeit||style="text-decoration: none;" shape="rect"]] 17 -1111. [[Hinweise für englischsprachige Arbeiten>>url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#HinweisefürenglischsprachigeArbeiten||style="text-decoration: none;" shape="rect"]] 18 -111. [[Allgemeine Hinweise>>url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#AllgemeineHinweise||style="text-decoration: none;" shape="rect"]] 19 -1111. [[Rechtschreibprüfung>>url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#Rechtschreibprüfung||style="text-decoration: none;" shape="rect"]] 20 -1111. [[Auszeichnungen - Allgemeines>>url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#Auszeichnungen-Allgemeines||style="text-decoration: none;" shape="rect"]] 21 -11111. [[Auszeichnung fremdsprachiger Ausdrücke>>url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#AuszeichnungfremdsprachigerAusdrücke||style="text-decoration: none;" shape="rect"]] 22 -11111. [[Auszeichnung von Symbolen, physikalischen Größen usw.>>url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#AuszeichnungvonSymbolenphysikalischenGrößenusw.||style="text-decoration: none;" shape="rect"]] 23 -11111. [[Auszeichnung von Programmen, Funktionsnamen usw.>>url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#AuszeichnungvonProgrammenFunktionsnamenusw.||style="text-decoration: none;" shape="rect"]] 24 -1111. [[Referenzierungen>>url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#Referenzierungen||style="text-decoration: none;" shape="rect"]] 25 -1111. [[Aufbau und Inhalt>>url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#AufbauundInhalt||style="text-decoration: none;" shape="rect"]] 26 -11111. [[Kapitel>>url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#Kapitel||style="text-decoration: none;" shape="rect"]] 27 -1111. [[Akronyme>>url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#Akronyme||style="text-decoration: none;" shape="rect"]] 28 -1111. [[Abbildungen und Listings>>url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#AbbildungenundListings||style="text-decoration: none;" shape="rect"]] 29 -1111. [[Verweise>>url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#Verweise||style="text-decoration: none;" shape="rect"]] 30 -1111. [[Allgemeine Syntax>>url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#AllgemeineSyntax||style="text-decoration: none;" shape="rect"]] 31 -1111. [[Inhaltliches und Stilistisches>>url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#InhaltlichesundStilistisches||style="text-decoration: none;" shape="rect"]] 32 -1111. [[Anhang>>url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#Anhang||style="text-decoration: none;" shape="rect"]] 33 -111. [[Technische Umsetzung>>url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#TechnischeUmsetzung||style="text-decoration: none;" shape="rect"]] 34 -1111. [[Editor/IDE>>url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#EditorIDE||style="text-decoration: none;" shape="rect"]] 35 -1111. [[Using Git>>url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#UsingGit||style="text-decoration: none;" shape="rect"]] 36 -1111. [[Das LaTeX-Paket ifiseries>>url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#DasLaTeX-Paketifiseries||style="text-decoration: none;" shape="rect"]] 37 -1111. [[Das ToDo-Paket>>url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#DasToDo-Paket||style="text-decoration: none;" shape="rect"]] 38 -1111. [[Die Erstellung einer Bibliographie>>url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#DieErstellungeinerBibliographie||style="text-decoration: none;" shape="rect"]] 39 -1111. [[Arbeit innerhalb des Lehrstuhl-Netzwerkes>>url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#ArbeitinnerhalbdesLehrstuhl-Netzwerkes||style="text-decoration: none;" shape="rect"]] 40 -1111. [[Arbeit außerhalb des Lehrstuhl-Netzwerkes>>url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#ArbeitaußerhalbdesLehrstuhl-Netzwerkes||style="text-decoration: none;" shape="rect"]] 41 -1111. [[Zugriff auf das Git-Repository der BibTeX-Datenbank>>url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#ZugriffaufdasGit-RepositoryderBibTeX-Datenbank||style="text-decoration: none;" shape="rect"]] 42 -1111. [[Publishing the thesis on-line>>url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#Publishingthethesison-line||style="text-decoration: none;" shape="rect"]] 43 -111. [[Source Code>>url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#SourceCode||style="text-decoration: none;" shape="rect"]] 44 -11. [[Hinweise zur Benotung>>url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#HinweisezurBenotung||style="text-decoration: none;" shape="rect"]] 45 -11. [[Weiterführende Hinweise>>url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#WeiterführendeHinweise||style="text-decoration: none;" shape="rect"]] 46 -))) 47 47 48 - 5 +{{children/}} 49 49 50 - Diese Seite gibt Hinweise, welche bei der Anfertigung einer studentischen Arbeitan 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 AnfertigungvonPraktikumsberichten- oder auch Promotionsarbeiten - hilfreich sein.7 +**Table of Contents** 51 51 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"]] = 53 53 54 -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. 55 55 56 - 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".11 +{{toc/}} 57 57 58 -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. 13 +//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.//** 14 +** 59 59 60 - EineAusnahme sind Arbeiten, welche in Zusammenarbeit mit einemIndustrieunternehmenangefertigt werden.Diese werden in der Regel fachlichprimär von dort betreut und Sie sollten IhrenArbeitsplatz beidem 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.16 += Interaction With Your Adviser(s) = 61 61 62 - IhreDiplomarbeitistVollzeitjob;Sie solltenalsoim NormalfalltäglichamArbeitsplatzsein. WennSie danebeneinerregelmäßigenArbeitnachgehen,solltenSiemitdemBetreuerabsprechen,wiediesmit derAnfertigung IhrerAbschlussarbeit vereinbartwerden kann.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. 63 63 64 - ===ZeitlicherAblauf[[url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#ZeitlicherAblauf||style="text-decoration:none;"title="Linktothissection"shape="rect"class="anchor"]]===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. 65 65 66 - Siesollteninsbesonderebei derAnfertigungder schriftlichenAusfertigungaufdieErfahrungendesBetreuerszugreifen.SiesolltendemBetreueralsoEntwürfeIhrerArbeitzukommenlassen,bevorSiediezubenotendeEndversioneinreichen.IhreEntwürfesolltendabeiausIhrerSichtmöglichst reifsein,müssen abernoch keineswegsvollständigsein.EinebewährteSequenzvonabzulieferndenDokumentenist:22 +Even in the age of modern communication devices, the basis of a good communication with your adviser is regular physical presence. Most of the time, we are in the fortunate position that we can provide you with a full-time desk, typically in the lab (1114/1115). Use this desk for doing your thesis work, and not your PC at home. A key communication instrument in the RTSYS group is the 9:30am tea, which you should participate in as well. One exception are theses that are done in collaboration with industry and where the industry partner provides the work space. In that case, you should keep your adviser here on track with regular progress reports. Usually, an E-mail every 2 to 4 weeks suffices for that. 67 67 68 -|((( 69 -Aktion 70 -)))|((( 71 -Masterarbeit/Diplomarbeit 72 -)))|((( 73 -Bachelorarbeit/Studienarbeit 74 -)))|((( 75 -Idee 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 + 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 +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 += Timing is (Almost) Everything = 39 + 40 +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 + 42 +|=((( 43 +What 44 +)))|=((( 45 +Master's Thesis 46 +)))|=((( 47 +Bachelor's Thesis 48 +)))|=((( 49 +Motivation 76 76 ))) 77 77 |((( 78 - Gliederung52 +Outline 79 79 )))|((( 80 -3 MonatevorAbgabe54 +3 months before final submission 81 81 )))|((( 82 -6 Wochen vor Abgabe56 +6 weeks 83 83 )))|((( 84 - ZurHalbzeitsolltemanschon einen Planhaben,welcheThemeninderArbeitgrundsätzlichdiskutiertwerdensollen.Dies mussrechtzeitigmitdem Betreuerbesprochen werden.58 +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. 85 85 ))) 86 86 |((( 87 -1 -2Probekapitel61 +1–2 chapters 88 88 )))|((( 89 -4 Wochen vor Abgabe63 +4 weeks 90 90 )))|((( 91 -3 Wochen vor Abgabe65 +3 weeks 92 92 )))|((( 93 - Probekapitelsollengrundsätzliche stilistischeProblemezeigenundverhindern,dassbeiderEndkorrekturallesgrundsätzlich andersgemachtwerdenmuss.67 +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. 94 94 ))) 95 95 |((( 96 - KompletteArbeit70 +Complete thesis 97 97 )))|((( 98 -2 Wochen vor Abgabe72 +2 weeks 99 99 )))|((( 100 -10 Tage vor Abgabe74 +10 days 101 101 )))|((( 102 - Die AbgabederkomplettenArbeit**vor**deroffiziellenAbgabe dientunteranderemdazu,dassstilistische/orthographischeKorrekturen nochindie Arbeiteinfließen können, bevordiese offiziellabgegeben/veröffentlichtist.Das dient nichtnurder Verbesserungder Arbeit,sondernistauchfür denBetreuerbefriedigender.76 +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. 103 103 ))) 104 104 105 - Für Arbeiten,welcheinZusammenarbeitmiteinem Industrieunternehmenangefertigt werden,giltdieseSequenzebenso;Siesolltenhierjedoch Entwürfe,welcheSie demuniversitärenBetreuer zukommen lassen,vorherentsprechend vonIhremBetreuerausdem Unternehmendurchsehenlassen.79 +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. 106 106 107 -= ==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"]] ===81 += Keeping Notes = 108 108 109 - MachenSiesichwährendIhrergesamtentheoretischenArbeit Notizendarüber, wasSiegeradetun, wieSies tunundinsbesondere:warumSiestun.ImMomentdes Tuns istallesnochklar,aber sobaldesans Schreibenehtwirdesnichtmehrsoklar sein. TunSiesichalsoeinen Gefallen und schreiben Sie Notizen.Die Arbeitistuchinsofernschonnichtumsonst,alsdassdie Notizen eineprimaGrundlagefürTeileIhrerschriftlichenAusarbeitungwerden.83 +A common experience: while you do your investigative/implementation work, everything is clear — until you try to write things up, weeks or months later. Thus we highly recommend to take notes along the way, eg, as part of a chapter draft of your thesis. 110 110 111 -= =Hinweise zuImplementierungen[[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"]] ==85 += Implementations = 112 112 113 - ===Allgemeines[[url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#Allgemeines||style="text-decoration:none;"title="Link tothissection"shape="rect"class="anchor"]]===87 +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. 114 114 115 - ErsteRegel: **"NoCrashes!"** Egal wasIhrSystemtutund welcheNutzereingabengeschehen,dieImplementierungsolltenichtabstürzen odereinfrieren.WoAnnahmengemachtwerden,sollten diese explizitüberprüft werden.Im FallederNichteinhaltungsollteeinebrauchbareFehlermeldunggeneriertwerden,und derAnwender sollteweitermit derImplementierung arbeiten können.89 +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. 116 116 117 - Generell:IhreArbeitwirdsehrwahrscheinlichauch einenpraktischen Teilenthalten,inwelcherSieSoftwareoderHardwareentwickeln odererweiternsollen.Das akademischeUmfeldIhrer Arbeit bedeutetinderRegel,dass fürdieseEntwicklungwenigerRessourcen- insbesonderezeitlicheRessourcen-alsin einem kommerziellen Umfeld zur Verfügung stehen,unddasssichIhre ArbeitnichtamMarktbehaupten muss. DieKonsequenz darausist,dassIhreArbeitinderRegelwenigerumfangreich seinsollteundwenigerFeaturesbietensolltealseinkommerzielles Produkt.Die Konsequenzist nicht, dassSieihre Implementierungweniger sorgfältigvornehmen sollen,oderschlechterdokumentierensollen, alsdies in einemprofessionellemUmfeldderFallwäre. ImGegenteil-währendbei kommerziellenProduktenderTermindruck, die NotwendigkeitzuständigenNeuentwicklungen,undzumTeileinegewisse IgnoranzaufKunden-und/oderEntwicklerseiteden Qualitätsstandardsenkenkönnen, solltedie von Ihnenhier erstellteImplementierungIhr „Meisterstück“sein,welcheszeigt,wozu Sie(im positivenSinne)fähigsind.Esgilt hierzwar, dass ProduktfehlerkeinenerheblichenwirtschaftlichenSchadenverursachen könnenodergar Menschenlebengefährdenkönnen;jedochistuch hierIhre Arbeitin derRegelnicht isoliertund„nur“ TeilIhrer Ausarbeitung,sondernetwas,was andereanwenden undweiterentwickelnsollen.Die Qualität(undBenotung)IhrerArbeitwird(unteranderem)anderQualitätIhrerEntwicklunggemessen.91 +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. 118 118 119 - Zur Verdeutlichung: wennIhre ArbeiteineMachbarkeitsstudie(//proof ofconcept//) sein soll, bedeutet dies, dass Sie Ihre Arbeit **inAbsprache mit dem Betreuer** auf eine wohldefinierteTeilmenge des Gesamtproblems einschränkensollen. Es sollte fürdenAnwender klarerkennbar undvorhersagbar sein, wasIhre Implementierungleistetundwas nicht. Sinnvolle Einschränkungenkönnen zum Beispiel sein: „dieTransformation betrachtet nur //pure signals//, keine//valuedsignals// ...Es können keine hierarchieübergreifendenTransitionen gezeichnet werden“. Keine sinnvolle Einschränkung ist:„Mal funktioniertdas Einfügeneines Zustands - malstürzt das Systemab“. Wenn im Laufe Ihrer Implementierungsarbeit ersichtlich wird,dass bestimmte Implementierungsziele nichterreichtwerden können (aufgrundfalscher Einschätzungdes Problems,oder aufgrundschlechter Ressourcenplanung), sollte sofort mitdemBetreuerabgesprochenwerden,wie das Problemsinnvollerweiseeingeschränkt werden könnte; es sollte nicht zueiner schlampigenEntwicklungführen. Schließlich gilt: es ist für etwaige Teamkollegen/Nachfolgervon Ihnen eine wesentlich dankbarere Aufgabe, auf Ihrer kleinen, sauber entwickeltenArbeit aufzusetzen und diese um neue Featureszu erweitern, als zu versuchen, Ihregroße, defekte Arbeitauf einen brauchbaren Qualitätsstandard anzuheben - oder diese ganz wegzuschmeißen und von vorne anzufangen.93 +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. 120 120 121 - Grundsätzlichgilt:Die Software ist„sauber“ zuschreibenund zu dokumentieren, unterBeachtung einesvtl. vorhandenenProjekthandbuchs. DieQualität und LeserlichkeitIhrer Software sowieder DokumentationgehtindieBewertungIhrerArbeitmit ein.95 +== 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"]] == 122 122 123 - ===ReviewsundRatings[[url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#ReviewsundRatings||style="text-decoration:none;"title="Linkto thissection"shape="rect"class="anchor"]]===97 +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. 124 124 125 - Istdie Implementierung Teil des KIELER Projekts, so müssen zur Erhaltungdes Qualitätsstandards Designund CodeReviewsdurchgeführtwerden.Wie dies praktisch abläuftund wie die sichdaraus ergebenden Ratingsaussehen wird auf der KIELER Projektseite erläutert.99 += What Grade Do I Get For All This? = 126 126 127 -== 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"]] == 128 - 129 -=== 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"]] === 130 - 131 -Folgendes sind grobe Richtwerte für den Umfang der Arbeit, ohne Titelseite, Inhalts-/Abbildungsverzeichnis, leere Seiten, Bibliographie, Anhänge, etc. 132 - 133 -* Studien-/Bachelorarbeit: 30-50 Seiten. 134 -* Diplom-/Masterarbeit: 70-120 Seiten. 135 - 136 -=== 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"]] === 137 - 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. 139 - 140 -Software sollte generell auf Englisch geschrieben werden - d.h., Kommentare, Variablen-/Klassen-/Paketnamen etc. sollten englisch sein. 141 - 142 -==== 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"]] ==== 143 - 144 -* Lesen und beherzigen Sie Strunk & White (siehe unten). 145 -* Lesen und beherzigen Sie Strunk & White (siehe unten). 146 -* Lesen und beherzigen Sie Strunk & White (siehe unten). Außerdem: 147 -* Sätze sollten nicht mit „But“ oder „And“ anfangen. Stattdessen: „However, ...“ bzw. „Furthermore, ...“. 148 - 149 -Schlecht: 150 - 151 ->„But this is of exponential complexity. And there is no known alternative.“ 152 - 153 -Gut: 154 - 155 ->„However, this is of exponential complexity. Furthermore, there is no known alternative.“ 156 - 157 -* Die Verwendung des Wortes „like“ im Sinne von „such as“ ist umgangssprachlich und sollte vermieden werden. In noch stärkerem Maße gilt dies für die Bedeutung „as if“. 158 - 159 -Schlecht: 160 - 161 ->„I, like you, like fast algorithms, like Tarjan's algorithm, ... He uses a sorting algorithm of quadratic complexity, like there is no alternative.“ 162 - 163 -Gut: 164 - 165 ->„I, like you, like fast algorithms, such as Tarjan's algorithm, ... He uses a sorting algorithm of quadratic complexity, as if there were no alternative.“ 166 - 167 -* Mit „which“ wird eine Ergänzung gekennzeichnet, welche in Kommata eingeschlossen wird und deren Streichung nicht sinnentstellend wirkt. Mit „that“ wird eine nähere Identifizierung gekennzeichnet, welche nicht gestrichen werden kann. Und: vor „that“ steht kein Komma! 168 - 169 -Schlecht: 170 - 171 ->„I told him, that the quicksort algorithm that is very fast is used by the program, which I installed yesterday.“ 172 - 173 -Gut: 174 - 175 ->„I told him that the quicksort algorithm, which is very fast, is used by the program that I installed yesterday.“ 176 - 177 -* Im allgemeinen werden die Wörter „section“, „figure“ etc. klein geschrieben, falls sie nicht am Satzanfang stehen. Falls jedoch eine spezifische Einheit gemeint und durch eine Nummerierung kenntlich gemacht ist, werden diese Wörter groß geschrieben. 178 - 179 -Schlecht: 180 - 181 ->„The following Section illustrates .... In section 2.3, we describe .... This Chapter includes too many Sections.“ 182 - 183 -Gut: 184 - 185 ->„The following section illustrates .... In Section 2.3, we describe .... This chapter includes too many sections.“ 186 - 187 -=== 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"]] === 188 - 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. 190 - 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 - 195 -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. 196 - 197 -==== 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"]] ==== 198 - 199 -Lassen Sie von Zeit zu Zeit eine Rechtschreibprüfung über ihren Text laufen; dies ist auch für .tex-Dateien möglich. Insbesondere sollte dies geschehen bevor Sie Ihre Arbeit jemand anderem zum Lesen/Korrigieren/Bewerten geben. Ein möglicher Spellchecker ist aspell. 200 - 201 -[[Texlipse>>url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Texlipse||style="text-decoration: none;" shape="rect" class="wiki"]] unterstützt auch on-the-fly spell checking. 202 - 203 -In Emacs (oder Xemacs - generell wird hier nicht zwischen diesen Editoren unterschieden) wird die Rechtschreibprüfung eines Buffers, welcher eine .tex-Datei enthalten kann, mit dem Befehl ispell-buffer gestartet. Der zu verwendende Spellchecker wird durch die Variable ispell-program-name definiert (Default: aspell). Das zu verwendende Wörterbuch wird durch die Variable ispell-dictionary definiert (z.B. deutsch8 oder american), welche durch den Befehl ispell-change-dictionary gesetzt werden kann. 204 - 205 -Emacs kann das zu verwendende Wörterbuch auch automatisch für eine .tex-Datei festlegen, wenn die Datei die Variable ispell-dictionary über einen //Local Variables//-Kommentar definiert, welcher vom Emacs beim Einlesen einer Datei ausgewertet wird. Ein Beispiel für einen solchen Kommentar: 206 - 207 -{{{ % Local Variables: 208 - % mode: latex 209 - % compile-command: "make cases2005.pdfv" 210 - % ispell-dictionary: "american" 211 - % End: 212 -}}} 213 - 214 -* Gründliches manuelles Lesen bleibt einem aufgrund Grammatik oder Zeichensetzungsfehlern nicht erspart. 215 -* Möglichst auch einen zweiten, unabhängigen Korrekturleser heranziehen. 216 -* Bei englischer Sprache ist möglichst ein //native speaker// als Korrekturleser heranzuziehen. 217 - 218 -==== Auszeichnungen - Allgemeines[[url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#Auszeichnungen-Allgemeines||style="text-decoration: none;" title="Link to this section" shape="rect" class="anchor"]] ==== 219 - 220 -Einzelne Textpassagen können //ausgezeichnet// werden. Grundsätzlich sollten Auszeichnungen in folgenden Gegebenheiten eingesetzt werden: 221 - 222 -* Einführung/Definition neuer Begriffe - wie zum Beispiel „auszeichnen“ (und damit auch „Auszeichnung“) in obigem Absatz. 223 -* Zitate. 224 -* Teilüberschriften, evt. in den Fließtext integriert. 225 -* Titel von Büchern, Zeitschriften //etc//. 226 -* Beispiele, wenn diese - wie hier - in Form von (wenn auch fiktiven) Zitaten erscheinen. 227 -* Hervorhebung von Kernpunkten. 228 -* Fremdsprachige Textfragmente (siehe unten). 229 -* Symbole, physikalische Größen usw. (siehe unten). 230 -* Programme, Funktionsname usw. (siehe unten). 231 - 232 -Man sollte sich beim Gebrauch von Auszeichnungen bewusst sein, dass diese ein besonderer Hinweis für den Leser sind und ihn zu besonderer Aufmerksamkeit veranlassen sollen. Sie bewirken stets eine - wenn auch minimale - Unterbrechung des Leseflusses. Auszeichnungen sollten systematisch und im Zweifelsfall eher sparsam eingesetzt werden. Zu //viele//Auszeichnungen //verhindern// das //flüssige Lesen// (und können auch etwas //akademisch// wirken). Es ist dann //schwierig// für den Leser zu //erkennen//, was //denn nun wirklich wichtig ist - insbesondere bei geschachtelten Auszeichnungen, möglicherweise mehrfach **überlagert**// !!!! 233 - 234 -Bei Auszeichnungen sollte der //Scope// eingehalten werden. Wenn z.B. Begriffe und sowie deren Abkürzungen eingeführt werden, sollten diese einzeln ausgezeichnet werden - Klammerungen selbst sollten nicht ausgezeichnet werden. 235 - 236 -Schlecht: 237 - 238 ->„Die Message Sequence Charts (MSCs) sind ein Formalismus ...“ 239 - 240 -Gut: 241 - 242 ->„Die Message Sequence Charts (//MSCs//) sind ein Formalismus ...“ 243 - 244 -In LaTeX werden Auszeichnungen mit dem Befehl \emph vorgenommen, welche dann normalerweise //kursiv// erscheinen. //In einem kursiv gesetzten Kontext - wie in den Beispielen hier - sind Auszeichnungen jedoch //nicht-kursiv//, um diese vom Kontext abzuheben.// 245 - 246 -===== Auszeichnung fremdsprachiger Ausdrücke[[url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#AuszeichnungfremdsprachigerAusdrücke||style="text-decoration: none;" title="Link to this section" shape="rect" class="anchor"]] ===== 247 - 248 -Zunächst ein Beispiel für ein englischsprachiges Dokument: 249 - 250 -Schlecht: 251 - 252 ->„As Schmidt et al. have documented, this agreement today is a de-facto standard for layout etc.“ 253 - 254 -Gut: 255 - 256 ->„As Schmidt //et al//. have documented, this agreement today is a //de-facto// standard for layout //etc//.“ 257 - 258 -Bei deutschsprachigen Dokumenten gilt: es sind grundsätzlich Begriffe ausgenommen, welche im Duden stehen (wie zum Beispiel „Layout“). Weiterhin wird bei Auszeichnungen die Groß-/Kleinschreibung der Fremdsprache übernommen. 259 - 260 -Schlecht: 261 - 262 ->„Wie Schmidt et al. dokumentiert haben, ist dieses Agreement heute de-facto ein Standard in layout etc.“ 263 - 264 -Gut: 265 - 266 ->„Wie Schmidt et al. dokumentiert haben, ist diese Vereinbarung heute de-facto ein Standard in Layout etc.“ 267 - 268 -Eine spezielle Problematik bei deutschsprachigen Dokumenten in der Informatik ist, dass hier viele Begriffe aus dem Englischen kommen, und als Teil des deutschen Informatik-Fachvokabulars angesehen werden können, auch wenn diese noch nicht im Duden erscheinen. Diese Begriffe sollten dann nicht ausgezeichnet werden, damit die Lesbarkeit des Dokuments nicht durch übermäßige Auszeichnungen leidet. Im Zweifelsfall gilt: Wenn es für einen englischen Begriff keinen äquivalenten deutschen Begriff gibt, oder der deutsche Begriff in der Praxis seltener eingesetzt wird als der englische Begriff, sollte der englische Begriff als Teil des deutschen Fachvokabulars angesehen werden und auf eine Auszeichnung verzichtet werden. Dies betrifft auch Begriffe, welche nicht wirklich Fachbegriffe sind (wie z.B. „Feature“). Ebenso sollten Eigennamen von Formalismen, Programmiersprachen, Werkzeugen usw. nicht ausgezeichnet werden. In jedem Fall sollten Sie sich konsistent für oder gegen die Auszeichnung eines Begriffs im gesamten Dokument entscheiden; einzige Ausnahme ist die einmalige Auszeichnung eines Begriffes bei einer Begriffsdefinition. Zusammenfassend gilt: es ist oft im Ermessen des Autors, ob eine Auszeichnung verwendet werden soll oder nicht; im Zweifelsfall gilt das Gebot der Sparsamkeit, insbesondere, falls Sie einen einzelnen Begriff sehr häufig verwenden. 269 - 270 -Schlecht: 271 - 272 ->„Die Synthese von Statecharts nach Java .... Der Kellerspeicher vom Übersetzer ist hierfür standardmäßig zu klein. Diese software hat viele features und noch mehr bugs. [Aber:] Die Mental Map des Betrachters ....“ 273 - 274 -Gut: 275 - 276 ->„Die Synthese von Statecharts nach Java .... Der Stack des Compilers ist hierfür standardmäßig zu klein. Diese Software hat viele Features und noch mehr Bugs. [Aber:] Die mental map des Betrachters ....“ 277 - 278 -Nach diesem Plädoyer für die sparsame Verwendung von Auszeichnungen bei originär englischen Ausdrücken noch ein Plädoyer für sparsame Verwendung englischer Ausdrücke, wenn es hierfür gängige und präzise Äquivalente im Deutschen gibt: 279 - 280 -Schlecht: 281 - 282 ->„Das Agreement war, die Action Items und die Schedule des nächsten Meetings in die Minutes zu pasten, und sich zum Matchen der Deadlines zu committen.“ 283 - 284 -Gut: 285 - 286 ->„Die Vereinbarung war, die Aktionspunkte und die Zeitplanung der nächsten Besprechung in das Protokoll zu übernehmen, und sich zur Einhaltung der Termine zu verpflichten.“ 287 - 288 -In der Informatik ist dies oft eine schwierige Balance zwischen zu viel und zu wenig deutsch, welche letztlich eine Sache des persönlichen Geschmacks ist. So scheint „Übersetzer“ ebenso akzeptabel wie „Compiler“, „Betriebssystem“ mehr verbreitet als „Operating System“, jedoch wirkt „Kellerspeicher“ eher verschroben im Vergleich zu „Stack“. 289 - 290 -===== Auszeichnung von Symbolen, physikalischen Größen usw.[[url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#AuszeichnungvonSymbolenphysikalischenGrößenusw.||style="text-decoration: none;" title="Link to this section" shape="rect" class="anchor"]] ===== 291 - 292 -Neben den bereits erwähnten Fällen, in welchen Textbestandteile ausgezeichnet werden sollten, sollten auch Mathematische Symbole, Mengenbezeichner, physikalische Größen etc. ausgezeichnet werden. In LaTeX kann man hierfür, wie bereits erwähnt, den Befehl \emph{...} verwenden - oder alternativ den Begriff mit „$...$“ auszeichnen. Letzterer Mechanismus ist jedoch mit etwas Vorsicht zu verwenden, falls die Begriffe mehr als ein Zeichen lang sind, da dieser Mechanismus den Begriff als mathematische Formel interpretiert und spezielle Richtlinien für dessen Layout verwendet. Insbesondere wird der Buchstabe f als eigenständiger Funktionsname interpretiert und ein entsprechender Zwischenraum produziert, was generell nicht erwünscht ist. 293 - 294 -Schlecht: 295 - 296 ->„Sei $Koffer$ die Menge der Koffer ...“ 297 - 298 -Gut: 299 - 300 ->„Sei \emph{Koffer} die Menge der Koffer ...“ 301 - 302 -===== Auszeichnung von Programmen, Funktionsnamen usw.[[url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#AuszeichnungvonProgrammenFunktionsnamenusw.||style="text-decoration: none;" title="Link to this section" shape="rect" class="anchor"]] ===== 303 - 304 -Namen von Programmen sowie von Funktionsnamen, Variablennamen etc. sollten ebenfalls ausgezeichnet werden. Jedoch sollte man hierfür eine andere Auszeichnung verwenden, nämlich diejenige, welche auch in Programmlistings verwendet wird. Typischerweise ist dies typewriter (erzeugt mit \texttt{...}) oder SansSerif (erzeugt mit \textsf{...}). Ein Beispiel hierfür sind die in diesem Text erwähnten LaTeX-Befehle. 305 - 306 -==== Referenzierungen[[url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#Referenzierungen||style="text-decoration: none;" title="Link to this section" shape="rect" class="anchor"]] ==== 307 - 308 -Verwenden Sie Referenzierungen im Ihrer Arbeit so, dass sie kein grammatikalischer Bestandteil des Satzes sind - der Text sollte auch nach Eliminieren aller geklammerten Bestandteile, einschließlich der in eckigen Klammern befindlichen Referenzen, noch grammatikalisch korrekt sein. Üblicherweise erreicht man dies durch die Nennung der Autoren eines Werkes, gefolgt von der Referenz. Im Text sollten Autoren typischerweise ohne Vornamen genannt werden (jedoch sollten Autorenvornamen bei den Referenzen selbst vollständig genannt werden, siehe unten). Bei mehreren Autoren sollten entweder alle genannt werden, oder es sollte die Existenz weiterer Autoren durch „et al.“ kenntlich gemacht werden. 309 - 310 -Schlecht: 311 - 312 ->„Wie in [42] beschrieben, ...“ 313 - 314 -Gut: 315 - 316 ->„Wie von Harel //et al//. [42] beschrieben, ...“ 317 - 318 -Die Referenzen selbst sollten vollständig sein - also mehr sein als eine Sammlung von Suchbegriffen für google. Grundsätzlich sollten Angaben so vollständig wie möglich sein. So gehören z.B. zu einer Artikelreferenz nicht nur Autoren und Titel des Artikels, sondern auch bei Jahr/Monat des Erscheinens, bei Journalartikeln auch Name des Journals und gegebenenfalls Nummer und Herausgeber, sowie bei Tagungs-/Workshopartikeln der Name und Ort der Tagung. Vermeiden Sie Abkürzungen. Tagungsnamen sollten sowohl in ausgeschriebener Form als auch mit ihrem Kürzel genannt werden. 319 - 320 -Schlecht: 321 - 322 ->„A. Mooij and N. Goga and J. Romijn. Non-local Choice and Beyond: Intricacies of MSC Choice Nodes. FASE'05, pages 273-288, 2005.“ „A. Mooij and N. Goga and J. Romijn. Non-local Choice and Beyond: Intricacies of MSC Choice Nodes. In Fundamental Approaches to Software Engineering, pages 273-288, April 2005.“ 323 - 324 -Gut: 325 - 326 ->„Arjan J. Mooij and Nicolae Goga and Judi Romijn. Non-local Choice and Beyond: Intricacies of MSC Choice Nodes. In Fundamental Approaches to Software Engineering (FASE '05), pages 273-288, Edinburgh, Scotland, April 2005.“ 327 - 328 -Achten Sie auf die **Konsistenz** der Einträge. So sollten z.B. alle Referenzen für ein Journal dieses Journal gleich referenzieren. Autoren sollten so referenziert werden, wie sie in der referenzierten Arbeit erscheinen; so sollten Vornamen nicht abgekürzt werden, wenn sie in der Arbeit selbst ausgeschrieben sind, ebenso sollten angegebene Mittelinitialen übernommen werden. Bei der Verwendung von URLs sollten Sie darauf achten, dass diese nicht über den Satzspiegel hinausragen; das Paket breakurl sorgt für den entsprechenden Zeilenumbruch von URLs. 329 - 330 -Schlecht: 331 - 332 ->[1] Alur, Etessami, and Yannakakis. Inference of message sequence charts. //IEEETSE: IEEE Transactions on Software Engineering//, 29, 2003. 333 - 334 ->[2] Alan W. Biermann and Ramachandran Krishnaswamy. Constructing programs from example computations. IEEE Transactions on Software Engineering, 2(3):141-153, September 1976. 335 - 336 -Gut: 337 - 338 ->[1] Rajeev Alur, Kousha Etessami, and Mihalis Yannakakis. Inference of message sequence charts. //IEEE Transactions on Software Engineering//, 29:304NAK313, 2003. 339 - 340 ->[2] Alan W. Biermann and Ramachandran Krishnaswamy. Constructing programs from example computations. //IEEE Transactions on Software Engineering//, 2(3):141-153, September 1976. 341 - 342 -Die Bibliographie sollte nach Nachnamen des Erstautors sortiert sein. Bei der (stark empfohlenen) Verwendung von BibTeX sollten Sie für jede Referenz den richtigen, möglichst spezifischen Referenztyp verwenden (z.B. @InProceedings statt @Misc). Die für den jeweiligen Referenztyp vorgesehenen Pflichtfelder geben bereits einen ersten Hinweis für die Mindestinformationen; die weiteren optionalen Eintragsfelder sollten aber auch so weit wie möglich verwendet werden. Falls bibtex bei Erzeugung der Referenzen einen Fehler meldet, z.B. aufgrund eines fehlenden Pflichtfeldes, sollte dieses auf alle Fälle korrigiert werden. Für Ihre Arbeitserleichterung sollten Sie ein konsistentes Schema für die Indizierung verwenden, so dass Sie den Index möglichst aus Autoren & Erscheinungsjahr erschließen können, und Referenzierungen in Ihren Text einfügen können, ohne den Index in der BibTeX-Datei nachsehen zu müssen. Die Verwendung eines bestimmten Schemas ist insbesondere dann erforderlich, falls Sie eine gemeinsam genutzte BibTeX-Datei bearbeiten. So gibt z.B. die am Lehrstuhl genutzte cau-rt.bib-Datei ein Schema vor, welches am Anfang dieser Datei beschrieben ist. 343 - 344 -* Literaturangaben möglichst als integrierten Teil des Satzes (nicht außerhalb des Satzes anbringen). 345 -* Literaturangaben keinesfalls hinter das Satzendzeichen (z.B. nach dem Punkt). 346 -* Auch in Abbildungen, die nicht selbst/selbständig erstellt wurden darf die Literaturangabe nicht fehlen (z.B. //(nach Schmidt [3])//). 347 -* Für URLs, Verweise auf Webseiten (z.B. [[www.eclipse.org>>url:http://www.eclipse.org||shape="rect"]]) eignen sich am besten Fußnoten. 348 -* Bib-Eintränge kontrollieren (Titel, Autoren (durch and getrennt, nicht kommasepariert!), Datum, Ort!). 349 -* Bib-Einträge: Wörter, die groß geschrieben werden sollten in geschweifte Klammern setzen. 350 -* Bib-Einträge auf Englisch oder Deutsch (je nach Arbeit!). 351 -* Literaturangaben nicht als Nomen in den Satz einbetten. 352 -Merkregel: Der Satz sollte sich auch ohne die Literaturangabe sinnvoll lesen lassen. 353 -* Nur Primärliteratur oder (bewährte) Fachbücher: Z.B. keine Foliensätze/Lectures referenzieren. 354 - 355 -==== Aufbau und Inhalt[[url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#AufbauundInhalt||style="text-decoration: none;" title="Link to this section" shape="rect" class="anchor"]] ==== 356 - 357 -* //Ziel der Arbeit// wirklich auf den Punkt bringen (ca. 1/2 bis 3/4 Seite). 358 -* Neue Begriffe (die einem Informatiker nicht allgemein bekannt sind) an geeigneter Stelle einführen, bevor man sie verwendet (z.B. Definitionen). 359 -* Jedes Kapitel sollte eine Einleitung haben. 360 -* Überleitungen von jedem Teil in den anderen, eine sinnvolle Reihenfolge ist notwendig und erleichtert dies. 361 -* Schwammige Begriffe und Füllwörter vermeiden bzw. weglassen. 362 -** Füllsätze ebenfalls vermeiden. 363 -* Einheitliche/konsistente Begriffe verwenden, bei neu eingeführten Begriffen auf Synonyme verzichten. 364 -* Keine Umgangssprache verwenden, möglichst auf Fachbegriffe zurückgreifen. 365 -* Von Strukturierungselementen wie \itemize, \enumerate, \description sinnvoll Gebrauch machen. 366 -* Grafiken zur Veranschaulichung nutzen (z.B. Aktivitätsdiagramme, Klassendiagramme, Tabellen). 367 -** Diese können auch für evtl. Präsentationen wiederverwendet werden. 368 -* Beim Erklären von Zusammenhängen zunächst abstrahieren und erst später konkret werden. 369 - 370 -===== Kapitel[[url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#Kapitel||style="text-decoration: none;" title="Link to this section" shape="rect" class="anchor"]] ===== 371 - 372 -1. **Abstract**: Beschreibt den Inhalt Arbeit abstrakt und kompakt, soll einem Leser eine Entscheidungshilfe dabei sein, ob die Arbeit für ihn lesenswert ist oder nicht. 373 -1. **Einleitung**: In das Thema einführen, Ziele der Arbeit beschreiben, Ausblick/Kapitelübersicht geben. 374 -1. **Verwandte Arbeiten**: Arbeiten mit ähnlichen/angrenzenden Themen in Bezug zur Arbeit setzen. 375 -1. **Verwendete Technologien**: Optional, Techniken und Technologien soweit für das Verständnis nötig beschreiben. 376 -1. **Ideen**: Vom Ist-Zustand ausgehend die Probleme erörtern, Lösungsansätze auch mit Verweis auf verwandte Arbeiten diskutieren und den eigenen Lösungsweg stichhaltig begründen, hier zunächst die nötige Abstraktion wahren und erst im Verlauf konkreter werden, Implementierungsdetails sind hier irrelevant. 377 -1. **Implementierung**: Mit Verweis auf den eigenen Lösungsweg, soll hier die Implementierung zunächst mit der Struktur beginnend (Begründung!) und an sinnvollen Stellen auch mit konkretem Anwendungscode/Beispielen beschrieben werden. 378 -1. **Evaluation**: Optional, Vergleich der Implementierung oder des Lösungsweges mit anderen Ansätzen, Experimente, Auswertung, Bewertung. 379 -1. **Zusammenfassung, Fazit, Ausblick**: Fasst die Probleme und vor allem die aufgezeigten Lösungen/Ergebnisse zusammen und beschreibt als Ausblick auch Erweiterungsmöglichkeiten, Schließt mit einem knappen und für die Arbeit aussagekräftigen Fazit. 380 - 381 - 382 - 383 -==== Akronyme[[url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#Akronyme||style="text-decoration: none;" title="Link to this section" shape="rect" class="anchor"]] ==== 384 - 385 -* Das Akronympaket ist zu verwenden (z.B. \ac{kieler}). 386 -* Indentierung bei Akronymverzeichnis ist einheitlich und linksbündig zu gestalten. 387 -* In Überschriften (gilt auch für Bildunterschriften) explizit die Langform verwenden (\acl). Achtung: Hier darauf achten, daß das Akronym im Text dennoch eingeführt wird! 388 -* Ausnahmeregelung: Allgemein bekannte Abkürzungen wie GUI. Hier die Langform gar nicht verwenden. 389 -* Akronyme konsistent halten. 390 -* Allgemein übliche Akronyme nicht so üblichen Akronymen vorziehen. 391 -* Akronyme niemals trennen. 392 - 393 -==== Abbildungen und Listings[[url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#AbbildungenundListings||style="text-decoration: none;" title="Link to this section" shape="rect" class="anchor"]] ==== 394 - 395 - 396 - 397 -* Größe: Nicht unter 80% der Seitenbreite, möglichst 100% (Textbreite ausnutzen!) 398 -* Ähnliche Abbildungen sollten auch vergleichbar/gleich groß sein. 399 -* Schriftgröße in Abbildungen sollte ca. der Schriftgröße des Textes entsprechen. 400 -* Wenn Textteile der Abbildung im Text zitiert werden, ist auf ein konsistentes Schriftbild zu achten, ggf. \sf verwenden. 401 -* Abbildungen immer mit Nummer und sinnvoller Überschrift versehen. 402 -* Überschrift abstrakt und so kurz wie möglich, so lang wie nötig halten (es sollte ohne Lesen des Textes verständlich sein, was die Abbildung zeigt). 403 -* Diagramme sollten i.d.R. eine Legende haben (Bedeutung von Farben/Formen nicht nur im Text erläutern). 404 -* Abbildungen immer in der selben Reihenfolge im Dokument anordnen, in welcher sie im Text referenziert werden. 405 -* Abbildungen möglichst immer in der Nähe des erklärenden Textes anordnen. 406 -* Jede Abbildung muss auch beschrieben werden. 407 -* Autolayout einsetzen für entsprechende Diagrammtypen (z.B. Klassendiagramm). 408 -* Einheitliche Schriftgröße für alle Listings verwenden. 409 -* Akronyme in Bildunterschriften s.o. 410 -* Listings in Figures vermeiden (dies kann zu speziellen Latex-Problemen führen) 411 -* Für Listings gilt allgemein entsprechendes. 412 - 413 - 414 - 415 -==== Verweise[[url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#Verweise||style="text-decoration: none;" title="Link to this section" shape="rect" class="anchor"]] ==== 416 - 417 -* Bezeichnung sollte korrekt sein: z.B. Kapitel 2, Unterkapitel 2.1, Abschnitt 2.3.4, Absatz 418 -** Nicht: z.B. Kapitel 2.1 419 -* Rückwärtsverweise sind ok, Vorwärtsverweise sind zu vermeiden. 420 -* Zu viele Verweise stören den Lesefluss, wichtige Dinge sollten an geeigneter Stelle auch (evtl. kürzer) wiederholt werden. 421 -* Abbildungen/Tabellen immer konkret benennen. 422 - 423 - 424 - 425 -==== Allgemeine Syntax[[url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#AllgemeineSyntax||style="text-decoration: none;" title="Link to this section" shape="rect" class="anchor"]] ==== 426 - 427 -* Doppelpunkt als Teil des Satzes auffassen; nach //~:// sollte kein neuer Absatz beginnen. 428 -* Hervorheben von Wörtern (\emph{}) möglichst selten einsetzen (s.o.). 429 -* Fremdsprachenwörter kursiv hervorheben. 430 -* Klammern vermeiden, sie stören den Lesefluss. 431 -* Fußnoten vermeiden, sie stören den Lesefluss. 432 -* Fußnoten für URLs sind ok. 433 -* Möglichst auf Querseiten verzichten, sie stören den Lesefluss. 434 -* Keine Einzelzeilen oder Überschriften vor oder nach einem Seitenumbruch stehen lassen. 435 -* Es sollten keine Zeilen oder Abbildungen/Tabellen über den Rand hinausragen. 436 -* Auf unnötigen Whitespace verzichten. 437 -* Codefont für Funktionsnamen/Prozeduren/... verwenden und auch hier auf Konsistenz achten. 438 -* LaTeX kennt keine Abkürzungs-Punkte. Z.B. Bei "e.g." oder "et al." ein xspace hinter dem letzten Punkt verwenden, da ansonsten ein zu großer Abstand zum nächsten Wort erzeugt wird (wie beim Satzende). 439 - 440 - 441 - 442 -==== Inhaltliches und Stilistisches[[url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#InhaltlichesundStilistisches||style="text-decoration: none;" title="Link to this section" shape="rect" class="anchor"]] ==== 443 - 444 -* Füllwörter, Füllphrasen und Füllsätze vermeiden, z.B. 445 -** due to the fact that 446 -** in order to 447 -* Zusammenhänge: "It" oder "This" vermeiden, wenn der Zusammenhang nicht wirklich eindeutig klar ist. In der Regel lieber den Bezug noch einmal explizit zum Ausdruck bringen. 448 -* Passiv in Sätzen nach Möglichkeit vermeiden: 449 -** Schlecht: „The syntax is explained in Chapter 5“ 450 -** Gut: „Chapter 5 explains the syntax“ 451 -* Wir/Ich-Sätze vermeiden. Ausnahme: Es geht um den inhaltlichen Kernbeitrag. 452 - 453 - 454 - 455 -==== Anhang[[url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#Anhang||style="text-decoration: none;" title="Link to this section" shape="rect" class="anchor"]] ==== 456 - 457 -* Wesentliche Teile, die im Text wichtig sind, nicht im Anhang verstecken. 458 -* Anleitungen (z.B. //How-To//s) gehören in den Anhang. 459 - 460 -=== 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"]] === 461 - 462 -==== 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"]] ==== 463 - 464 -Prof. von Hanxleden would recommend Emacs as a very flexible and powerful Latex editor. Hauke (haf) recommends [[Texlipse>>url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Texlipse||style="text-decoration: none;" shape="rect" class="wiki"]] as an easy-to use and also powerful Eclipse plug-in. Christoph Daniel (cds) recommends using Kile, a KDE LaTeX editor that is fast, powerful, and reasonably easy to understand and to use. 465 - 466 -==== Using Git[[url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#UsingGit||style="text-decoration: none;" title="Link to this section" shape="rect" class="anchor"]] ==== 467 - 468 -The files associated with the thesis should be kept in the group's [[Git>>url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Git||style="text-decoration: none;" shape="rect" class="wiki"]] repository. The main purpose is to prevent loss of data. It also facilitates access for fellow group members if needed, and to allow on-line publication. 469 - 470 -The main tex file for a thesis should be <name of directory>.tex. See also [[Git/Structure>>url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Git/Structure||style="text-decoration: none;" shape="rect" class="wiki"]] for the canonical naming scheme. Eg, the bachelor thesis of user xyz can be found in a repository named xyz-bt in the Thesss project of our [[(% class="icon" %) (%%)Gitorious>>url:https://git.rtsys.informatik.uni-kiel.de/projects||style="text-decoration: none;" shape="rect" class="ext-link"]] system, in a file named xyz-bt.tex. If there is a talk to "defend" the thesis (Bachelor-Kolloquium, Disputation), the talk should also be included in this repository, and should be named <name of directory>-talk.tex; eg xyz-bt-talk.tex. In case your thesis should be made available on-line, the same names should be used, eg, xyz.pdf. 471 - 472 -See also the notes on [[preparing a paper>>url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Preparing_a_Paper||style="text-decoration: none;" shape="rect" class="wiki"]], eg regarding which files should be kept in revision management (ie, should be checked into Git) and which shouldn't. 473 - 474 -==== Das LaTeX-Paket ifiseries[[url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#DasLaTeX-Paketifiseries||style="text-decoration: none;" title="Link to this section" shape="rect" class="anchor"]] ==== 475 - 476 -Für die Ausarbeitung studentischer Arbeiten empfehlen wir, das LaTeX-Paket [[(% class="icon" %) (%%)ifiseries>>url:http://www.informatik.uni-kiel.de/kcss/author-information/||style="text-decoration: none;" shape="rect" class="ext-link"]] zu benutzen. Es ist einfach einzubinden, bringt das meiste mit was man benötigt und wird regelmäßig gepflegt. Auf der verlinkten Webseite gibt es dazu weitere Informationen; insbesondere das [[(% class="icon" %) (%%)dort verlinkte Manual>>url:https://rtsys.informatik.uni-kiel.de/svn/theses/example-diss/pub/manual.pdf||style="text-decoration: none;" shape="rect" class="ext-link"]] sollte man einmal durchlesen um sich mit den Funktionen und der Einbindung des Pakets vertraut zu machen. 477 - 478 -Bei Fragen zur Benutzung möge man sich vertrauensvoll an einen der Lehrstuhlmitarbeiter wenden. 479 - 480 -==== Das ToDo-Paket[[url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#DasToDo-Paket||style="text-decoration: none;" title="Link to this section" shape="rect" class="anchor"]] ==== 481 - 482 -Es kommt häufig vor dass man sich während des Schreibens Anmerkungen zum Text machen oder Dinge später hinzufügen möchte. Damit dies einfacher zu verwalten ist, steht ein extra ToDo-Paket zur Verfügung. Mit diesem Paket lassen sich Platzhalter für Grafiken, Anmerkungen zum Text in verschiedenen Farben oder einfache ToDo-Kommentare mit Referenz zum Text schnell und unkompliziert realisieren. Eingebunden wird das Paket wie folgt. 483 - 484 -{{{ \usepackage{todonotes} 485 -}}} 486 - 487 -Eine kurze, detaillierte Anleitung kann man hier nachlesen: 488 - 489 ->[[(% class="icon" %) (%%)http:~~/~~/www.tex.ac.uk/tex-archive/macros/latex/contrib/todonotes/todonotes.pdf>>url:http://www.tex.ac.uk/tex-archive/macros/latex/contrib/todonotes/todonotes.pdf||style="text-decoration: none;" shape="rect" class="ext-link"]] 490 - 491 -==== Die Erstellung einer Bibliographie[[url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#DieErstellungeinerBibliographie||style="text-decoration: none;" title="Link to this section" shape="rect" class="anchor"]] ==== 492 - 493 -Zur Erstellung einer Bibliographie mit LaTeX ist das Beispiel-Dokument zu Rate zu ziehen. Die dort benutzte BibTeX-Datenbank cau-rt.bib wird Lehrstuhl-weit von Mitarbeitern und Studenten gemeinsam benutzt um Literatur-Daten zu sammeln und zu publizieren. Alle Literaturdaten, die in studentischen Arbeiten anfallen, müssen also in dieser Datei verwaltet werden. **Wichtig:** Bitte vermeiden Sie bibtex-Warnungen beim Hinzufügen von neuen Einträgen! Weitere Hinweise zur Beachtung finden sich [[hier>>url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Preparing_a_Paper#The_Bibliography_-_Guidelines_for_bibtex_Entries||style="text-decoration: none;" shape="rect" class="wiki"]] 494 - 495 -Das Erstellen eines deutschsprachigen Literaturverzeichnisses ist mit Hilfe des Paketes //bibgerm// und dem bibliographystyle //gerplain// möglich. 496 - 497 -{{{ \usepackage[ngerman]{babel} 498 - \usepackage{bibgerm} 499 - . 500 - . 501 - . 502 - \bibliographystyle{gerplain} 503 - 504 -}}} 505 - 506 -Links zu BibTeX: 507 - 508 -* [[(% class="icon" %) (%%)BibTeX-Tutorial>>url:http://www.din1505.informationskompetenz.net/||style="text-decoration: none;" shape="rect" class="ext-link"]] (Link ist tot) 509 -* [[(% class="icon" %) (%%)Tame the BeaST - The B to X of BibTEX (Nicolas Markey)>>url:ftp://dante.ctan.org/tex-archive//info/bibtex/tamethebeast/ttb_en.pdf||style="text-decoration: none;" shape="rect" class="ext-link"]] 510 -* [[(% class="icon" %) (%%)Eine Auflistung von BibTEX Styles>>url:http://www.reed.edu/cis/help/latex/bibtexstyles.html||style="text-decoration: none;" shape="rect" class="ext-link"]] 511 - 512 -==== Arbeit innerhalb des Lehrstuhl-Netzwerkes[[url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#ArbeitinnerhalbdesLehrstuhl-Netzwerkes||style="text-decoration: none;" title="Link to this section" shape="rect" class="anchor"]] ==== 513 - 514 -Beim Arbeiten im Lehrstuhl-Netzwerk werden keine zusätzlichen Maßnahmen notwendig; der LaTeX-Zugriff auf die BibTeX-Datenbank ist automatisch über das Netzwerk gewährleistet. Für verändernde Zugriffe auf die Datenbank muss mit [[Subversion >>url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Subversion||style="text-decoration: none;" shape="rect" class="wiki"]]gearbeitet werden. 515 - 516 -==== Arbeit außerhalb des Lehrstuhl-Netzwerkes[[url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#ArbeitaußerhalbdesLehrstuhl-Netzwerkes||style="text-decoration: none;" title="Link to this section" shape="rect" class="anchor"]] ==== 517 - 518 -Beim Arbeiten außerhalb des Lehrstuhl-Netzes wird es notwendig die Datenbank dem lokal installierten LaTeX-System zur Verfügung zu stellen. Eventuell muss die dazugehörige kpse-Datenbank reinitialisiert werden. Für verändernde Zugriffe auf die Datenbank muss mit [[Git>>url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Git||style="text-decoration: none;" shape="rect" class="wiki"]] gearbeitet werden. 519 - 520 -==== Zugriff auf das Git-Repository der BibTeX-Datenbank[[url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#ZugriffaufdasGit-RepositoryderBibTeX-Datenbank||style="text-decoration: none;" title="Link to this section" shape="rect" class="anchor"]] ==== 521 - 522 -Für Zugriff auf das [[Git-Repository >>url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Git||style="text-decoration: none;" shape="rect" class="wiki"]]der BibTeX-Datenbank ist folgender Befehl zu verwenden 523 - 524 ->git clone git@…:resources/bib.git 525 - 526 -Nach dem Auschecken des Moduls bib steht die Datei cau-rt.bib zur Verfügung. Hinweise zur genauen Syntax sind dem Kopf der Datei und den Beschreibungen der BibTeX-Sprache zu entnehmen. 527 - 528 -==== Publishing the thesis on-line[[url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#Publishingthethesison-line||style="text-decoration: none;" title="Link to this section" shape="rect" class="anchor"]] ==== 529 - 530 -If your advisor has agreed that your thesis should be made available on-line, and you have signed your [[(% class="icon" %) (%%)consent>>url:http://www.informatik.uni-kiel.de/fileadmin/arbeitsgruppen/realtime_embedded/misc/Einverstaendniserklaerung.doc||style="text-decoration: none;" shape="rect" class="ext-link"]], then you can publish this as follows. Say your thesis is xyz-bt.pdf. ("bt" for Bachelor theses, "mt" for Master theses, "diss" for dissertations.) To upload this, use the command 531 - 532 ->scp xyz-bt.pdf biblio@…:/home/biblio/public_html/downloads/theses 533 - 534 -If you don't have the right permissions to do this, ask your advisor or the [[System Administrator >>url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/System_Administrator||style="text-decoration: none;" shape="rect" class="wiki"]]to publish this for you. 535 - 536 -Then, check that your thesis is indeed available under the URL 537 - 538 ->[[(% class="icon" %) (%%)http:~~/~~/rtsys.informatik.uni-kiel.de/~~~~biblio/downloads/theses/xyz-bt.pdf>>url:http://rtsys.informatik.uni-kiel.de/~~biblio/downloads/theses/xyz-bt.pdf||style="text-decoration: none;" shape="rect" class="ext-link"]] 539 - 540 -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. 541 - 542 -=== 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"]] === 543 - 544 -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.). 545 - 546 -== 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"]] == 547 - 548 548 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.“ 549 549 550 550 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. ... ... @@ -569,7 +569,7 @@ 569 569 )))|((( 570 570 Lösung von Teilproblemen 571 571 )))|((( 572 -Vollständige Lösung; gutes Vertauen in die Lösung 125 +Vollständige Lösung; gutes Vertrauen in die Lösung 573 573 )))|((( 574 574 Vollständige, gute Lösung und Behandlung zusätzlicher Fragestellungen 575 575 )))|((( ... ... @@ -747,10 +747,10 @@ 747 747 24 748 748 ))) 749 749 750 -= =Weiterführende Hinweise[[url:http://trac.rtsys.informatik.uni-kiel.de/trac/rtsys/wiki/Hinweise_Arbeiten#WeiterführendeHinweise||style="text-decoration:none;" title="Linkto thissection" shape="rect" class="anchor"]] ==303 += Further Links = 751 751 752 -* Eine sehr zu empfehlende, einführende Veranstaltung zurPräsentation und Erstellung wissenschaftlicher Arbeiten („Dokumentieren und Präsentieren“) bietet regelmäßig (ca.alle zwei Jahre) Prof.Luttenberger amLehrstuhlfür[[(% class="icon" %) (%%)Kommunikationssysteme>>url:http://www.comsys.informatik.uni-kiel.de/||style="text-decoration:none;"shape="rect"class="ext-link"]] an.753 -* „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"]]754 -* „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"]]755 -* FallsSiedieArbeitaufenglischverfassen:eineReihe guter Ratschlägeundweiterer Querverweise(wiez.B. denklassischenStrunk & White)findensich 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"]]“.756 -* [[ (% 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"]]-EineAnleitungderUni-Oldenburg,z.T.spezifischfürOldenburg; auchdortgibtesnochweiterführendeLinks.305 +* 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. 306 +* „Einige typographische Grundregeln und ihre Umsetzung in LaTeX“ by [[Werner Struckmann>>url:http://www.cs.tu-bs.de/ips/struck/index.html||style="text-decoration: none;" shape="rect" class="ext-link"]] (TU Braunschweig), [[PDF>>url:http://www.ips.tu-braunschweig.de/struckmann/unitext/typographie.pdf||shape="rect"]] 307 +* „Anmerkungen zur Rechtschreibung“ by [[Werner Struckmann>>url:http://www.cs.tu-bs.de/ips/struck/index.html||style="text-decoration: none;" shape="rect" class="ext-link"]] (TU Braunschweig), [[PDF>>url:http://www.ips.tu-braunschweig.de/struckmann/unitext/rechtschreibung.pdf||shape="rect"]] 308 +* If you write your thesis in English, you can find advice and further links (among them the classic "Strunk & White" on good writing style) on [[Henning Schulzrinne's>>url:http://www.cs.columbia.edu/~~hgs/||shape="rect"]] page "[[Writing Technical Articles>>url:http://www.cs.columbia.edu/~~hgs/etc/writing-style.html||shape="rect" class="icon"]]". 309 +* "[[Wie schreibe ich eine gute Diplomarbeit?>>url:http://www.informatik.uni-oldenburg.de/studium/azwa/wie.html||shape="rect" class="icon"]]" — a guide written at Oldenburg University. This is in part specific to that university, but also contains further links.
- Confluence.Code.ConfluencePageClass[0]
-
- Id
-
... ... @@ -1,1 +1,1 @@ 1 - 77009181 +10751502 - URL
-
... ... @@ -1,1 +1,1 @@ 1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/RTSYS/pages/ 7700918/Hinweise zurAnfertigungundBenotungvon Abschlussarbeiten1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/RTSYS/pages/10751502/Writing and Grading Theses