Leitfaden Projektdokumentation Fachinformatiker für Anwendungsentwicklung/Systemintegration

Aktualisiert am:

Alle Artikel zur Abschlussprüfung

  1. GA1 Lernthemen und Lösungen - Fachinformatiker für Anwendungsentwicklung
  2. Wie am besten Lernen für Abschlussprüfungen GA1 und GA2 Fachinformatiker
  3. GA2 Lernthemen und Lösungen - Fachinformatiker für Anwendungsentwicklung
  4. Leitfaden Projektdokumentation Fachinformatiker für Anwendungsentwicklung/Systemintegration
  5. Leitfaden Projektantrag Fachinformatiker für Anwendungsentwicklung/Systemintegration
  6. Kein Risiko bei der Präsentationsprüfung und dem Fachgespräch zum Fachinformatiker
  7. Übersicht der Abschlussprüfungen als Fachinformatiker

Das Ende der Ausbildung rückt immer näher und nun geht es darum, eine betriebliche Projektarbeit durchzuführen und zu dokumentieren. In diesem Guide werde ich euch zeigen, wie ihr eine gute Struktur in eure Projektdokumentation bringt und was ihr beachten solltet.

Projektdokumentation
Die vier Projektphasen.

Die in diesem Guide enthaltene Struktur ist keine Garantie für ein 100%iges Ergebnis, aber bietet euch einen guten Anhaltspunkt.

Wichtig: Die gesamte Projektdokumentation wird nicht in der Ich-Form verfasst!

Das folgende Buch war für mich eine sehr große Hilfe für die Bewältigung der schriftlichen, sowie der mündlichen Prüfungen und der Projektarbeit: IT-Berufe: Handbuch zur Abschlussprüfung IT-Berufe: 5. Auflage, 2012

Einleitung

Projektbeschreibung

Hier solltet ihr in einem kleinen Text einmal zusammenfassen, worum es eigentlich geht. Das heißt ihr beschreibt die Ausgangssituation und was mit eurem Projekt realisiert werden soll.

Beispiel: 

Der Kunde muss händisch die Stammdaten seiner Kunden in ein Programm einpflegen und möchte diesen Prozess nun automatisieren. Dazu wurdet ihr beauftragt ein Tool zu entwickeln, welches diesen Geschäftsprozess durch einen automatisierten Prozess ersetzt.

Projektumfeld

Wie bereits im Guide zum Projektantrag beschrieben, müsst ihr hier das Umfeld beschreiben, in dem euer Projekt durchgeführt wird.

Projektbegründung

Warum ist dieses Projekt sinnvoll? Welche Vorteile bringt dieses Projekt mit sich?

Beispiel:

Der zuvor beschriebene Prozess ist zeitaufwendig und anfällig für Fehler. Außerdem ist es möglich Routinearbeiten in einen automatisierten Prozess umzuwandeln und Ressourcen einzusparen.

Startphase

Ist-Analyse

Diesen Punkt habt ihr teilweise schon in der Projektbeschreibung erfasst. In der Ist-Analyse solltet ihr nun mehr ins Detail gehen und das heißt, den aktuellen Geschäftsprozess genau erläutern.

Beispiel:

Der Kunde nutzt momentan das Programm XY für die Eingabe der Stammdaten seiner Kunden. Die Daten liegen in folgender Form vor “…”.

Projektziele, -wünsche und –vorgaben

Zusammen mit dem Kunden werdet ihr ein Pflichtenheft(siehe unten) erstellen müssen, welches die Ziele, Wünsche und Vorgaben beschreibt. Diese solltet ihr hier noch einmal auflisten.

Projektbeteiligte Personen

Eine Liste der am Projekt beteiligten Personen darf in eurem Bericht nicht fehlen. Hier bietet es sich an, eine Tabelle zu erstellen, die die Personen auflistet und zudem die Funktion im Unternehmen beschreibt und die Rolle im Projekt.

Achtung:

Es müssen alle Personen aufgelistet werden, auch wenn diese Personen nur für Rückfragen eingesetzt werden. Das heißt, ihr müsst euch selbst unbedingt mit in diese Liste aufnehmen.

Beispiel:

NameFunktion bzw. PositionRolle im Projekt
Person 1Auszubildender Fachinformatiker für AnwendungsentwicklungProjektleiter und Auftragnehmer
Person 2EntwicklerCode-Review

