Projektdokumentation Fachinformatiker Anwendungsentwicklung

Deckblatt: In der Regel ist hier die Vorlage der jeweiligen IHK, bei der du deine Projektdokumentation einreichst, zu verwenden. Üblicherweise beinhaltet das Deckblatt deinen Namen, deinen Ausbildungsberuf, deine Prüfungsnummer, deinen Ausbildungs- oder Praktikumsbetrieb und den Titel deiner Projektdokumentation.

Inhaltsverzeichnis: Deine Projektdokumentation wird umfangreich. Allein deshalb ist ein Inhaltsverzeichnis unverzichtbar für jeden, der sich mit deinem Projekt auseinandersetzt. 

Dokumentation: In deiner Dokumentation erläuterst du die Ausgangslage und Ziel deines Projektes, erstellst ein Lösungskonzept (Planung), beschreibst ein Lösungskonzept (Durchführung) und dokumentierst Kontrolle und Abschluss deines Projektes.

Anhang: Hierzu gehören Glossar, Literaturverzeichnis, Darstellungsverzeichnis, Benutzerdokumentation, Diagramme und Quellcode.

Deine Einleitung soll den Leser abholen und informieren, wieso und weshalb du dieses Projekt durchführst. Sie soll dabei helfen, den Hintergrund und die gegebenen Voraussetzungen zu verstehen. Du schaffst damit also den Kontext für den restlichen Teil der Dokumentation.
 

Ausgangssituation / Auftragsbeschreibung: Was ist die Ausgangsbasis des Projektes? Beschreibe, wie die Situation vor dem Start des Projektes war und wie der Auftrag lautet.
 

Abgrenzung: Du kannst mit deinem Projekt nicht “alle Probleme” lösen. Grenze daher klar ab, was dein Projekt nicht leisten oder können soll.
 

Betriebliche Umfeldbeschreibung des Auftragnehmers und Auftraggebers: Die Prüfer kennen deinen Betrieb und dein Arbeitsumfeld nicht. Zeige ihnen, in welchem Umfeld du arbeitest bzw. in welchem Umfeld du dein Projekt durchgeführt hast.
 

Begründung: Erläutere, warum du genau dieses Projekt durchführen willst. Was motiviert dich, wie bist du auf dieses Projekt gekommen? Was willst du damit erreichen?
 

Schnittstellen: Zeige auf, welche Anwendungen, aber auch welche Personen im Rahmen deines Projektes prozessrelevant sind.

Hier geht es in’s Detail. Du erläuterst, welche Ressourcen du planst, wie viel Zeit du für das Projekt veranschlagst und wie viel Personal du einsetzt. Auch die Projektkosten sollten in diesem Teil der Projektdokumentation für Fachinformatiker Anwendungsentwicklung detailliert beschrieben werden. Beschreibe auch das Modell, nach dem du im Projekt vorgehst, z. B. SCRUM oder Kanban.
 

Ablaufplanung (grafisch): Stelle den Ablauf deines Projektes dar. Grafiken helfen dabei, den Ablauf deines Projektes übersichtlich darzustellen und verständlich zu machen. Hierfür bietet sich der sogenannte Balkenplan (auch Gantt-Diagramm genannt) an.
 

Sachmittelplanung / Ressourcenplanung: Liste auf, welche Arbeitsmittel du benötigst und wofür du sie einsetzt. 
 

Terminplanung: Erläutere, welchen Projektschritt du zu welchem Zeitpunkt durchführst. Der Vorteil bei diesem Teil der Projektdokumentation ist, dass du die Zeit- bzw. Ablauf- oder Terminplanung bereits für deinen Projektantrag erstellt hast und nun darauf zurückgreifen kannst. 
 

Kostenplanung: Beschreibe, wie sich die Gesamtkosten deines Projektes zusammensetzen. Wie bei der Personalplanung, Sachmittelplanung oder Terminplanung macht es Sinn, hier eine tabellarische Darstellung zu wählen, um deinen Kostenplan darzustellen. Bitte beachte, dass du auch immer die Quelle für die Kosten aufführen und nicht einfach Schätzwerte eintragen kannst. Hast du Personal geplant, musst du an dieser Stelle auch darlegen, mit welchem Stundenlohn du rechnest. Hast du die Kosten kalkuliert, musst du darstellen, ab wann sich dein Projekt rechnet. Zur Kostenplanung gehört auch die sogenannte “Make or Buy” Entscheidung. Hier sollst du aufzeigen, ob du nach einer bereits vorhandenen Lösung für dein “Problem” recherchiert hast (Fremdbezug) bzw. dich bei der Umsetzung für eine eigene Lösung (Eigenfertigung) entschieden hast. 
 

Personalplanung: Zeige auf, welche Personen am Projekt beteiligt sind, welche Aufgaben sie übernehmen, welche Funktion sie im Unternehmen haben, wann sie für das Projekt benötigt werden und auch wie lange.
 

Qualitätssicherung: Wie willst du die Qualität deines Projektes sicherstellen? Zeige hier auf, welche Maßnahmen du dazu ergreifst. Im nächsten Schritt - bei der Durchführung des Projekts - solltest du dann auflisten, wie du diese Maßnahmen im Projekt eingesetzt hast.

In diesem Teil der Projektdokumentation für Fachinformatiker Anwendungsentwicklung geht es darum, genau darzulegen, wie du vorgegangen bist. Du zeigst auch, welche Soft- oder Hardware du ausgewählt hast und beschreibst bzw. begründest deine Vorgehensweise und Durchführungsschritte.
 

Ist-Zustand: Basierend auf der Ausgangssituation erfasst du detailliert den Ist-Zustand. Nur wenn der Ist-Zustand gründlich analysiert ist, kann man nach Beendigung des Projektes auch nachvollziehen, ob das Ziel erreicht wurde oder nicht.
 

