Informationen / Student Resources (don't tell us you didn't know… ;-)

Bitte diese Seite sorgfältig lesen. Sie enthält einige wichtige Hinweise bezüglich der Durchführung von Abschlussarbeiten und Projekten und des Schreibens der Ausarbeitung und von Code. Bitte auch die Links zu der Hinweisseite und der Checkliste beachten.

Template und Software zum Planen/Schreiben der Ausarbeitung:

Wir würden uns freuen, wenn ihr LaTeX zur Erstellung eurer Ausarbeitung verwenden würdet. Zur Unterstützung haben wir ein Template für euch vorbereitet, das ihr als Vorlage verwenden könnt, um euren Text einzusetzen (siehe Link unten).

Link zum TeX-Template für eure schriftl. Ausarbeitung.

Links zu den Uni-Kassel-Logo Bildern:  https://www.uni-kassel.de/go/gestaltung dort als .eps Datei und als .pdf Datei (für die Titelseite; die EPS Datei ist bereits im Template enthalten).

Für Abbildungen, Diagramme und sonstige Bilder sollte immer wenn möglich ein Vektorformat verwendet werden. Als Software eignen sich vor allem:

dia von www.gnome.org/projects/dia/

Inkscape von www.inkscape.org/

gimp von www.gimp.org

graphviz von www.graphviz.org

gnuplot von www.gnuplot.info kann jetzt auch Histogramme (Version 4.2)

Scribus von www.scribus.net für etwas ausgefallenere Dinge

GanttProject von www.ganttproject.biz für die Zeitplanung der Arbeit

Zur Verbesserung von Code (Java, VHDL, ...) gibt es u.a. diese Software:

FindBugs von findbugs.sourceforge.net/ zum Finden von Fehlern oder sonstigen Problemen in Java Code

jGRASP von www.eng.auburn.edu/grasp/ zur Analyse von Java und anderen Sprachen, inclusive VHDL

Diese Programme sind unter fast allen Betriebssystemen vorhanden und können eps abspeichern. Für primitivere Zeichnungen geht auch noch xfig, allerdings nur unter Unix/Linux verfügbar. Mit graphviz können Bilder von Graphen automatisch erzeugt werden, z.B. auch von internen Datenstrukturen.

jabref jabref.sourceforge.net (Verwalten der Bibliographie)

Unter keinen Umständen unlizensierte Software verwenden!

Wichtige Hinweise zum Schreiben der Ausarbeitung: (inklusive Thema: plagiieren)

Zitierweise: Zitate aus der Referenzliteratur (Primär- und Sekundärliteratur):

  • falls kürzer als 3 Zeilen: im Fließtext mit Anführungsstrichen;
  • falls länger als 3 Zeilen: als eigener Absatz eingerückt.

Quellenangaben: wann?
Nach jedem Zitat aus der Referenzliteratur: (Verfasser/in Seitenzahl)
Beispiel: "Dieser Text is aus Referenz Eins, Seite 14, kopiert" ([1], S.14).
Nach jeder Übernahme von Fakten, Gedanken, Anregungen aus Werken der Referenzliteratur (Paraphrase).
Beispiel: Diese Aussage erscheint sehr ähnlich in Text Eins [1].

Plagiate:
Es ist nicht zulässig, fremde Quellen ohne Hinweis zu verwenden! (das schließt Abbildungen ein).
Bitte hierzu auch unbedingt diesen Text lesen:
de.wikipedia.org/wiki/Plagiarismus (bitte auch den englischen Link ansehen!).

Wikipedia: Die Wikipedia allgemein ist keine überprüfte Enzyklopädie! Also Vorsicht mit den Inhalten (bitte Beiträge verbessern wenn nötig - als Beitrag für alle!) und nicht extensiv zitieren! (Allgemein gilt: Enzykopädien sollten nicht als Quelle für Zitate dienen)

Zusätzliche Hinweise zur Ausarbeitung:

Der LaTeX-Quellcode muss auf unseren Rechnern compilierbar sein!

Unix/Linux Dateinamen sind Case-Sensitiv, ein häufiger Fehler sind falsche Dateinamen, die von PC-Dateissystemen stammen!

(z.B. picture.eps ist nicht gleich picture.EPS oder Picture.eps)

Wir können eine begrenzte Anzahl farbige Bilder in eurer Ausarbeitung auf unserem Farblaserdrucker ausdrucken.

Bitte folgende Hinweise zur schriftl. Ausarbeitung beachten! (Liste ist unvollständig und vorläufig)

Last but not least: Macht Backups von euren Daten, falls ihr daheim arbeitet!

Ihr könnt (solltet) immer eine aktuelle Kopie eurer Daten/Dateien auf unseren Computern haben, die nicht älter als 2 Tage ist; kopiert einfach alles per sftp oder USB Stick auf euren digi Account! Plattencrashs sind kein Verlängerungsgrund!!!

Checkliste für die Abgabe

Schreiben und Dokumentieren von Code:

Bitte immer bedenken, dass Kommentare und Dokumentation mehr als 50% von gutem Code ausmachen! Unkommentierter und undokumentierter Code ist später fast unbenutzbar und damit fast wertlos!

Schreiben von Code:

  • bitte übersichtlich und lesbar schreiben!
  • bitte den Code ausführlich mit Kommentaren versehen (in englisch, ohne Umlaute)!
  • bitte alle Algorithmen durch Pseudocode dokumentieren, möglichst schon zur Planung(!)
  • für Java bitte JavaDoc und für VHDL VHDLDoc verwenden.
  • Bitte den Code mit FindBugs überprüfen!
  • der Code sollte klar und deutlich das Architekturdiagramm (aus der Dokumentation!) widerspiegeln

Für die Dokumentation von Java Code:

  • Zunächst bitte einen Überblick über die Programm- und Klassenstruktur sowie das Konzept der verwendeten Datenstrukturen und des Programmablaufs angeben.
  • Ein Unterkapitel für jede (wichtige) Klasse
  • Beschreibung von Funktionalität, Variablen, Methoden, Funktionen, Funktionsparametern usw. innerhalb der Klassen; bitte Tabellen und Bilder verwenden!
  • Beschreibung aller Algorithmen
  • Beispiele für die Programmfunktionen (Testfälle und Daten)
  • Ein Anhang (oder ein Teil der allgem. Bescheibung), in dem alle zum Code gehörigen Dateien aufgeführt sind!

Für die Dokumentation von VHDL/Verilog Code:

  • Top-Level Diagramm des Entwurfs und dazugehörige Beschreibung, einschließlich der Dateistruktur
  • Ein Unterkapitel für jedes (wichtige) Modul
    (bitte Datei angeben, wo das Modul zu finden ist)
  • Beschreibung von Untermodulen, Struktur (z.B. Register-Transfer-Idee), Interfaces (I/Os), specifisches Timing, andere Randbedingungen/Besonderheiten
  • Beschreibung aller Algorithmen
  • Beispiele für die Hardwarefunktionen (Testfälle und Daten)
  • Implementierung und Beschreibung von Testbenches!!!
  • Generell: Bilder selber zeichnen, automatisch erzeugte Blockdiagramme (von den Design-Tools) nur in Ausnahmefällen verwenden!

Hinweise zu den Vortragsfolien:

Der Vortrag sollte 20 Minuten nicht überschreiten.

Wir rechnen normal mit 1,5 Minuten pro Folie.

Bitte keine Animationen verwenden, wenn möglich!