Projektdokumentation
Kriterien für die Bewertung der Projektdokumentation ✔️
Die Kriterien für Projektdokumentation sind in ihrer unterschiedlichen Kategorien hier als Checkliste aufgelistet.
Ein wichtiger Punkt für alle diese Kategorien ist: Entscheidungen müssen sinnvoll begründet werden.
Formale und angemessen sprachliche Gestaltung
Die formale und sprachliche Gestaltung der Projektdokumentation machen 15% der Note aus.
- Umfang eingehalten (15 Seiten reiner Text ohne Grafiken und Diagramme)
- Sinnvoller verständlicher Titel
- Kopf und Fußzeile sinnvoll formatiert
- Korrekte Daten
- Verweise auf alle Artefakte im Text
- Tiefste Gliederungsebene nicht tiefer als 3 (Beispiel: 5.4.5)
- Immer mehrere Gliederungspunkte vorhanden
- IHK-Deckblatt (falls verfügbar)
- Korrekte Erläuterung von Fachbegriffen
- Einheitliche Schreibweise (Am besten passiv)
- Werden eventuelle Vorgaben der IHK eingehalten
- Anhänge / Artefakte sinnvoll beschrieben
- Rechtschreibung, Grammatik sowie auch Zeichensetzung
- Richtige Zitate
- Eidesstattliche Erklärung muss vorhanden sein
- Keine großen leeren Räume im Text (Blocksatz verwenden sowie auf leeren Abstand zum Ende der Seite achten)
- Korrekte Seitenzahlen
- Artefaktbeschriftungen
- Einheitliche Schriftart
- Formelle Sprache
- Abkürzungen bei erster Verwendung ausgeschrieben
- Fazit
- Sinnvolle Struktur
- Inhaltsverzeichnis, Abbildungsverzeichnis, Literaturverzeichnis, Codeverzeichnis, Tabellenverzeichnis, Abkürzungsverzeichnis
- Große Artefakte im Anhang
Beschreibung des Auftrags
Die Beschreibung des Auftrages macht insgesamt 20% der Note der Projektdokumentation aus.
- Wirtschaftlichkeitsanalyse mit Amortisationsrechnung
- Make or Buy Analyse
- Auftraggeber / Kunde muss erkennbar sein
- Wenn der Nutzen nicht direkt erkennbar ist (nicht monitär) => Ist dieser Nutzen klar erkennbar?
- Deutliches Projektziel
- Betriebsinterne Begriffe erklären
- Detaillierte Teilplanung maximal 8h pro Aufgabeneinheit
- Kurze Vorstellung des Ausbildungsbetriebes / Projektumfeld
- Detaillierte Projektplanung (80h)
- Verwendete Ressourcen
- Anforderungen an das Projekt mit klarer Methodik aufgenommen (Lastenheft, Use-Cases)
- Durchführungszeitraum
- Tägliche Arbeitszeit am Projekt
Konkretisierung des Auftrags
Die Konkretisierung macht insgesamt 50% der Projektdokumentationsnote aus und ist somit der mit am Abstand bedeutendste Teil. (Er ist ja auch der eigentlich Teil des Projektes😉)
- Projekt muss eine angemessene fachliche Tiefe aufweisen
- Anforderungen müssen detaillierter und genauer verfasst werden (Aktivitätsdiagramm)
- Anforderungsanalyse
- Einheitlich Formulierung von Anforderungen
- Lastenheft und Pflichtenheft (In Auszügen ist ausreichend)
- Methodisches Vorgehen nach Projektmanagementmodell (Wasserfall, Scrum oder weitere)
- Alle Prozessschritte auflisten
- Sinnvolles Benutzen von Diagrammen (Verschiedenste UML Diagramme)
- Auswahl der benutzten Tools, Ressourcen und Programmiersprachen klar erkennbar
- Entscheidungen hinreichen begründet und nachvollziehbar
- Retroperspektive
- GUI Mockups (falls vorhanden)
- Beispiele aus dem Projekt (Datenbankmodell, Coole Funktionen und Klassen)
- Quelltextbeispiele
- Dokumentation der Programmlogik (Verschiedenste UML Diagramme)
- Welche Tests wurden benutzt und wie und wann wurden diese durchgeführt?
- Abnahme des Projektes mit Angabe vom Abnehmer
- Architekturdokumentation
- War das Projekt erfolgreich?
- Ausblick in die Zukunft des Projektes
Dokumentationen (Kunden-, Betriebs-, Entwickler-dokumentation)
Die Dokumentationen machen die restlichen 15% der Dokumentationsnote aus.
- Welche Dokumentation wurde erstellt? (Begründung nicht vergessen)
- Wurden Artefakte für diese Dokumentationen verwendet und sind sie ordentlich beschrieben?
Aufbau 🔧
Der Aufbau der Projektdokumentation sollte sich an dem der Vorlagen orientieren.
Eine Projektdokumentation sollte immer mit einer schönen Einleitung anfangen und mit einem Fazit oder Zukunftsausblicken enden. Zwischen diesen Elementen können dann die Projektphasen genauer beschrieben werden.
Vorlagen
Es gibt bereits mehrere Vorlagen. Ich nenne hier beispielhaft die Word und LaTex Vorlage von Stefan Macke. Mit diesen Vorlagen kann man seine Dokumentation erstellen ohne sich in den Kleinigkeiten des Layouts zu verdenken. Eine ausfürlich Beschreibung gibt der Autor hier.
Beispielprojekte
Beispiele für Projekte findet ihr hier oder auf dieser Seite. Diese können zur Orientierung und Inspiration sehr nützlich sein. Es schadet nicht wenn man sich die ein oder andere durchliest.
FAQ 💬
Muss das Projekt erfolgreich sein?
- Nein nicht jedes Projekt ist erfolgreich. Aber es muss gut begründet sein und auch gut verständlich wieso ein Projekt nicht erfolgreich war.
Wie viele Seiten soll eine Projektdokumentation haben?
- Die Antwort kommt auf die IHK an. Je nachdem bei welcher IHK gibt es andere Vorgaben. Als einen Richtwert kann man aber sagen: Ungefähr 15 Seiten reiner Fließtext plus alle Anhänge, Diagramme, Code Beispiele, …
Beispiele
Links 🔗
Kriterien für die Bewertung der Projektdokumentation
Vorbereitung und Durchführung des Abschlussprojektes