Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Diese Seite gibt Hinweise, welche bei der Anfertigung einer studentischen Arbeit an der AG Echtzeitsysteme und Eingebettete Systeme beachtet werden sollten. Dies betrifft in erster Linie Studien-/Diplom-/Bachelor-/Masterarbeiten; die Hinweise können aber auch bei der Anfertigung von Praktikumsberichten - oder auch Promotionsarbeiten - hilfreich sein.

Interaktion mit dem Betreuer

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.

...

Ihre Diplomarbeit ist ein Vollzeitjob; Sie sollten also im Normalfall täglich am Arbeitsplatz sein. Wenn Sie daneben einer regelmäßigen Arbeit nachgehen, sollten Sie mit dem Betreuer absprechen, wie dies mit der Anfertigung Ihrer Abschlussarbeit vereinbart werden kann.

Zeitlicher Ablauf

Sie sollten insbesondere bei der Anfertigung der schriftlichen Ausfertigung auf die Erfahrungen des Betreuers zugreifen. Sie sollten dem Betreuer also Entwürfe Ihrer Arbeit zukommen lassen, bevor Sie die zu benotende Endversion einreichen. Ihre Entwürfe sollten dabei aus Ihrer Sicht möglichst reif sein, müssen aber noch keineswegs vollständig sein. Eine bewährte Sequenz von abzuliefernden Dokumenten ist:

...

Für Arbeiten, welche in Zusammenarbeit mit einem Industrieunternehmen angefertigt werden, gilt diese Sequenz ebenso; Sie sollten hier jedoch Entwürfe, welche Sie dem universitären Betreuer zukommen lassen, vorher entsprechend von Ihrem Betreuer aus dem Unternehmen durchsehen lassen.

Notizen

Machen Sie sich während Ihrer gesamten theoretischen Arbeit Notizen darüber, was Sie gerade tun, wie Sie es tun und insbesondere: warum Sie es tun. Im Moment des Tuns ist alles noch klar, aber sobald es ans Schreiben geht wird es nicht mehr so klar sein. Tun Sie sich also einen Gefallen und schreiben Sie Notizen. Die Arbeit ist auch insofern schon nicht umsonst, als dass die Notizen eine prima Grundlage für Teile Ihrer schriftlichen Ausarbeitung werden.

Hinweise zu Implementierungen

Allgemeines

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.

...

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.

Reviews und Ratings

Ist die Implementierung Teil des KIELER Projekts, so müssen zur Erhaltung des Qualitätsstandards Design und Code Reviews durchgeführt werden. Wie dies praktisch abläuft und wie die sich daraus ergebenden Ratings aussehen wird auf der KIELER Projektseite erläutert.

Hinweise zur Ausarbeitung

Umfang

Folgendes sind grobe Richtwerte für den Umfang der Arbeit, ohne Titelseite, Inhalts-/Abbildungsverzeichnis, leere Seiten, Bibliographie, Anhänge, etc.

Sprache der Arbeit

Sie können die Arbeit auf Deutsch oder Englisch verfassen. Falls Sie die Arbeit nicht in Ihrer Muttersprache schreiben, wäre es hilfreich, wenn ein muttersprachlicher (oder ähnlich qualifizierter) Korrekturleser Ihre Arbeit auf sprachliche Richtigkeit korrigieren könnte, bevor Sie die Arbeit Ihrem Betreuer geben.

Software sollte generell auf Englisch geschrieben werden - d.h., Kommentare, Variablen-/Klassen-/Paketnamen etc. sollten englisch sein.

Hinweise für englischsprachige Arbeiten

...

„The following section illustrates .... In Section 2.3, we describe .... This chapter includes too many sections.“

Allgemeine Hinweise

Grundsätzlich steht es Ihnen frei, wie Sie Ihre Arbeit erstellen - mit  LaTeX 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.

...

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.

Rechtschreibprüfung

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.

...

Auszeichnungen - Allgemeines

Einzelne Textpassagen können ausgezeichnet werden. Grundsätzlich sollten Auszeichnungen in folgenden Gegebenheiten eingesetzt werden:

...

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.

Auszeichnung fremdsprachiger Ausdrücke

Zunächst ein Beispiel für ein englischsprachiges Dokument:

...

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“.

Auszeichnung von Symbolen, physikalischen Größen usw.

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.

...

„Sei \emph{Koffer} die Menge der Koffer ...“

Auszeichnung von Programmen, Funktionsnamen usw.

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.

Referenzierungen

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.

...

Aufbau und Inhalt

Kapitel
  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.
  2. Einleitung: In das Thema einführen, Ziele der Arbeit beschreiben, Ausblick/Kapitelübersicht geben.
  3. Verwandte Arbeiten: Arbeiten mit ähnlichen/angrenzenden Themen in Bezug zur Arbeit setzen.
  4. Verwendete Technologien: Optional, Techniken und Technologien soweit für das Verständnis nötig beschreiben.
  5. 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.
  6. 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.
  7. Evaluation: Optional, Vergleich der Implementierung oder des Lösungsweges mit anderen Ansätzen, Experimente, Auswertung, Bewertung.
  8. 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.

 

Akronyme

Abbildungen und Listings

 

 

Verweise

 

Allgemeine Syntax

 

Inhaltliches und Stilistisches

 

Anhang

Technische Umsetzung

Editor/IDE

Prof. von Hanxleden would recommend Emacs as a very flexible and powerful Latex editor. Hauke (haf) recommends Texlipse 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.

Using Git

The files associated with the thesis should be kept in the group's Git 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.

...

See also the notes on preparing a paper, eg regarding which files should be kept in revision management (ie, should be checked into Git) and which shouldn't.

Das LaTeX-Paket ifiseries

Für die Ausarbeitung studentischer Arbeiten empfehlen wir, das LaTeX-Paket  ifiseries 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  dort verlinkte Manual sollte man einmal durchlesen um sich mit den Funktionen und der Einbindung des Pakets vertraut zu machen.

Bei Fragen zur Benutzung möge man sich vertrauensvoll an einen der Lehrstuhlmitarbeiter wenden.

Das ToDo-Paket

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.

...

 http://www.tex.ac.uk/tex-archive/macros/latex/contrib/todonotes/todonotes.pdf

Die Erstellung einer Bibliographie

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

...

Arbeit innerhalb des Lehrstuhl-Netzwerkes

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 gearbeitet werden.

Arbeit außerhalb des Lehrstuhl-Netzwerkes

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 gearbeitet werden.

Zugriff auf das Git-Repository der BibTeX-Datenbank

Für Zugriff auf das Git-Repository der BibTeX-Datenbank ist folgender Befehl zu verwenden

...

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.

Publishing the thesis on-line

If your advisor has agreed that your thesis should be made available on-line, and you have signed your  consent, 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

...

Note: The name of this file should follow the canonical naming scheme used in subversion (Subversion/Structure ), even if your thesis is for some reason not in the subversion system.

Source Code

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 Beispieldokument (s.o.).

Hinweise zur Benotung

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.“

...

Note1,01,31,72,02,32,73,03,33,74,0
Mindestpunktzahl96888072645648403224

Weiterführende Hinweise