Page tree

Versions Compared

Key

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

...

  1. Abstract: Beschreibt den Inhalt der 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.

...

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.

The citation comes at the end of the sentence, yet it appears inside the period (because it is part of the sentence). If the citation is preceded by a quotation from the cited work, then the citation is placed outside the quotation marks (because it isn’t part of the quotation) [LitWeb]

Schlecht:

„Wie in [42] beschrieben, ...“

Gut:

„Wie von Harel et al. beschrieben, ... [42] beschrieben, ...“

...

The citation comes at the end of the sentence, yet it appears inside the period (because it is part of the sentence). If the citation follows a quotation from the cited work, then the citation is placed outside the quotation marks (because it isn’t part of the quotation).

Vor Referenzen steht eine Leerstelle, hier sollte aber nicht umgebrochen werden  (in Latex: ~).

Schlecht:

„Wie von Harel[42] beschrieben, ...“

Gut:

„Wie von Harel [42] beschrieben, ...“

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.

...

  • Größe: Nicht unter 80% der Seitenbreite, möglichst 100% (Textbreite ausnutzen!)
  • Ähnliche Abbildungen sollten auch vergleichbar/gleich groß sein.
  • Schriftgröße in Abbildungen sollte ca. der Schriftgröße des Textes entsprechen.
  • Wenn Textteile der Abbildung im Text zitiert werden, ist auf ein konsistentes Schriftbild zu achten, ggf. \sf verwenden.
  • Abbildungen immer mit Nummer und sinnvoller Überschrift versehen.
  • Ü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).
  • Diagramme sollten i.d.R. eine Legende haben (Bedeutung von Farben/Formen nicht nur im Text erläutern).
  • Abbildungen immer in der selben Reihenfolge im Dokument anordnen, in welcher sie im Text referenziert werden.
  • Abbildungen möglichst immer in der Nähe des erklärenden Textes anordnen.
  • Jede Abbildung muss auch beschrieben werden.
  • Autolayout einsetzen für entsprechende Diagrammtypen (z.B. Klassendiagramm).
  • Einheitliche Schriftgröße für alle Listings verwenden.
  • Akronyme in Bildunterschriften s.o.
  • Listings in Figures vermeiden (dies kann zu speziellen Latex-Problemen führen)Für Listings gilt allgemein entsprechendes.
  • For listings, use a \sf font, and flexible column spacing (\(sans serifs) or \tt (typewriter/courier) font. For an \sf font, use flexible column spacing (\lstset{columns=flexible} or \lstset{columns=fullflexible})
  • And perhaps the most common issue: when referring to statements, variable names, etc. from a listing, use a formatting that is consistent with the listing. Eg, if you use \sf in your listings, write "then \textsf{x} is set to 17". (Not: "then x is set to 17" or "then \textsf{x} is set to \textsf{17}".) The same applies to graphical languages. Eg, if a Statechart transition has a transition label "x / y" and is formatted in \sf, then references to x and y should also be formatted set in \sf.

Cross References

  • Bezeichnung sollte korrekt sein: z.B. Kapitel 2, Unterkapitel 2.1, Abschnitt 2.3.4, Absatz
    • Nicht: z.B. Kapitel 2.1
  • Rückwärtsverweise sind ok, Vorwärtsverweise sind zu vermeiden.
  • Zu viele Verweise stören den Lesefluss, wichtige Dinge sollten an geeigneter Stelle auch (evtl. kürzer) wiederholt werden.
  • Abbildungen/Tabellen immer konkret benennen.

...