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
*
*
Links
Permalink zu dieser Podcast-Episode
RSS-Feed des Podcasts
Hurenkind und Schusterjunge – Wikipedia
Vektorgrafik – Wikipedia
Serife – Wikipedia
Vorlage für die Projektdokumentation
Einführung in LaTeX: 00. Einleitung
Weitere Infos zur ProjektdokumentationDu 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.Jetzt anmelden!
