Projektdokumentation von Markus Amshove (mit 100% bewertet)

Mein Auszubildender Markus Amshove hat in der Sommerprüfung 2015 vor der IHK Oldenburg mit der vollen Punktzahl von 100% in Teil A seine Prüfung zum Fachinformatiker Anwendungsentwicklung bestanden. Markus hat freundlicherweise seine gesamte Dokumentation, die übrigens – genau wie Gerdas Dokumentation – auf Basis meiner LaTeX-Vorlage für die Projektdokumentation erstellt wurde, für die Allgemeinheit zur Verfügung gestellt. Ihr könnt sie unten herunterladen.

Markus hat darüber hinaus seine gesamte Projektarbeit – Projektantrag, -dokumentation und -präsentation – in seinem Blog veröffentlicht: Meine praktische Abschlussprüfung. Über Feedback würde er sich freuen!

Die Dokumentation ist ein „sehr gutes“ Beispiel für eine Projektarbeit, die nicht dem „Standard-Projekt“ (Webanwendung mit Datenbank) entspricht:

  • Die Projektarbeit hat ein innovatives, modernes und anspruchsvolles Thema: die Erstellung einer eigenen Programmiersprache.
  • Das komplexe Thema ist nachvollziehbar erläutert und gut begründet.
  • Alle Arbeitsschritte werden durch geeignete Methoden unterstützt, die ein planvolles Vorgehen verdeutlichen. Die Methodik wird durch die passenden Artefakte (UML-Diagramme, Nutzwertanalyse, Pflichtenheft) verdeutlicht.
  • Die wirtschaftliche Betrachtung des Projekts ist umfangreich und gut nachvollziehbar.
  • Die gezeigten Quelltextausschnitte enthalten interessanten Code und nicht nur langweilige Trivialitäten.
  • Es sind so gut wie keine Rechtschreib-, Interpunktions- oder Grammatikfehler zu finden.
  • Die vorgegebene Seitenzahl (15 Seiten Dokumentation, 25 Seiten Anhang) wird exakt eingehalten.
  • Die erfolgreiche Qualitätssicherung auf Codeebene wird durch Code-Metriken überprüft und nachgewiesen.
  • Das Layout ist perfekt gesetzt und alle Querverweise sind korrekt (dank LaTeX).

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

Download

Vielen Dank an Markus Amshove und die ALTE OLDENBURGER Krankenversicherung AG 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

