Praxisprojekte richtig dokumentieren: Aufbau und Regeln

Praxisprojekte dokumentierst du am besten parallel zur Umsetzung, nicht danach. Eine saubere Dokumentation besteht aus vier Teilen: Ausgangslage, Vorgehen, Ergebnis und Reflexion. Wer diese vier Teile systematisch erfasst, hat am Ende nicht nur ein Portfolio-Stück, sondern auch eine Arbeitsgrundlage, um das Projekt später zu erklären oder zu verbessern. Dieser Ratgeber zeigt, wie du das konkret machst.

Aus der Beratungspraxis weiß ich: Teilnehmer, die sich erst am Ende der Weiterbildung an die Dokumentation setzen, verlieren die Hälfte der Details. Die entscheidenden Entscheidungen, warum sie ein Werkzeug statt eines anderen gewählt haben, sind vier Wochen später nicht mehr präsent. Dokumentation während des Projekts ist kein Extra-Aufwand, sondern Arbeitserleichterung.

Dokumentation ist so wichtig wie das Projekt selbst

Ein nicht dokumentiertes Projekt ist für Bewerbungen fast wertlos. Personaler können nur bewerten, was sie sehen. Und sie sehen nur, was du dokumentierst. Das ist keine Bürokratie, sondern die Realität eines schnellen Bewerbungsprozesses, in dem oft nur wenige Minuten pro Kandidat bleiben.

Gute Dokumentation zwingt dich zunächst, Entscheidungen zu begründen. Wer schreiben muss, warum er ein Werkzeug gewählt hat, merkt schneller, wenn die Begründung nicht trägt. Sie macht Projekte außerdem wiederverwendbar: Drei Monate später willst du vielleicht dieselbe Automatisierung für einen anderen Kontext bauen. Und nicht zuletzt ist sie das Eintrittsticket in Bewerbungsgespräche für digitale Rollen.

Die vier Teile jeder Dokumentation

Jedes Praxisprojekt folgt demselben Grundgerüst. Das ist keine Formvorschrift, sondern ein Arbeitsrahmen, der dir Zeit spart.

Teil	Frage	Umfang
Ausgangslage	Was war das Problem?	100 bis 200 Wörter
Vorgehen	Wie bist du vorgegangen?	300 bis 500 Wörter
Ergebnis	Was ist dabei herausgekommen?	100 bis 200 Wörter
Reflexion	Was hast du gelernt?	100 bis 200 Wörter

Die Ausgangslage beschreibt das Problem, nicht die Lösung. Wer schon hier von Werkzeugen und Technologien schreibt, hat den falschen Einstieg gewählt. Der Leser muss verstehen, wofür die Lösung gebraucht wird, bevor er die Lösung versteht.

Das Vorgehen ist der längste Teil. Hier erklärst du die Schritte, die gewählten Werkzeuge und die Entscheidungen. Jede Wahl braucht eine kurze Begründung, warum dieses Werkzeug und nicht ein anderes.

Das Ergebnis ist der härteste Teil, weil er messbar sein soll. Wenn du keine exakten Zahlen hast, schätzt du offen. “Rund fünf Stunden pro Woche gespart, geschätzt auf Basis der bisherigen Bearbeitungszeit” ist besser als “Viel Zeit gespart”.

Die Reflexion ist der unterschätzte Teil. Hier schreibst du auf, was beim ersten Versuch nicht funktioniert hat, welche Annahmen sich als falsch erwiesen und was du beim nächsten Mal anders machen würdest. Dieser Teil macht den Unterschied zwischen einem Schul-Projekt und einem echten Praxis-Case.

Zeitpunkt und Häufigkeit

Dokumentation ist kein einzelner Schritt am Ende, sondern ein Prozess, der das Projekt begleitet. Bewährt haben sich feste Zeitpunkte entlang der Laufzeit.

Am Anfang des Projekts schreibst du die Ausgangslage und die Zielsetzung auf. Zwei Absätze, bevor du das erste Werkzeug öffnest. Das zwingt dich, das Problem klar zu fassen. Während der Umsetzung führst du kurze Arbeits-Notizen: welche Schritte, welche Entscheidungen, welche Fehler. Diese Notizen sind oft handschriftlich oder in einem einfachen Text-Dokument, nicht schon in der endgültigen Form. Am Ende des Projekts sichtest du die Notizen und baust daraus die finale Dokumentation.

Dieser Dreischritt verhindert das häufigste Problem: Wer erst am Ende anfängt zu dokumentieren, erinnert sich nicht mehr an die Fehlversuche. Und genau diese Fehlversuche sind das Wertvollste am Portfolio.

Der Vorgehens-Teil im Detail

Der Vorgehens-Teil ist der inhaltliche Kern. Hier entscheidet sich, ob die Dokumentation trägt oder mit Trivialitäten gefüllt ist.

Beschreibe Entscheidungen, nicht Klick-Pfade. Niemand will lesen, dass du “auf Datei, dann auf Speichern” geklickt hast. Interessant ist, warum du dich für ein Werkzeug entschieden hast. Nenne außerdem Versionsnummern und Zeitpunkt. “n8n Version 1.42, Stand März 2026” gibt dem Leser Orientierung, ob die Lösung heute noch funktioniert. Und verweise auf Quellen, wenn du dich auf Dokumentation, Tutorials oder Fachartikel gestützt hast.