Soll-Konzept: Zeige auf, wie der Zustand nach Beendigung deines Projektes aussehen soll, welche Hardware, Software und Vorgehensweisen du wählst. Begründe deine Entscheidungen ausführlich und zeige die Durchführungsschritte auf. 
 

Lastenheft: Ausgehend von der Ist-Analyse fertigst du das Lastenheft an, in dem die Anforderungen an das Projekt detailliert beschrieben sind. 
 

Entwurf: Nachdem die Anforderungen erfasst wurden, erstellst du einen Entwurf für die technische Umsetzung. Hierbei zeigst du u. a. auf, welche

• Programme du einsetzen willst
• welche Funktionen sie haben sollen
• wie die technische Umgebung aussieht
• wie du die Qualität sicherstellen willst

Pflichtenheft: Resultierend aus dem Lastenheft und dem Entwurf listest du im Pflichtenheft anschließend genau auf, welche technische Umsetzung du planst.
 

Umsetzung: Dokumentiere die anschließende Umsetzung ausführlich. Beschreibe dabei möglichst genau, wie du vorgegangen bist. Du kannst an dieser Stelle auch mit Screenshots arbeiten, um dein Vorgehen besser verständlich zu machen.
 

Qualitätsmanagement: Qualitätsmanagement ist ein wichtiger Bestandteil eines jeden (IT)-Projektes. In der Projektplanung hast du bereits beschrieben, wie du die Qualität gewährleisten möchtest. An dieser Stelle musst du nun zeigen, wie du die definierten Maßnahmen eingesetzt hast und welche Maßnahmen ggf. daraus resultiert sind.
 

Dokumentation: Nicht nur bei der Projektarbeit, auch bei jedem späteren IT-Projekt ist eine ausführliche Dokumentation unerlässlich. Daher musst du beschreiben, wie du deine Arbeit dokumentiert hast, die eigentliche Entwickler- oder Benutzerdokumentation kannst du als Anhang beifügen.

Ist die Arbeit getan, folgt die Übergabe an den Kunden, aber auch die Bewertung des Projektes. Auch das muss von dir in der Projektdokumentation für Fachinformatiker Anwendungsentwickler festgehalten werden.
 

Abnahme: Nachdem du das Projekt fertiggestellt hast, erfolgt die Abnahme bzw. die Übergabe an den Kunden bzw. Auftraggeber. Die Abnahme sollte mithilfe eines Abnahmeprotokolls dokumentiert werden, welches dann ebenfalls Bestandteil der Projektdokumentation sein muss. Im Protokoll wird festgehalten, ob das Projekt erfolgreich abgenommen wurde, aber auch wenn Mängel festgestellt wurden. 
 

Soll-Ist-Vergleich: Zu Beginn der Projektdokumentation hast du die Projektziele definiert. In dem Soll-Ist-Vergleich hältst du nun fest, ob die gesteckten Ziele erreicht wurden. Du stellst die geplanten Kosten den tatsächlichen Ausgaben gegenüber, genauso wie die Ressourcen- und Terminplanung. An dieser Stelle kannst du wieder gut mit Tabellen arbeiten, um den Vergleich übersichtlich darzustellen.
 

Fazit: Halte fest, ob das gestellte Ziel des Projektes erreicht wurde oder nicht. Wichtig: Du musst dein Projekt für die Abschlussprüfung nicht zwingend mit Erfolg abschließen. Schön ist es natürlich, aber in dem Abschlussprojekt geht es nicht um Erfolg oder Misserfolg, sondern darum, das du ein Projekt von vorn bis hinten selbstständig planst und durchführst.
 

Ausblick: Das Projekt ist fertig und abgenommen. Und nun? Zeige, ob und welche Schritte es nach Abschluss des Projektes gibt. Kann man das Projekt weiter ausbauen, gibt es weitere Entwicklungsschritte? Bietest du für dein Projekt im Anschluss Support an? Das alles gehört dann hier in den Ausblick.

Hast du Fremdwörter verwendet? Dann erläutere diese unbedingt im Glossar, damit der Prüfer bei Bedarf dort nachschlagen kann. Wichtig ist, dass du die Entwickler- und Kundendokumentation in den Anhang packst, genauso wie weitere Dokumente z. B. Grafiken, Screenshots. Im Anhang der Projektdokumentation für Fachinformatiker Anwendungsentwicklung muss auch zwingend der Quellcode enthalten sein! Kennzeichne immer deutlich, woher du eine Quelle hast, z. B. intern, aus dem Internet, Literatur, etc.

Wie eingangs erwähnt, gibt es seitens deiner IHK weitere Vorgaben für die Gestaltung der Dokumentation. Da diese Vorgaben von IHK zu IHK abweichen können, bieten die nachfolgenden Eckdaten nur eine grobe Orientierung:

• Umfang: Der Umfang der reinen Projektarbeit sollte 12 bis 15 DIN A4 Seiten umfassen. Deckblatt, Inhaltsverzeichnis, Glossar, Anhang etc. zählen nicht dazu.
• Schriftgröße und -art: Du solltest eine übliche Schriftart wie z. B. Arial in der Größe 10 - 12 verwenden
• Zeilenabstand:  Er sollte 1,0 bis maximal 1,5 Zeilen betragen.
• Datenschutz: Verwendest du in deiner Projektdokumentation sensible Informationen, dann kennzeichne das entsprechend. 

Du bist angehender Fachinformatiker Anwendungsentwicklung? Wir helfen dir mit unseren Online-Kursen sowohl bei der Vorbereitung auf die Zwischenprüfung als auch auf die Abschlussprüfung. 

Bei Fragen beraten wir dich gerne!