Page tree

Versions Compared

Key

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

...

  • Das Akronympaket ist zu verwenden (z.B. \ac{kieler}).
  • Indentierung bei Akronymverzeichnis ist einheitlich und linksbündig zu gestalten.
  • 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!
  • Ausnahmeregelung: Allgemein bekannte Abkürzungen wie GUI. Hier die Langform gar nicht verwenden.
  • Akronyme konsistent halten.
  • Allgemein übliche Akronyme nicht so üblichen Akronymen vorziehen.
  • Akronyme niemals trennen.

Figures and Listings

  • For listings, use a \sf font, and flexible column spacing (\lstset{columns=flexible})
  • 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 (\lstset{columns=flexible} or \lstset{columns=fullflexible})

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.

...