In der siebenundzwanzigsten Episode des
Anwendungsentwickler-Podcasts gehe ich die Punkte einer sinnvollen
Gliederung der Projektdokumentation (bis zur Einleitung) durch.
TL;DR Beim Lesen deiner Projektdokumentation achte ich darauf, dass
ich deinen Projektablauf und deine eigene Arbeit nachvollziehen
kann. Dafür richtest du die Gliederung an deinem Vorgehen aus und
hältst die Vorgaben deiner IHK ein. Nach den Deckblättern und
passenden Verzeichnissen folgt eine verständliche Einleitung, aus
der auch eine branchenfremde Person dein Projektziel und die
Schnittstellen erkennt. Meine kostenlose Vorlage hilft dir beim
Aufbau, wobei du sämtliche Inhalte mit deiner eigenen Projektarbeit
füllst. Kapitelmarken [00:00:00] Thema und weiterführende Website
[00:00:30] Die Projektdokumentation in der Abschlussprüfung
[00:02:22] Kostenlose LaTeX-Vorlage und Beispiel-PDF [00:03:49]
Eigene Inhalte und verantwortlicher Umgang mit der Vorlage
[00:06:28] Die Gliederung am Projektablauf ausrichten [00:07:52]
IHK-Formblatt und Vorgaben zur Abgabe [00:09:14] Das eigene
Deckblatt gestalten [00:11:55] Inhaltsverzeichnis und
praxisbezogener Projektbericht [00:14:01] Weitere Verzeichnisse und
formale Qualität [00:15:36] Seitenumfang, Leerflächen und große
Abbildungen [00:17:21] Abkürzungsverzeichnis und Glossar [00:19:29]
Eine verständliche Einleitung schreiben [00:22:24]
Projektbeschreibung und Anlass des Projekts [00:23:46] Personelle
und technische Schnittstellen [00:24:35] Projektabgrenzung und
eigene Arbeit [00:26:51] Ausblick auf weitere Inhalte der
Projektdokumentation [00:27:46] Früh beginnen und die Vorlage
herunterladen [00:28:26] Lizenz und Quellenhinweis zur Vorlage
[00:29:03] Feedback zur Vorlage und LaTeX-Einstiegskurs [00:30:21]
Rückmeldungen zum Podcast [00:31:00] Newsletter und Checklisten für
die Abschlussprüfung Inhalt Formblatt der IHK Deckblatt Name des
Prüflings Projektname und -thema Datum Logos der IHK und des
Unternehmens sind nett Verzeichnisse Inhalt Abbildungen Tabellen
Listings Abkürzungen keine allgemein bekannten Abkürzungen
aufnehmen Einleitung Projektbeschreibung (Ziel, Begründung)
Schnittstellen Projektabgrenzung Literaturempfehlungen * * Links
Permalink zu dieser Podcast-Episode RSS-Feed des Podcasts
Themenfindung für das Abschlussprojekt -
Anwendungsentwickler-Podcast #24 Inhalte des Projektantrags -
Anwendungsentwickler-Podcast #25 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 Gliederung passend zu
deinem Projekt Als Prüfer lese ich deine Projektdokumentation, um
nachzuvollziehen, wie du dein Projekt umgesetzt hast. Alles, was du
darin beschreibst, muss zu deiner geleisteten Arbeit passen. Die
Dokumentation gehört zusammen mit der Präsentation zu den Teilen
der Abschlussprüfung, die du selbst gestalten kannst. Plane dafür
ausreichend Zeit ein und beginne früh mit dem Schreiben. Orientiere
die Gliederung an deinem tatsächlichen Projektablauf. Wenn du agil
entwickelt hast, muss dieses Vorgehen auch im Aufbau erkennbar
sein. Passe die Kapitel einer Vorlage an dein Projekt an. Welche
Inhalte an welcher Stelle stehen, hängt von deiner Arbeit ab. Der
hier beschriebene Aufbau reicht bis zur Einleitung. Die weiteren
Projektphasen folgen in einer späteren Episode. Meine Vorlage als
Hilfe beim Schreiben Auf meiner Website findest du eine kostenlose
Vorlage für LaTeX sowie ein daraus erzeugtes PDF. Darin stehen
Beispielinhalte und Hinweise auf weiterführende Literatur. An den
enthaltenen Abbildungen kannst du sehen, wie sich solche Inhalte in
die Dokumentation einfügen lassen. Du kannst das Layout und den
Aufbau übernehmen, während du die fachlichen Inhalte selbst
verfasst. Passe auch Beispielrechnungen an deine echten
Projektdaten an. Dazu gehören etwa die Stundensätze. Prüfer:innen
kennen solche Vorlagen. Unverändert übernommene Inhalte können zu
einer schlechten Bewertung führen und Fragen nach einem Plagiat
aufwerfen. Die Vorlage hilft dir dabei, an relevante
Projektbestandteile zu denken und Ideen für deine eigene Arbeit
aufzugreifen. Formblatt und eigenes Deckblatt Bei meiner IHK
beginnt die abgegebene PDF-Datei mit einem vorgeschriebenen
Formblatt. Darauf stehen Angaben zu dir und deinem
Ausbildungsbetrieb sowie das Projektthema und der Abgabetermin. Die
Datei wird online im Prüfungssystem hochgeladen. Welche Regeln für
dich gelten, ergibt sich aus den Vorgaben deiner IHK. Achte auf
verpflichtende Inhalte und deren vorgeschriebene Position. Auch
Vorgaben zu Leerseiten gehören dazu, sofern deine IHK sie verlangt.
Fehlende Pflichtbestandteile können als Formfehler zu Punktabzug
führen. Auf das Formblatt folgt häufig ein selbst gestaltetes
Deckblatt. Ein Firmenlogo kann es optisch ergänzen. Platziere das
Projektthema gut sichtbar. Ein prägnanter Titel hilft mir, deine
Arbeit beim Lesen mehrerer Dokumentationen wiederzuerkennen. Auf
das Deckblatt gehören außerdem dein Name und Angaben zum
Ausbildungsbetrieb. Ergänze das Datum, die zuständige IHK sowie
deine Anschrift und Kontaktdaten. In manchen IHKs werden Prüflinge
beispielsweise kontaktiert, um Quelltext nachzureichen.
Inhaltsverzeichnis und weitere Verzeichnisse Ich schaue mir das
Inhaltsverzeichnis an, um einen Überblick über die Kapitel zu
bekommen. Dabei erkenne ich, ob die Projektphasen sinnvoll
angeordnet sind und beispielsweise die Kostenplanung an einer
passenden Stelle steht. Das Inhaltsverzeichnis gehört direkt hinter
das Deckblatt. Ergänze Verzeichnisse für Abbildungen und Tabellen,
sofern diese Inhalte vorkommen. Für Quelltextausschnitte ist ein
Listingsverzeichnis sinnvoll. Erzeuge Verzeichnisse mit deiner
Textverarbeitung automatisch und prüfe anschließend die Verweise.
Nummern und Referenzen müssen stimmen. Kurze Verzeichnisse können
gemeinsam auf einer Seite stehen. Deine Dokumentation ist ein
praxisbezogener Projektbericht. Dazu passen ein Quellenverzeichnis
und sauber nummerierte Seiten. Eine Danksagung oder ein Abstract
halte ich für diesen Rahmen für überzogen. Als angehende:r
Fachinformatiker:in Anwendungsentwicklung solltest du mit der
eingesetzten Textverarbeitung umgehen können. Fehler bei Verweisen
können ebenso wie Rechtschreibfehler oder ein unpassendes Layout in
die Bewertung einfließen. Seitenvorgaben und Platz im Fließtext Bei
meiner IHK sind 15 Seiten Fließtext vorgegeben. Ich prüfe beim
Lesen, wie viel davon mit Text gefüllt ist, und ziehe größere
Leerflächen sowie umfangreiche Grafiken oder Tabellen davon ab.
Diese Vorgehensweise beschreibt meine Prüfpraxis im genannten
IHK-Rahmen. Richte dich nach den Seitenvorgaben deiner IHK.
Verschiebe große Abbildungen und umfangreiche Tabellen in den
Anhang. Achte darauf, dass Seitenumbrüche keine großen leeren
Flächen erzeugen. Die aufgedruckte letzte Seitenzahl allein zeigt
den Umfang des Fließtextes nur unzureichend. In meiner Bewertung
können Abweichungen von der Vorgabe zu Punktabzug führen.
Abkürzungen verständlich machen Im Abkürzungsverzeichnis löst du
projektbezogene Kürzel auf. Besonders bei internen Begriffen aus
deinem Betrieb oder deiner Branche brauchen Leser:innen diese
Hilfe. DSL kann beispielsweise "Domain Specific Language" bedeuten,
während die Abkürzung vielen als "Digital Subscriber Line" bekannt
ist. Halte die Bedeutung in deinem Projekt fest. Auch ein
technisches Kürzel wie GUI für "Graphical User Interface" darf
aufgenommen werden. Allgemein bekannte Schreibweisen wie "z. B."
brauchen keinen eigenen Eintrag. Ein Glossar würde ich hinter dem
Fließtext platzieren. Das Abkürzungsverzeichnis schließt die
Verzeichnisse vor dem eigentlichen Text ab. Die Einleitung: Dein
Projekt verständlich beschreiben Nach der ersten halben Seite
möchte ich bereits verstehen, welche Aufgabe du bearbeitest.
Schreibe deshalb so, dass eine Person außerhalb deines Unternehmens
und deiner Branche dem Projekt folgen kann. Branchenspezifische
Fachbegriffe erklärst du dort, wo sie zum Verständnis gebraucht
werden. Projektbeschreibung und Anlass Beschreibe das Ziel und den
Inhalt deines Projekts. Begründe, weshalb das Projekt umgesetzt
wird. Die ausführliche Wirtschaftlichkeitsanalyse kann später
folgen. Wenn du eigene Software entwickelst, muss der Anlass dafür
nachvollziehbar sein. Die pauschale Behauptung, am Markt gebe es
keine passende Software, ist als Begründung wenig überzeugend.
Schnittstellen und eigene Arbeit Benenne die personellen
Schnittstellen, also etwa Kolleg:innen, mit denen du
zusammenarbeitest. Beschreibe die technischen Schnittstellen und
die Anforderungen, die sich daraus für deine Arbeit ergeben. Bei
einem Teilprojekt muss erkennbar sein, welchen Anteil du selbst
bearbeitest. Kennzeichne vorhandene Bestandteile und Arbeiten
anderer Beteiligter ausdrücklich. Das gilt auch für Diagramme und
Datenbankmodelle. Gerade bei Änderungen an bestehenden ERP-Systemen
können dargestellte Strukturen bereits vorhanden sein. Bei einem
vollständig eigenständigen Projekt kann eine gesonderte
Projektabgrenzung entfallen. Weiterführende Materialien Die
Shownotes mit dem Link zur Vorlage findest du unter
anwendungsentwicklerpodcast.de/27. Weitere Informationen zur
Projektdokumentation stehen auf dieperfekteprojektdokumentation.de.
Meine Vorlage steht unter einer Creative-Commons-Lizenz. Vermerke
meinen Namen und meine Website im Quelltext; ein sichtbarer Hinweis
im abgegebenen PDF ist dafür entbehrlich. Auf meiner Website
findest du einen LaTeX-Einstiegskurs mit zehn Videos....
Kommentare (0)
Melde dich an, um einen Kommentar zu schreiben.