Layout der Projektdokumentation – Anwendungsentwickler-Podcast #31

In der einunddreißigsten Episode des Anwendungsentwickler-Podcasts gebe ich Tipps für ein professionelles Layout der Projektdokumentation.

Inhalt

Seitenstil

  • Seiten korrekt durchnummerieren.
  • Keinen unnötigen Leerraum lassen.
  • Maximal drei Gliederungsebenen verwenden.
  • Hurenkinder und Schusterjungen entfernen.
  • Absätze deutlich voneinander absetzen (z.B. mit vertikalem Abstand).

Text

  • Auf die Vorgaben der IHK achten (Schriftgröße, Seitenzahl).
  • Einheitliche Schriftart nutzen.
  • Serifenschrift für den Fließtext verwenden.
  • Blocksatz verwenden.
  • Silbentrennung aktivieren.
  • Sparsam mit Hervorhebungsmitteln umgehen.
  • Technische Begriffe in nicht-proportionaler Schrift setzen.
  • Text nicht mit Anführungszeichen hervorheben.

Artefakte

  • Große Artefakte immer in den Anhang verschieben.
  • Alle Artefakte beschriften und im Text referenzieren.
  • Grafiken müssen gut lesbar sein.
  • Skalierbare Grafikformate verwenden.
  • Quelltext highlighten.
  • Nur interessante Ausschnitte aus Screenshots zeigen.

Literaturempfehlungen

  • Anselm Rohrer - Clevere Tipps für die Projektarbeit – IT-Berufe: Abschlussprüfung Teil A (Affiliate)*
  • Matthias Kalle Dalheimer - LaTeX - kurz & gut*

Links

Weitere Infos zur Projektdokumentation

Du suchst noch mehr Tipps rund um die Projektdokumentation? Dann schau doch mal in diese Artikel- und Podcast-Kategorie: Alle Artikel rund um die Projektdokumentation.

Kennst du schon meine Microsoft Word-/LibreOffice-Vorlage für die Projektdokumentation? Unter dieperfekteprojektdokumentation.de kannst du sie herunterladen.

Und wenn du dich für meinen Newsletter einträgst, kannst du dir jetzt sofort meine Checkliste für die Projektdokumentation herunterladen.

Checkliste für die Projektdokumentation

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert.

To create code blocks or other preformatted text, indent by four spaces:

    This will be displayed in a monospaced font. The first four 
    spaces will be stripped off, but all other whitespace
    will be preserved.
    
    Markdown is turned off in code blocks:
     [This is not a link](http://example.com)

To create not a block, but an inline code span, use backticks:

Here is some inline `code`.

For more help see http://daringfireball.net/projects/markdown/syntax