Projektplanungsphase

Soll-Konzept

Die Projektplanungsphase beginnt mit einem Soll-Konzept. Dieses Konzept beschreibt den Zustand nach erfolgreicher Durchführung eures Projekts.

Zeit -, Ablauf- und Terminplanung

Zeitplanung

Diesen Teil der Projektdokumentation habt ihr eigentlich schon so gut, wie erledigt. In dem Antrag zur Projektarbeit habt ihr bereits eine grobe Einschätzung der Zeitplanung abgegeben. Nutzt diese Ausgangstabelle und schätzt die Zeit der einzelnen Phasen und Unterpunkte der Phasen.

Beispiel:

1. Startphase
Darstellung und Abstimmung des Auftrages/Ziels
Ist-Analyse durchführen/ erstellen
4h
2h

2h

2. Projektplanung
Soll-Konzept erstellen
Testkonzept erstellen
Pflichtenheft erstellen
Termin-, Ablauf- und Ressourcenplanung + Vorkalkulation erstellen
11h
2h
1h
5h
3h
3. Durchführungsphase
Backend-Klassendiagramm
Backend-Klassen und -Methoden implementieren
Frontendentwicklung
Benutzerhandbuch
35h
4h
23h
2h
5h
3h
4. Projektabschluss
Qualitätssicherung & Tests
Soll-Ist-Vergleich
Nachkalkulation
Präsentation und Abnahme der Ergebnisse
Projektdokumentation erstellen Pufferzeit
20h
3h
1h
1h
2h
10h
3h
Gesamt70h

Ablauf- und Terminplanung

Hier solltet ihr beschreiben, wann ihr mit dem Projekt beginnt und wann der späteste Anfangszeitpunkt für dieses Projekt ist.

Beispiel:

Durch Rückwärtsterminierung ausgehend von den 70 geplanten Stunden und einem 8 Stunden Arbeitstag wurde der 12. Januar 2016 als spätester Anfangszeitpunkt gewählt. Da das Projekt jedoch an keine feste Terminierung (Wir erinnern uns, dass wir kein Teilprojekt haben, sondern ein Eigenständiges), werde ich flexibel Zeit für das Projekt aufwenden.

„Make or Buy“-Entscheidung

Gibt es Vergleichbare Software am Markt? Habt ihr danach gesucht? – Wenn ja, dann solltet ihr das hier erwähnen und euer Ergebnis präsentieren. Beispielsweise in einer “Nutzwertanalyse“.

Ressourcenplanung

Was benötigt ihr alles für das Projekt und wofür genau? Vielleicht einen Standardarbeitsplatz, einen Computer usw. Listet alle Ressourcen, die für die Durchführung des Projekts benötigt werden, hier auf.

Personalplanung

Unter dem Punkt der Projektbeteiligten Personen weiter oben habt ihr bereits beschrieben, welche Personen an eurem Projekt beteiligt sind. Nun solltet ihr hier eine Tabelle abbilden, die beschreibt wann und wie lange ihr die Personen benötigt.

Beispiel:

Die Vorgangs Nr. bezieht sich beispielsweise auf ein Gantt-Diagramm.

NameAufgabe im ProjektVorgang Nr.Dauer
Person 1Rückfragen zu den im Einsatz befindlichen Tools31h
Person 2Code-Review193h

Projektkosten

Nachdem ihr die Planung der Ressourcen- und Personalnutzung abgeschlossen habt, könnt ihr nun die Kosten der einzelnen Ressourcen und Personen in einer Tabelle abbilden und daraus die Gesamtprojektkosten ermitteln.

Beispiel:

Vergesst nicht eine Fußnote zu vermerken, woher ihr die Kostenpauschale für die einzelnen Mitarbeiter nehmt.

VorgangMitarbeiterZeitKostenpauschale pro StundeGesamtkosten
EntwicklungAuszubildender70h10,00€700,00€
FachgesprächMitarbeiter2h25,00€50,00€
FachgesprächIT-Leiter/Ausbilder5h50,00€250,00€
Code-ReviewMitarbeiter3h25,00€75,00€
AbnahmeGeschäftsführer2h100,00€200,00€
Projektkosten gesamt                                                  1275,00€

Amortisationsdauer

