In der einunddreißigsten Episode des Anwendungsentwickler-Podcasts gebe ich Tipps für ein professionelles Layout der Projektdokumentation.
Podcast: Play in new window | Download (Duration: 30:13 — 13.6MB)
Abonnieren: Apple Podcasts | Spotify | RSS
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 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.
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
How do you change the document font in LaTeX?
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