In der einunddreißigsten Episode des Anwendungsentwickler-Podcasts
gebe ich Tipps für ein professionelles Layout der
Projektdokumentation. TL;DR Aus meiner Arbeit als Prüfer bringe ich
dir Tipps mit, mit denen du deine Projektdokumentation
übersichtlich und gut lesbar gestaltest. Halte dich an die Vorgaben
deiner IHK, nummeriere den Fließtext ab Seite 1 und arbeite mit
einheitlichen Formatvorlagen sowie einer flachen Gliederung. Für
Diagramme empfehle ich skalierbare Grafiken; Quelltext sollte in
nichtproportionaler Schrift gesetzt sein. Artefakte gehören
vorzugsweise in den Anhang und brauchen jeweils eine Beschriftung
sowie einen Verweis im Text. Kapitelmarken [00:00:00] Einstieg und
Thema der Episode [00:01:18] Seitenstil und Seitennummerierung
[00:04:10] Leerraum und Seitenumbrüche [00:05:15] Gliederungsebenen
und Projektphasen [00:06:32] Absatzkontrolle und Überschriften am
Seitenende [00:07:54] Abstand zwischen Absätzen [00:08:44]
Formatvorgaben deiner IHK [00:09:42] Einheitliche Schriftarten und
Serifenschriften [00:11:18] Blocksatz und Silbentrennung [00:12:34]
Hervorhebungen sparsam einsetzen [00:13:35] Einheitlich formatieren
[00:15:04] Semantische Befehle und Formatvorlagen [00:17:01]
Nichtproportionale Schrift für technische Begriffe [00:18:15]
Anführungszeichen richtig einsetzen [00:19:18] Artefakte im Anhang
platzieren [00:20:04] Artefakte beschriften und im Text
referenzieren [00:21:38] Skalierbare Grafiken und lesbare Diagramme
[00:23:33] Quelltext formatieren und hervorheben [00:24:32]
Quelltext direkt einbinden mit LaTeX [00:25:46] Aussagekräftige
Codeausschnitte und zugeschnittene Screenshots [00:27:18]
Typografische Details bei Bindestrichen und Gedankenstrichen
[00:28:17] Feedback und Fragen zur Ausbildung [00:29:08] Newsletter
und Checkliste zur 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! Zusammenfassung Vorgaben deiner IHK
und Seitenzahlen Als Prüfer achte ich darauf, ob du den erlaubten
Umfang einhältst. Bei meiner IHK umfasst die Projektdokumentation
höchstens 15 Seiten Fließtext und 25 Seiten Anhang. Verzeichnisse,
Deckblatt und die Erklärung zählen dabei zusätzlich. Für deine
Arbeit gelten die Vorgaben deiner eigenen IHK, auch bei Schriftart,
Schriftgröße und Position der Seitenzahlen. Formfehler können zu
Punktabzug führen. Beginne den Fließtext mit der Seitenzahl 1 auf
der ersten Seite der Einleitung und nummeriere ihn mit arabischen
Ziffern durch. So lässt sich sein Umfang direkt erkennen. Für die
Seiten davor empfehle ich große römische Ziffern, für den Anhang
kleine römische Ziffern. Platziere die Seitenzahlen durchgehend an
derselben Stelle, beispielsweise unten rechts oder unten mittig.
Beim Durchblättern sollen sich Seiten und Verweise schnell finden
lassen. Beim Prüfen zähle ich auch den Platz, den dein Text
tatsächlich einnimmt. Größere Artefakte und umfangreiche leere
Bereiche ziehe ich dafür vom Seitenumfang ab. Seiten sinnvoll
füllen und Kapitel gliedern Lass Kapitel innerhalb der kurzen
Dokumentation mit etwas Abstand aufeinander folgen. Seitenumbrüche
vor jeder Kapitelüberschrift erzeugen schnell mehrere Seiten
Leerraum, wodurch Platz für deine Inhalte verloren geht. Das kann
sich auf die Note auswirken. Ich empfehle dir höchstens zwei
Gliederungsebenen; die dritte Ebene bildet für mich die Obergrenze.
Bei 15 Seiten führen tiefere Ebenen zu sehr kurzen Unterkapiteln.
Orientiere die Kapitel an den Projektphasen, die du durchlaufen
hast. Halte zusammengehörige Absätze beim Seitenwechsel möglichst
zusammen. Eine letzte Absatzzeile allein auf der Folgeseite heißt
im Textsatz "Hurenkind". Steht nur die erste Zeile eines Absatzes
am Ende einer Seite, spricht man von einem "Schusterjungen". Word
bietet dafür eine automatische Absatzkontrolle; in LaTeX lässt sich
das entsprechend einstellen. Sorge dafür, dass eine Überschrift
zusammen mit dem zugehörigen Text auf derselben Seite beginnt.
Trenne Absätze durch einen sichtbaren vertikalen Abstand, damit
einzelne Gedankengänge erkennbar bleiben. In LaTeX lässt sich das
über die passende Klasse beziehungsweise deren Einstellungen
festlegen. Schrift und Fließtext gestalten Halte dein Schriftbild
einheitlich. Für den Fließtext empfehle ich eine Serifenschrift,
etwa Times New Roman. Serifen sind kleine Ansätze an den
Buchstaben, die das Auge beim Lesen entlang der Zeile führen
sollen. Arial ist eine serifenlose Schrift. Prüfe auch die
voreingestellten Schriftarten deiner Textverarbeitung. Setze den
Fließtext nach meiner Empfehlung in Blocksatz mit aktivierter
Silbentrennung. Durch die Silbentrennung lassen sich große Lücken
zwischen Wörtern vermeiden, die beim Blocksatz entstehen können.
Hebe Begriffe sparsam mit Fett- oder Kursivschrift hervor.
Unterstrichene Wörter wirken heute häufig wie Links. Zusätzliche
Leerzeichen zwischen einzelnen Buchstaben erschweren der
Textverarbeitung, ein Wort zu erkennen. Berücksichtige, dass
Prüfer:innen deine Dokumentation möglicherweise schwarz-weiß
ausdrucken. Farbige Hervorhebungen können dabei ihren Zweck
verlieren. Begriffe einheitlich formatieren Lege fest, wie du
bestimmte Arten von Begriffen darstellst, und halte diese Regeln im
gesamten Text ein. Wenn Fachbegriffe kursiv erscheinen, sollten
alle entsprechenden Begriffe so gesetzt sein. Abweichungen lassen
mich beim Prüfen nach einer Bedeutung suchen und können als
unsauber gearbeitet auffallen. Arbeite mit semantischen Befehlen
oder Formatvorlagen. In LaTeX kannst du eigene Befehle etwa für
Klassennamen und Entitäten anlegen. Word bietet dafür
Textformatvorlagen. Damit änderst du die Darstellung einer
Begriffskategorie zentral. Für Code und technische Bezeichner
empfehle ich nichtproportionale Schrift. Dabei hat jedes Zeichen
dieselbe Breite, wodurch Einrückungen und untereinanderstehende
Zeichen erhalten bleiben. Auch Kommandozeilenbefehle lassen sich so
kennzeichnen. Verwende Formatvorlagen, wenn du Begriffe hervorheben
möchtest. Anführungszeichen sind eingegebene Textzeichen und müssen
bei einem späteren Wechsel der Darstellung einzeln entfernt werden.
Wo Anführungszeichen sprachlich erforderlich sind, gehören in einen
deutschen Text die typografisch passenden Zeichen: "…". Artefakte
in den Anhang aufnehmen Ich empfehle dir, Artefakte grundsätzlich
im Anhang unterzubringen. Alles, was größer als eine halbe Seite
ist, gehört nach meiner Regel dorthin. Im genannten Beispiel stehen
15 Textseiten zur Verfügung, um ein 70-stündiges Projekt zu
dokumentieren. Große Abbildungen und Tabellen nehmen davon viel
Platz ein. Gib jedem Artefakt eine aussagekräftige Beschriftung und
eine fortlaufende Nummer. Dazu gehört das passende Verzeichnis,
beispielsweise ein Abbildungs- oder Tabellenverzeichnis. Verweise
im Fließtext ausdrücklich auf jedes Artefakt, etwa mit "wie im
ER-Modell in Abbildung 7 zu sehen ist". Dadurch erhält es einen
nachvollziehbaren Bezug zu deinem Projekt. Artefakte ohne Bezug zum
Text führen bei mir zu Punktabzug. Diagramme lesbar exportieren
Exportiere Diagramme möglichst als Vektorgrafiken, beispielsweise
im SVG- oder EPS-Format. Sie bleiben beim Vergrößern im PDF und
beim Drucken scharf. Prüfe die Größe der Schrift innerhalb deiner
Diagramme. Auch Beschriftungen in ER-Modellen und Klassendiagrammen
müssen lesbar sein, damit ich die Inhalte bewerten kann.
Rastergrafiken wie JPEG, PNG oder GIF werden beim Vergrößern
pixelig. Das gilt ebenfalls für Screenshots. Quelltext und
Screenshots auswählen Setze Quelltext in nichtproportionaler
Schrift mit nachvollziehbaren Einrückungen. Syntax-Highlighting
erleichtert das Lesen; dafür sind auch Farben oder weitere
Hervorhebungen möglich. Lass deine Textverarbeitung den Quelltext
direkt darstellen. Das LaTeX-Paket listings unterstützt anpassbare
Hervorhebungen und Zeilennummern. Außerdem kannst du ausgewählte
Zeilen unmittelbar aus einer Quellcodedatei einbinden. Wähle
Codeausschnitte, die interessante Teile deiner Arbeit zeigen.
Seiten voller Getter und Setter beanspruchen Platz, ohne viel über
dein Projekt zu vermitteln. Schneide Screenshots auf den relevanten
Bereich zu. Zeige beispielsweise das Programmfenster, damit dein:e
Prüfer:in die Oberfläche ausreichend groß erkennen kann. Desktop
und Hintergrundfenster nehmen zusätzlichen Platz ein. Typografische
Details und meine Checkliste Ich achte beim Prüfen auch auf
typografische Details. Ein Bindestrich ist kürzer als ein
Gedankenstrich; LaTeX stellt
Kommentare (0)
Melde dich an, um einen Kommentar zu schreiben.