Nachdem ihr die gesamten Projektkosten kalkuliert habt, könnt ihr die Zeitersparnis nach erfolgreichem Abschluss eures Projekts ermitteln. Danach müsst ihr eine Amortisationsrechnung durchführen, die den Zeitpunkt ermittelt, ab wann sich euer Projekt “lohnt“.

Beispiel:

Hier bietet es sich an, ein Diagramm einzufügen.

Die Dauer der Amortisation.
Die Dauer der Amortisation.

Planung der Qualitätssicherung

Wie habt ihr vor, die Qualität eure Arbeit zu überprüfen und zu bestätigen? Auf jeden Fall solltet ihr hier erwähnen, dass ihr ein Testprotokoll zuvor erstellt habt.

Durchführungsphase

In diesem Teil der Projektdokumentation gehört all das rein, was ihr in der Durchführung gemacht habt.

Entscheidung

Welche fundamentalen Entscheidungen mussten getroffen werden? Erforderten diese Entscheidungen eine Absprache mit eurem Auftraggeber?

Beispiel:

Für die Entwicklung des automatisierten Tools zum Einpflegen von Stammdaten werden die folgenden externen Frameworks genutzt. Diese Frameworks wurden ausgewählt, weil…

Klassendiagramme

Habt ihr ein Klassendiagramm erstellt? – Fügt es ein und beschreibt, wieso, weshalb, warum ihr das so gemacht habt.

Test

Wie habt ihr während der Durchführungsphase die korrekte Funktionsweise bestätigt?

Einrichtung

Auch die Einrichtung der Software/Hardware muss beschrieben werden und sollte noch vor dem Beginn der Abschlussphase passieren.

Benutzerhandbuch

Bei Software bietet es sich an, diese in einem Benutzerhandbuch zu beschreiben. Dieser Punkt ist ein zusätzliches Qualitätsmerkmal, welches ihr in den anderen Punkten ebenfalls erwähnen solltet.

Projektabschlussphase

Abnahme

Die Projektabschlussphase beginnt mit der Projektabnahme zusammen mit eurem Auftraggeber. Während dieser Abnahme solltet ihr ein Abnahmeprotokoll vom Auftraggeber unterzeichnen lassen.

In diesem Protokoll sollte festgehalten werden, ob das Projekt abgenommen wurde oder nicht. Sollte das Projekt abgenommen werden, muss beschrieben werden, ob alle Ziele erfüllt wurden oder Mängel während der Abnahme auftraten.

Die Projektendabnahme muss in der Projektdokumentation genau beschrieben werden.

Beispiel:

Die Abnahme des Projekts erfolgte am 2. Februar 2016 ohne Mängel. Die Abnahme wurde mittels des im Anhang befindlichen Testprotokolls durchgeführt. Das Protokoll befindet sich im Anhang.

Dokumentation

Was habt ihr alles dokumentiert und was beinhaltet die Dokumentation.

Beispiel:

Neben der eigentlichen Projektdokumentation, wurden eine ausführliche Quellcode-Dokumentation und ein Benutzerhandbuch verfasst. Die Projektdokumentation beinhaltet eine ausführliche Beschreibung der zum Durchlauf der einzelnen Projektphasen. Die Quellcode-Dokumentation beinhaltet….

Soll-Ist-Vergleich

Nun veranschaulicht ihr in einer Tabelle, welche Musskriterien(Ziele) erfüllt wurden und welche nicht. Zusätzlich könnt ihr eine Tabelle über die Wunschkriterien hier auflisten.

Beispiel:

KriteriumBeschreibungStatus
W1Wunschkriterium 1nicht erfüllt
W2Wunschkriterium 2erfüllt
W3Wunschkriterium 3nicht erfüllt

Nachkalkulation

Eine Nachkalkulation ist zwingend erforderlich. Hier solltet ihr einmal auflisten, wie viel Zeit ihr geplant hattet und wie viel ihr tatsächlich benötigt habt. Danach könnt ihr bekommen, eine Aufstellung der tatsächlichen Kosten zu erstellen und eine Aussage über die tatsächlichen Projektkosten treffen.

Beispiel:

ProjektphaseGeplantTatsächlichDifferenz
Startphase4 h3 h-1 h
Projektplanung11h13 h+2 h
Durchführungsphase35 h34 h-1 h
Projektabschluss20 h19 h-1 h
Gesamt70 h69-1 h