5 thoughts on “Projektdokumentation von Markus Amshove (mit 100% bewertet)

  1. Kleine OT-Frage:
    Wird bei euch im Unternehmen wirklich auf deutsch programmiert oder wurden die Codebeispiele entsprechend für die Dokumentation abgeändert?

  2. Wir programmieren auf Deutsch. Frameworks, die wir veröffentlichen, werden auf Englisch entwickelt. Und unser Kernsystem ist teilweise in Spanisch geschrieben 🙂

    Wir haben einfach festgelegt, dass für die Domäne der deutschen Krankenversicherung Englisch unsinnig ist. Die übersetzten Begriffe würde niemand verstehen.

  3. Herr Macke,

    erklären Sie mir doch bitte einmal, wie man eine Dokumentation mit 15+ sehr textlastigen Seiten und der hier gebotenen Qualität in nur 9 Stunden schreibt.

    Mir ist aufgefallen, dass auch bei der Doku von Frau Feldhaus, die Sie hier zur Verfügung stellen und welche hohe Maßstäbe setzt, die Zeit für ebenjene recht niedrig angesetzt war.

    Ich denke, hier sind ernsthafte Zweifel berechtigt, denn letztendlich ist für die Bewertung die Dokumentation ausschlaggebend und nicht das Projekt selbst. Es hat für mich diesbezüglich den Anschein, als sei die Doku hier und auch bei Frau Feldhaus lediglich ein Nebenschauplatz.

    Auch wenn LaTeX, richtig eingesetzt, die Arbeit erleichtert, so ist der Autor immer noch selbst für den Inhalt, die Formulierungen und die Qualitätssicherung verantwortlich. Ich möchte nicht ausschließen, dass es Menschen gibt, die die Menge des Stoffes in der angegebenen Zeit bewältigen können, vor dem Hintergrund, dass hier im Grunde noch Anfänger am Werk waren, fällt es mir aber schwer, daran zu glauben. Wie sehen Sie das, Herr Macke?

  4. Hallo Herr Kritiker,

    ich beginne mal mit Ihrem letzten Satz, in dem Sie selbst sagen, dass es Menschen gibt, die zu solch einer Leistung fähig wären. Denn beide Dokumentationen stammen von außergewöhnlich guten Auszubildenden, die sowohl ihre Ausbildung verkürzt haben, als auch in der Berufsschule und der IHK-Prüfung hervorragende Leistungen gebracht haben. Einen entsprechenden Beitrag finden Sie hier: Gerda Feldhaus von der IHK Oldenburg als Berufsbeste geehrt.

    Kommen wir aber nun zum eigentlichen Kritikpunkt. Sie haben völlig recht damit, dass die Dokumentation nicht den Anschein macht, dass man sie in 7 Stunden (denn in den genannten 9 Stunden sind auch noch 2 Stunden für die Kunden- und Entwicklerdokumentation enthalten) hätte schreiben können. Allerdings ist das durchaus möglich, wie Sie selbst schon schreiben, da das Ganze „Drumherum“ um den eigentlichen Inhalt in diesem Fall von LaTeX erledigt wird. Wenn man von Null anfängt und sich mit Word erstmal das Dokument zusammenbasteln muss, wird das natürlich deutlich länger dauern. Aber niemand schreibt den Prüflingen vor, welches Textverareitungsprogramm sie zu nutzen haben und dass keine Dokumentvorlagen erlaubt sind. Das wäre ja auch völlig lächerlich, da wir in der IT ja gerade darauf aus sind, nicht ständig das Rad neu zu erfinden und unsere Arbeit zu optimieren und zu automatisieren. Und mit meiner Vorlage für die Projektdokumentation muss von ein paar Feinjustierungen abgesehen nur noch der Inhalt gefüllt werden. Da meine Auszubildenden gleich in den ersten Wochen der Ausbildung eine LaTeX-Schulung bekommen, sind sie nach zwei bzw. zweieinhalb Jahren auch längst keine „Anfänger“ mehr beim Erstellen von Dokumenten. Das gleiche kann man natürlich mit einer entsprechenden Word-Vorlage und -Schulung auch erreichen.

    Was man übrigens nicht vergessen darf: Die gesamten Artefakte in der Dokumentation (z.B. UML-Diagramme, ERM usw.) sind schon in der normalen Projektlaufzeit erstellt und auch vorher entsprechend eingeplant worden. Sie müssen also „nur noch“ in die Dokumentation eingebunden werden.

    Die Anmerkung mit dem Nebenschauplatz verstehe ich nicht so ganz. Sie sagen ja schon, dass die Dokumentation das einzige ist, das die Prüfer bewerten. Daher werden die Prüflinge natürlich sehr viel Wert auf die Dokumentation legen und sie auch von Dritten korrekturlesen lassen usw. Alles andere wäre doch fahrlässig bei so einer wichtigen Arbeit. Die Dokumentation ist also alles andere als ein Nebenschauplatz. Und mit 10% der Projektzeit (7 von 70 Stunden) ist sie auch völlig ausreichend eingeplant.

    Zuletzt möchte ich noch hinzufügen, dass es manchmal noch nicht einmal nötig ist, die Projektdokumentation innerhalb der Projektzeit und dann auch noch in wenigen Stunden zu schreiben. Jede IHK hat hier nämlich ihre eigenen Regeln und es gibt IHKen, die explizit die Projektdokumentation (nicht die Kunden-/Entwicklerdokumentation) aus der Projektzeit ausschließen. In diesem Fall könnten sich die Prüflinge also so viel Zeit mit der Dokumentation lassen, wie sie wollen. Zu diesem Thema werde ich bei nächster Gelegenheit noch einen Blog-Artikel verfassen, da die Frage immer wieder aufkommt.

    Was sagen Sie denn nun zu meiner Antwort? Ich würde mich über Feedback freuen.

    Viele Grüße! Stefan Macke

  5. Hallo Herr Macke,

    ich bin nicht der Kritiker, hatte aber bis vor kurzem ähnliche Bedenken, da ich selbst gerade als Auszubildender FIAE mein Projekt absolviere und entsprechend dokumentiere. Ich habe aber schon seit der Zwischenprüfung eine Vorlage mit Tabellen und „Muster-Verweisen“ in Word (die übrigens an Ihre Vorlage angelehnt ist) und muss im Grunde nur noch schreiben und Quellen suchen. Da ich auch in der deutschen Sprache recht sicher bin und das nicht meine erste Projektdokumentation ist, muss ich in der Regel auch nicht lange überlegen, um üblichen Problemen (Zeitformen, „Ich-Formulierungen“ etc.) aus dem Weg zu gehen. Wenn man dann noch – darüber hatte ich bisher noch gar nicht nachgedacht – berücksichtigt, dass Grafiken und Pläne bereits in den anderen 63 Stunden erstellt werden, scheinen 7 Stunden schon fast viel, haha. Vielleicht wirkt die Dokumentation deshalb auch wie ein Nebenschauplatz: Für sie wird keine so große Mühe mehr aufgewandt, da vieles bereits getan wurde. Sorgfalt muss ja nicht zwingend mit Zeitaufwand verbunden sein. In diesem Sinne: Recht gebe ich Ihnen! Zeitprobleme haben diejenigen, deren Abschlussprojekt gleichzeitig auch das erste ist und die Quellenangabe bisher immer händisch gemacht haben und für die das Inhaltsverzeichnis die höchste Kunst der Verweise gewesen ist.
    Ich habe in meinem Projektantrag für die Projektdokumentation 9 Stunden angegeben (und zwischen Implementierung und Abnahme 3 weitere Stunden für Benutzer- und Entwicklerdokumentation) und wurde von der IHK darauf hingewiesen, die geplante Zeit für die Dokumentation sei recht wenig und ich solle unbedingt darauf achten, innerhalb der 70 Stunden zu bleiben. Die IHK geht also ebenfalls davon aus – wie die meisten Prüflinge – man bräuchte deutlich mehr Zeit als 9 Stunden. An diesem Punkt kommt dann die Kompetenz des Prüflings ins Spiel. Ich selbst werde eventuell wirklich doch eher 11 oder 12 Stunden brauchen, aber ich bin nun auch nicht jemand, der der Beste sein wird, wenngleich ich ebenfalls verkürze und sehr gute Leistungen in der Berufsschule erziele.

    Eine witzige Überlegung am Ende:
    Manche Menschen sehen eine große Leistung, die über ihr eigenes Können weit hinaus geht, und suchen einen Weg, die Leistung in ihr Können zu quetschen.
    Andere sehen diese Leistung und suchen einen Weg, ihr eigenes Können für diese Leistung zu erweitern.

    Mit freundlichen Grüßen

    Michael

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