Projektdokumentation Aufbau: von Einleitung bis Anhang
Vom Deckblatt bis zum Anhang: der rote Faden deiner IHK-Doku
Beim Aufbau deiner Projektdokumentation entscheidet sich, ob Prüferinnen und Prüfer deiner Arbeit gut folgen können. Ein klarer Aufbau führt von der Einleitung über Analyse, Entwurf und Umsetzung bis zum Fazit und Anhang. In diesem Ratgeber findest du ein Grundmuster, Hinweise zur Gewichtung der Kapitel sowie Tipps zum Ordnen von Verzeichnissen und zum Umgang mit Kundendaten.
Kostenlos herunterladen
IHK-Projektarbeit: Kapitelgerüst
Deckblatt mit Prüfungsnummer, Inhaltsverzeichnis und die sechs Kapitel in der erwarteten Reihenfolge, von der Ist-Analyse über die Nutzwertanalyse bis zur Wirtschaftlichkeit. Am Schluss Verzeichnisse und Erklärung. Das Merkblatt deiner Kammer geht vor, der Aufbau ist überall gleich.
Warum ein klarer Aufbau der Projektdokumentation wichtig ist
Prüferinnen und Prüfer müssen Ausgangslage, Lösungsweg und Ergebnis nachvollziehen können. Wenn der Aufbau der Projektdokumentation klar strukturiert ist, lassen sich diese Punkte leichter auffinden. Eine unklare Struktur kann das Verständnis der Arbeit erschweren.
Ein guter Aufbau erzählt eine Geschichte: Es gibt ein Problem, das du analysierst, für das du eine Lösung entwirfst, die du umsetzt und prüfst. Diese rote Linie zieht sich durch alle Kapitel. Da Erwartungen je nach Kammer und IHK leicht abweichen, lohnt sich ein Blick in die Vorgaben deiner IHK, bevor du die Kapitel festlegst. Wer den Aufbau vorab plant, spart sich später viel Umbau und schreibt entspannter.
Ein mögliches Grundmuster: Deckblatt, Verzeichnisse, Textteil
IHK-Vorgaben enthalten häufig vergleichbare Bestandteile. Welche davon verpflichtend sind und in welcher Reihenfolge sie erscheinen, richtet sich nach deiner IHK und Fachrichtung.
- Deckblatt mit den von deiner IHK verlangten Angaben
- Inhaltsverzeichnis mit Seitenzahlen
- Gegebenenfalls Abkürzungs-, Abbildungs- und Tabellenverzeichnis
- Textteil von der Einleitung bis zum Fazit
- Literatur- oder Quellenverzeichnis
- Anhang mit Belegen sowie gegebenenfalls Eigenständigkeitserklärung
Wie viele Verzeichnisse verlangt werden, ist je nach IHK unterschiedlich, deshalb prüfe die Vorgaben, bevor du Seiten einplanst. Achte auf eine saubere Word-Formatierung mit automatisch erzeugten Verzeichnissen, denn manuell getippte Seitenzahlen stimmen nach jeder Änderung nicht mehr. Ein einheitliches Layout wirkt professionell und erspart dir am Ende hektisches Nachbessern kurz vor der Abgabe beim Prüfungsausschuss.
Sauber trennen: Einleitung, Analyse, Konzeption
Mit der Einleitung beginnt der Hauptabschnitt. Skizziere prägnant Organisation, Umfeld und die zu lösende Herausforderung. Definiere das Gesamtziel sowie die Rahmenbedingungen hinsichtlich Dauer und Technologie. Bleibt dieser Abschnitt kompakt, tritt deine eigentliche Leistung stärker hervor.
Danach folgt die Analysephase: Ist-Zustand, Anforderungen und, falls sinnvoll, eine kleine Wirtschaftlichkeitsbetrachtung. In der Konzeption entwickelst du daraus einen Lösungsentwurf, etwa ein Datenmodell, eine Architektur oder ein Mockup. Wichtig ist, dass Analyse und Entwurf getrennt bleiben und nicht mit der Umsetzung verschwimmen. Wie ausführlich diese Phasen ausfallen, hängt vom Beruf ab: In der Anwendungsentwicklung steht oft der Entwurf im Vordergrund. Beschreibe deine Entscheidungen nachvollziehbar, damit die Prüfer verstehen, warum du dich für einen Weg entschieden hast und Alternativen verworfen wurden.
Realisierung und Testphase: der Kern deiner Doku
Diese Phase bildet das Zentrum deiner Leistung und darf großzügig bemessen sein. Schildere den Weg vom Entwurf zur fertigen Software: relevante Codeausschnitte, Konfigurationen, Datenbankstrukturen oder Netzwerkeinstellungen. Stell nicht alles im Detail dar, sondern fokussiere dich auf Schlüsselpunkte und begründe deine technischen Entscheidungen.
Danach folgt die Testphase. Dokumentiere, wie du geprüft hast, ob deine Lösung funktioniert: Testfälle, erwartetes und tatsächliches Ergebnis, gefundene Fehler und deren Behebung. In der Systemintegration gehören auch Abnahme und Übergabe an den Kunden dazu. Schließe den Textteil mit einem Fazit, das Soll und Ist vergleicht und einen ehrlichen Ausblick gibt. Vermeide es, hier neue Themen aufzumachen. Ein häufiger Fehler ist, die Umsetzung zu knapp und die Einleitung zu breit zu halten, achte deshalb bewusst auf die richtige Verteilung.
Richtige Gewichtung und Umfang der Kapitel
Eine gute Gewichtung zeigt, dass du Wesentliches von Nebensächlichem trennst. Als grobe Orientierung, die je nach IHK abweicht, entfallen häufig rund zehn Prozent auf die Einleitung, etwa ein Viertel auf Analyse und Konzeption, gut die Hälfte auf Realisierung und Test sowie der Rest auf Fazit und Verzeichnisse. Sieh das als Faustregel, nicht als starre Regel.
Beim Umfang nennen viele Kammern eine übliche Spanne, oft im Bereich von etwa zehn bis fünfzehn Seiten reiner Text ohne Anhang. Verbindlich sind aber immer die Vorgaben deiner IHK, prüfe sie also genau. Wichtiger als die exakte Seitenzahl ist, dass jedes Kapitel seinen Zweck erfüllt. Wie die Bewertung durch die IHK im Detail aussieht, hilft dir, Schwerpunkte richtig zu setzen. Streiche alles, was nicht direkt zum Projekt beiträgt, denn Füllmaterial fällt erfahrenen Prüfern sofort auf.
Anhang, Verzeichnisse und Kundendaten anonymisieren
In den Anhang gehört alles, was den Textteil belegt, aber den Lesefluss stören würde: umfangreicher Code, vollständige Diagramme, Screenshots, Lasten- und Pflichtenheft oder das Datenbankschema. Verweise im Text gezielt auf die passenden Anhänge, damit die Prüfer den Zusammenhang sehen. Jeder Anhang sollte nummeriert und im Verzeichnis auffindbar sein.
Ein wichtiges Thema ist der Datenschutz. Veröffentliche keine personenbezogenen oder vertraulichen Kundendaten, etwa Namen, Adressen, Zugangsdaten oder interne IP-Bereiche, sofern sie Rückschlüsse auf Personen oder Systeme zulassen. Ersetze sie durch neutrale Platzhalter wie Musterfirma GmbH oder anonymisierte Beispieldaten. Kläre mit deinem Betrieb, welche Informationen veröffentlicht werden dürfen. Vor der Abgabe kann ein Blick von außen helfen: Ein professionelles Korrektorat prüft Rechtschreibung, Grammatik und Ausdruck, ohne den fachlichen Inhalt zu ersetzen.
Fazit: Mit klarer Struktur zur überzeugenden Doku
Wenn du dir vorab ein klares Muster überlegst, fällt das Schreiben der Doku leichter. Du weißt, welches Kapitel wohin gehört, wie viel Platz es bekommt und welche Belege in den Anhang wandern. Diese Planung hilft dir, die Arbeit nachvollziehbar zu strukturieren.
Merke dir die drei Hebel: eine logische Reihenfolge, eine angemessene Gewichtung von Realisierung und Test sowie ein sorgfältiger Umgang mit Kundendaten und Verzeichnissen. Prüfe zusätzlich die Vorgaben deiner IHK, denn Details unterscheiden sich. Nutze die Zeit vor der Abgabe für einen ruhigen letzten Durchgang. Ein klar strukturierter Aufbau der Projektdokumentation erklärt deine Gliederung von der Einleitung bis zum Anhang nachvollziehbar.
Mehr zur IT-Projektdokumentation findest du in den Beiträgen häufige Fehler in der Projektdokumentation, zur Bewertung der Projektdokumentation und zur Projektdokumentation für Fachinformatiker.