Projektdokumentation von Michael Kleimann (mit 92% bewertet) inkl. Projektantrag

Michael Kleimann hat in der Winterprüfung 2015/2016 von der IHK Trier 92% für die Dokumentation seiner betriebliche Projektarbeit bekommen. Herzlichen Glückwunsch zu dieser tollen Leistung!

Michael war so nett, seine Arbeit der Allgemeinheit zur Verfügung zu stellen. Du kannst die Projektdokumentation und den zugehörigen Projektantrag unten herunterladen.

Meine Bewertung

Die Dokumentation ist ein sehr gutes Beispiel für eine Projektarbeit. Insbesondere folgende Punkte fallen mir positiv auf:

  • Die Projektarbeit hat ein modernes und anspruchsvolles Thema: die Implementierung einer REST-Schnittstelle.
  • Das Thema ist nachvollziehbar erläutert und gut begründet.
  • Die Projektphasen sind gut aufgeteilt und haben einen passenden Umfang.
  • Die verwendeten Technologien (insb. JAX-RS und Maven) werden gut verständlich erläutert.
  • Es werden professionelle Werkzeuge zur statischen Codeanalyse (FindBugs) eingesetzt, die den Code objektiv bewerten.
  • Die Funktionsfähigkeit des Projekts wird durch automatische (Integrations-)Tests abgesichert.
  • Zu jeder Projektphase wird das passende Artefakt (Use-Cases, Lastenheft usw.) erwähnt und (in Ausschnitten) gezeigt.
  • Es werden viele passende Methodiken (Klassendiagramm, ERM usw.) angewendet und die Software wird professionell entwickelt.
  • Es wird auch Unit-Test-Code gezeigt.
  • Alle erwarteten Dokumentationen (Benutzer und Entwickler) sind vorhanden.

Optimierungspotential

Ich weiß nicht, was Michaels Prüfer bei der Bewertung der Projektdokumentation zum Abzug gebracht haben, aber mir fallen folgende Punkte auf, die man ggfs. verbessern könnte:

  • Die Kostenrechnung hätte umfangreicher ausfallen können und insb. die Amortisationsrechnung fehlt mir.
  • Die umfangreiche Beschreibung der Technologien frisst viel Platz, der für die Darstellung der eigenen Leistung genutzt werden könnte.
  • Der angefügte Quelltext enthält viel (uninteressanten) Boilerplate-Code und Kommentare.
  • Die angefügten JSON-Daten füllen zur viele Seiten. Hier hätte ein Auszug genügt.

Metadaten

  • Titel der Projektarbeit: RESTful Management Konsole – API zum Steuern und Verwalten von Instanzen
  • Ausbildungsberuf: Fachinformatiker Anwendungsentwicklung
  • Prüfung: Winter 2015/2016
  • Bewertung: 92%
  • IHK: Trier
  • Vorgaben der IHK: Max. 12 Seiten (Soll: 10 Seiten, DIN A4, Schriftart Arial/11) ohne Deckblatt und Inhaltsverzeichnis + Anhang (bei Programmen auch Diskette oder CD-ROM im Anhang beifügen)
  • Name des Prüflings: Michael Kleimann

Wenn du deine Projektarbeit auch auf dieser Seite veröffentlichen möchtest, dann sprich mich gerne an. Ich suche (sehr gute) Beispiele aus allen IT-Berufen.

Download

Vielen Dank an Michael Kleimann für das Bereitstellen der Projektdokumentation. Alle internen Angaben oder personenbezogenen Daten wurden entweder unkenntlich gemacht oder durch fiktive Werte ersetzt.

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.

Checkliste für die Projektdokumentation

Jetzt anmelden!

Wichtiger Hinweis

Diese Projektdokumentation ist ein Beispiel für eine gut bewertete Prüfungsleistung. Sie soll dir als Inspiration und vor allem als Hilfe beim Erstellen deiner eigenen Projektdokumentation dienen.

Das heißt aber nicht, dass du sie 1-zu-1 als Vorlage für deine Arbeit nutzen kannst. Wenn du fremde Inhalte als deine eigenen ausgibst, begehst du ein Plagiat. Das muss dazu führen, dass du durch die Prüfung fällst.

Denke daran: Auch die Prüfer sind ITler und kennen vielleicht diese Seite.

Also: Lass dich gerne durch diese Projektarbeit inspirieren, aber kopiere keine fremden Inhalte in deine Ausarbeitung.

Portrait von Stefan Macke
Polyglot Clean Code Developer
Über den Autor
Ausbildungsleiter für Fachinformatiker Anwendungsentwicklung und Systemintegration, IHK-Prüfer und Hochschuldozent für Programmierung und Software-Engineering.

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert.

To create code blocks or other preformatted text, indent by four spaces:

    This will be displayed in a monospaced font. The first four 
    spaces will be stripped off, but all other whitespace
    will be preserved.
    
    Markdown is turned off in code blocks:
     [This is not a link](http://example.com)

To create not a block, but an inline code span, use backticks:

Here is some inline `code`.

For more help see http://daringfireball.net/projects/markdown/syntax