Der Vorgehens-Teil ist auch der Ort, an dem technische Begriffe zum ersten Mal auftauchen. Hier darfst und sollst du präzise sein. Begriffe, die der Leser vielleicht nicht kennt, erklärst du in einem Nebensatz, aber ohne den Lesefluss zu stoppen.

Details zu Bildern und Screenshots findest du im Ratgeber Bilder, Screenshots, Videos als Dokumentation. Zur Datenschutz-Frage hilft der Artikel Code teilen oder nicht.

Gute und schlechte Dokumentation im Vergleich

Einige Kriterien trennen ein solides Portfolio-Stück von einem unsauberen. Wer die folgenden Punkte als Check-Liste nutzt, vermeidet die typischen Fehler.

• Ein außenstehender Leser versteht das Projekt ohne Rückfrage
• Fehlversuche werden erwähnt, nicht versteckt
• Ergebnisse haben Zahlen, keine Werturteile
• Zeitpunkt und Werkzeug-Versionen sind angegeben
• Ein anderer Mensch könnte die Lösung nachbauen

Diese fünf Punkte decken 90 Prozent der Qualität ab. Wer sie einhält, hat ein solides Portfolio-Stück, auch ohne ausgefeiltes Design.

Dokumentation für das Portfolio aufbereiten

Zwischen Arbeits-Dokumentation und Portfolio-Version liegt ein Schritt: das Kürzen. Die Arbeits-Version enthält alle Details, die du während der Umsetzung gebraucht hast. Die Portfolio-Version zeigt davon nur die wichtigsten 30 Prozent.

Was fällt weg: kleinteilige Abläufe, die für den Leser keinen Mehrwert bringen. Was bleibt: die Entscheidungen, die Ergebnisse und die Reflexion. Eine gute Portfolio-Version eines Projekts hat 500 bis 800 Wörter plus zwei bis drei Screenshots. Details zur Aufbau-Logik findest du in unserem Ratgeber Was in ein gutes Portfolio gehört.

Für den gesamten Rahmen der Weiterbildung lies unsere Ratgeber-Pillar zum Berufsbild. Wer wissen will, welche Use-Cases sich am besten dokumentieren lassen, findet im Artikel Welche Use-Cases sich besonders eignen konkrete Vorschläge.

Der offizielle Text der KI-Verordnung steht auf EUR-Lex. Einen praktischen Leitfaden zur DSGVO-konformen Dokumentation gibt der BfDI auf seiner Übersichtsseite.

FAQ zur Projekt-Dokumentation

Wie lang sollte eine einzelne Projektdokumentation sein?

In der Arbeits-Version so viel wie nötig, meist zwei bis vier Seiten. In der Portfolio-Version 500 bis 800 Wörter plus Screenshots. Wer mehr braucht, hat zu viele Details.

Brauche ich ein bestimmtes Werkzeug zur Dokumentation?

Nein. Ein Text-Editor reicht. Markdown ist praktisch, weil es sich in verschiedene Formate exportieren lässt. Wer es einfacher mag, nutzt ein Textverarbeitungsprogramm.

Muss ich Quellcode im Portfolio zeigen?

Nur wenn er sauber und datenschutzkonform ist. Ein Ausschnitt mit drei bis fünf Zeilen reicht oft. Langer Code ohne Kontext wirkt wie Füllmaterial.

Wie gehe ich mit Projekten um, die vertraulich sind?

Du beschreibst sie abstrakt, ohne Firmen- oder Personennamen. “Ein mittelständisches Unternehmen aus der Logistik” statt echter Name. Der Inhalt bleibt nachvollziehbar, die Vertraulichkeit gewahrt.

Sollte ich meine Dokumentation von jemandem gegenlesen lassen?

Ja, unbedingt. Ein zweiter Leser findet Stellen, die unklar sind, und Stellen, die überflüssig sind. Ideal ist ein Teilnehmer aus dem Kurs oder eine Person aus der Zielbranche.

Über den Autor

Dr. Jens Aichinger ist Gründer von SkillSprinters, einem DEKRA-zertifizierten Bildungsträger nach AZAV. Er ist promovierter Naturwissenschaftler und arbeitet seit über zehn Jahren an der Schnittstelle von Bildung und Digitalisierung. Mehr zum Autor auf der Autoren-Seite.

Zuletzt geprüft am 14. April 2026 von Dr. Jens Aichinger. Kontakt und Terminbuchung über skill-sprinters.de/termin.

Dokumentation üben im Schnupperkurs

Im kostenlosen Schnupperkurs baust du ein kleines Projekt und dokumentierst es gleich mit. Nach zwei Stunden hast du ein erstes eigenes Mini-Portfolio-Stück in der Hand. So siehst du, ob die Arbeitsweise zu dir passt, bevor du dich für die vollständige Weiterbildung entscheidest.

Kostenlos reinschnuppern oder 27 Fragen als PDF herunterladen