Layout der Projektdokumentation – Anwendungsentwickler-Podcast #31

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

Probeabo bei Audible (Affiliate)

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

Jetzt anmelden!

Polyglot Clean Code Developer
About the Author
Ausbildungsleiter für Fachinformatiker Anwendungsentwicklung und Systemintegration, IHK-Prüfer und Hochschuldozent für Programmierung und Software-Engineering.

5 comments on “Layout der Projektdokumentation – Anwendungsentwickler-Podcast #31

  1. Ester sagt:

    Hallo Stefan,

    zuallerst möchte ich dir für deine großartige Arbeit danken – du bereicherst mein gesamtes Lehrjahr mit deinen Tipps!
    Ich habe mir deine LaTeX-Vorlage für meine Dokumentation geschnappt und bin begeistert. Nur mit der Schriftart komme ich nicht zurecht. Meine IHK gibt Schriftart Arial, Größe 10 vor (bei Überschriften 12) und ich weiß nicht, wie sich das in deiner Vorlage ändern lässt. Vielleicht kannst du weiterhelfen?

    Mit Dank im Voraus und besten Grüßen,
    Ester

  2. Ester sagt:

    Das wäre dann allerdings nicht Arial, sondern Helvetica .. Zudem weiß ich nun dennoch nicht, wo du das in deiner Vorlage gesetzt hast.
    Natürlich bin ich des Googlens mächtig, effizienter ist es allerdings die Quelle zu fragen, wenn sie sich schon hilfsbereit anbietet. Ich kann mir vorstellen, dass diese Frage schon so häufig gestellt wurde, dass es einem zum Halse raushängt, doch etwas mehr Kontext hätte ich mir trotzdem erhofft.

    Trotzdem Danke und schöne Grüße

  3. annika sagt:

    Hallo Stefan,

    wie immer eine tolle Folge mit vielen wertvollen Tipps – danke dafür.

    Ich möchte gerne ein Argument zu deiner Empfehlung bezüglich Schriftarten ergänzen. Es stimmt zwar, dass Serifenschriften in bestimmten Kontexten ihre Berechtigung haben, aber in der Praxis, besonders bei modernen Medien, gibt es meines Erachtens einige Gründe, warum serifenlose Schriften oft die bessere Wahl sind.

    Lesbarkeit auf Bildschirmen: Serifenschriften sind auf digitalen Displays oft schwieriger zu lesen, vor allem bei kleineren Schriftgrößen oder niedrigeren Auflösungen. Die feinen Serifen wirken auf Bildschirmen oft verschwommen oder überladen, was das Leseerlebnis negativ beeinflusst.

    Moderne Ästhetik: Serifenlose Schriften wirken zeitgemäß, klar und minimalistisch. Sie passen daher besonders gut zu modernen Medien. Serifenschriften hingegen vermitteln eher einen traditionellen oder konservativen Eindruck.

    Klarheit: Studien zeigen, dass serifenlose Schriften besser geeignet sind, da die Buchstabenformen klarer und einfacher zu erkennen sind, besonders für Kinder oder Leseanfänger. Wenn also eine breite Leserschaft angesprochen werden soll, ist eine serifenlose Schrift die inklusivere Wahl.

    Visuelle Einheitlichkeit: Im Podcast war der Vorschlag, Überschriften serifenlos zu gestalten und den Fließtext in einer Serifenschrift zu halten. Das wirkt auf den ersten Blick vielleicht interessant, aber diese Kombination stört, meines Erachtens, oft das Gesamtbild. Die Schriften wirken unruhig und brechen den visuellen Fluss. Ein einheitlicher Look, z. B. durch serifenlose Schriften sowohl in der Überschrift als auch im Fließtext, schafft Harmonie und eine klarere Struktur.

    Hervorhebung ohne Stilbruch: Eine Abwechslung zwischen Überschriften und Fließtext kann auch ohne Schriftwechsel erreicht werden – etwa durch andere Schriftgrößen, Farben oder Gewichtungen (z. B. Fettschrift). Die Wirkung finde ich moderner und stilvoller, ohne das Gesamtbild zu stören.

    Liebe Grüße und mach weiter so mit deinem tollen Content

  4. Stefan Macke sagt:

    Hallo Annika, danke für die Ergänzung. Aber du sagst selbst, dass deine Tipps für „moderne Medien“ und das Lesen auf Bildschirmen gelten. Das ist aber bei der Projektdokumentation ja gar nicht der Fall. Die wird ausgedruckt oder auf einem Tablet gelesen. Zumindest gehe ich davon aus, dass die meisten Prüfer:innen 50-seitige Dokumente, denen sie noch Korrekturhinweise hinzufügen müssen, nicht am Bildschirm lesen! 😀 Und ich gehöre auch dazu!

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