Qualitätsmanagement

In diesem Punkt müsst ihr beschreiben, was ihr getan habt, um die Qualität zu wahren. Sprich, welche Tests wurden wie durchgeführt. Hattet ihr Vorgaben von eurem Auftraggeber, die ihr erfüllen musstest?

Beispiel:

Vorgaben:

  • Firmeninternen Code-Style einhalten
  • Unit Tests vor der Implementation erstellen

Zur Wahrung des Qualitätsmanagements wurde der firmeninterne Code-Style eingehalten und zusätzlich wurden vor der eigentlichen Implementation Unit Tests erstellt. Die ausführliche Code-Dokumentation hat beispielsweise den positiven Effekt, dass die Einarbeitungszeit für andere Mitarbeiter relativ gering ist.

Ausblick

Euer Projekt ist abgeschlossen und nun? Was ist mit Support oder Weiterentwicklungen?

Unter diesem Punkt müsst ihr beschreiben, wie nach der Abnahme mit dem Kunden verfahren wird. Übernehmt ihr beispielsweise den Support für die Software? Was ist, wenn der Kunde noch Wünsche hat?

Rückblick

Dieser Punkt darf ruhig ein wenig länger beschrieben werden von euch. Hier reflektiert ihr erst einmal euer Projekt.

  • Was war gut?
  • Was war schlecht?
  • Was würdet ihr beim nächsten Projekt anders machen?
  • Wie schätzt ihr eure eigene Leistung ein?
  • War der Kunde zufrieden?
  • usw.

Hier dürft ihr übrigens zum aller ersten Mal die Ich-Form benutzen.

Glossar

Zum Schluss eurer Projektdokumentation darf natürlich ein Glossar nicht fehlen. Hier tauchen alle Fremdwörter und Fachbegriffe auf, die ihr in der Dokumentation erwähnt habt.

Beispiel:

Begriff/AbkürzungBeschreibung
PHPIst eine Skriptsprache, welche hauptsächlich im Webbereich zum Einsatz kommt, um dynamisch Dokumente zu erstellen.

Anlagenverzeichnis

Das Anlagenverzeichnis beinhaltet hauptsächlich große Bilder oder einzelne Dokumente, wie Pflichtenheft, Lastenheft usw.

Testprotokoll

Ein Testprotokoll für die Qualitätssicherung ist unerlässlich und sollte auf keinem Fall fehlen.

Beispiel:

Nr.TestfallErwartetes ErgebnisTatsächliches Ergebnis
T1Beschreibt, was in dem Test gemacht wird.Welches Ergebnis wird erwartet?Welches Ergebnis trat tatsächlich auf?

Gantt-Diagramm

Im Bezug auf die Zeit-, Termin- und Ablaufplanung sollte ein Gantt-Diagramm erstellt werden, beispielsweise mit Excel.

Beispiel:

Beim Erstellen des Gantt-Diagramms solltet ihr unbedingt eine Liste aller Personen hinzufügen. Diese Liste muss zusätzlich die Vorgangsnummer enthalten.
Beim Erstellen des Gantt-Diagramms solltet ihr unbedingt eine Liste aller Personen hinzufügen. Diese Liste muss zusätzlich die Vorgangsnummer enthalten.

Pflichtenheft

Das ein Pflichtenheft auf jeden Fall nötig ist, brauche ich wohl nicht mehr zu erwähnen. Wer ein bisschen Lektüre dazu lesen möchte, kann sich folgenden Link anschauen: Wozu Plichten- und Lastenhefte in IT-Projektverträgen – und was muss rein?

Benutzerhandbuch

Ein Benutzerhandbuch stellt ein Qualitätsmerkmal dar und sollte in jedem Fall erstellt werden.

Hier beschreibt ihr:

  • Was kann die Software?
  • Wie konfiguriere ich sie?
  • Wie benutze ich sie?
  • Ansprechpartner

Abnahmeprotokoll

Für mehr Informationen zum Abnahmeprotokoll solltet ihr euch den Artikel von projektmagazin.de anschauen.

IHK Formulare

Abschließend verlangt die Industrie- und Handelskammer ein paar Formulare zur Bestätigung über die durchgeführte Projektarbeit. Diese Formulare müssen ausgefüllt werden und von eurem Ausbildungsbetrieb unterzeichnet werden.

  • IHK-Formular zur Bestätigung der eigenständig durchgeführten Arbeit
  • IHK-Protokoll über die durchgeführte Projektarbeit

Alle Artikel zur Abschlussprüfung

  1. GA1 Lernthemen und Lösungen - Fachinformatiker für Anwendungsentwicklung
  2. Wie am besten Lernen für Abschlussprüfungen GA1 und GA2 Fachinformatiker
  3. GA2 Lernthemen und Lösungen - Fachinformatiker für Anwendungsentwicklung
  4. Leitfaden Projektdokumentation Fachinformatiker für Anwendungsentwicklung/Systemintegration
  5. Leitfaden Projektantrag Fachinformatiker für Anwendungsentwicklung/Systemintegration
  6. Kein Risiko bei der Präsentationsprüfung und dem Fachgespräch zum Fachinformatiker
  7. Übersicht der Abschlussprüfungen als Fachinformatiker

2 Gedanken zu „Leitfaden Projektdokumentation Fachinformatiker für Anwendungsentwicklung/Systemintegration“

  1. Das Soll-Konzept beschreibt NICHT den Zustand nach erfolgreicher Durchführung eines Projektes. Sonst könnte man es vom Ziel des Projektes nicht unterscheiden!

    Das Soll-Konzept beschreibt den Weg, den man aus vielen möglichen Wegen gewählt hat, um das Ziel zu erreichen.
    Beispiel: Ein Kunde gibt das Ziel vor: Baue mir eine Schokoladenkeksmaschine.
    Das Konzept könnte so aussehen: Die Zutaten werden bereits verrührt angeliefert, die Masse wird auf sechs unterschiedlichen Bearbeitungssträngen in sechs unterschiedliche Formen gepresst, die Formstücke werden frittiert, die frittierten Kekse werden abgekühlt und sortiert in eine Verpackung gelegt. Die Schokokekse sind fertig.
    Das Konzept könnte aber auch so aussehen: Die Zutaten werden einzeln angeliefert und in der Maschine verrührt, die Masse wird in Kugelform gepresst, die Kugeln werden durch einen Backofen gefahren, so dass sie am Ende fertig herauskommen. Jeweils 500 fertige Kugeln fallen in einen großen Behälter und können mit dem Behälter ausgeliefert werden. Die Schokokekse sind fertig.
    Das sind zwei unterschiedliche Konzepte für ein Ziel.

    Dazu einige Quellen:
    https://de.wikipedia.org/wiki/Konzept
    https://de.wikipedia.org/wiki/Skizze
    https://de.wikipedia.org/wiki/Idee
    https://de.wikipedia.org/wiki/Entwerfen

    Aus alle den Links ergibt sich, dass ein Konzept ein Versuch der Darstellung eines Leitbildes ist, an dem man sich orientieren will. Ein Konzept ist die Beschreibung des roten Fadens, an dem man sich entlanghangeln will. Es ist die Darstellung einer Sache, die es noch nicht gibt und die deshalb auch noch niemand kennt.

    Da im Ziel bereits festgelegt ist, was geliefert werden muss (in unserem Beispiel eine Maschine, die Schokokekse macht), kann es nicht sein, dass z.B. Vanillekekse anstelle der Schokokekse hergestellt werden. Dann wird die Maschine vom Kunden nämlich nicht abgenommen. Im Soll-Ist-Vergleich wird deshalb der ausgewählte Weg und die tatsächliche Umsetzung verglichen. Bei der Umsetzung des ersten Konzepts in unserem Beispiel könnte sich z.B. herausstellen, dass frittieret Kekse scheußlich schmecken. Dann baut man vielleicht doch lieber einen Backofen ein. Diese Änderung kostet Geld und deshalb muss ein Soll-Ist-Vergleich erstellt werden.
    Ein Muss-Kriterium darf im Soll-Ist-Vergleich NIEMALS aufgeführt sein.

    Antworten
    • Hallo,

      Vielen Dank für diesen wertvollen Hinweis, Sie haben natürlich vollkommen recht. Ich werde es dementsprechend korrigieren.

      Grüße
      Patrick

      Antworten

Schreibe einen Kommentar

Notify me of followup comments via e-mail. You can also subscribe without commenting.