Um das Einsparen von wertvoller Zeit beim Erstellen der
IHK-Projektdokumentation geht es in der siebzehnten Episode der
Shorts des IT-Berufe-Podcasts.
Ich zeige dir, wie du bei der IHK-Projektdokumentation trotz
knapper Zeit realistischer arbeiten kannst: Nicht alles entsteht
erst am Ende, denn viele Artefakte wie Diagramme, Modelle oder
Anforderungsdokumente gehören sowieso zur Projektdurchführung und
können direkt wiederverwendet werden. Zeit sparst du vor allem,
wenn du dein Textsatzsystem vorher beherrschst, mit Vorlage und
Versionierung arbeitest, Texte parallel zum Projekt sammelst und
bei Bedarf Sprache-zu-Text mit KI nutzt.
Inhalt Grundidee
Ich setze den Fokus darauf, wie du bei der Projektdokumentation
Zeit sparen kannst, obwohl die vorgegebenen 40 oder 80
Projektstunden und insbesondere die oft nur 8 bis 12 Stunden für
die Doku sehr knapp sind. Der zentrale Gedanke ist: Du musst
nicht die komplette Dokumentation erst am Ende von null auf
erstellen.
Viele Inhalte deiner Projektdokumentation entstehen bereits
während der normalen Projektarbeit und sind damit bereits in der
Projektzeit enthalten.
Artefakte entstehen schon im Projekt
Bei einem professionell durchgeführten IT-Projekt erstellst du
ohnehin Unterlagen und Ergebnisse, die später in die
Projektdokumentation übernommen werden können, zum Beispiel:
ER-Modelle
Netzwerkpläne
Gannt-Diagramm oder Netzplan
Prozessabläufe
Klassendiagramme
Mockups
Tabellenmodelle
Anforderungen
Testüberlegungen
Planungsunterlagen
Dokumentationen für Kund:innen, Admins oder Entwickler:innen
Diese Artefakte gehören zur normalen Projektarbeit und müssen
nicht noch einmal extra nur für die Doku erzeugt werden. Die
eigentliche zusätzliche Arbeit in der Dokumentationszeit betrifft
daher vor allem den Fließtext.
Professionelle Projektarbeit statt "einfach machen"
Ein wichtiges Missverständnis ist, dass manche Prüflinge glauben,
die gesamte Doku müsse erst in der dafür eingeplanten Zeit
entstehen. Tatsächlich zeigt die Dokumentation vor allem, dass du
professionell arbeitest:
du planst vor der Umsetzung
du erhebst Anforderungen
du entwirfst Lösungen
du überlegst dir Testverfahren
du dokumentierst nachvollziehbar
Gerade das soll in der Abschlussprüfung sichtbar werden. Es geht
nicht darum, einfach nur etwas umzusetzen, sondern
nachvollziehbar und strukturiert zu arbeiten.
Textsatzsystem vorher beherrschen
Ein großer Hebel zum Zeitsparen ist ein geeignetes
Textsatzsystem. Das kann zum Beispiel sein:
LaTeX
Microsoft Word
LibreOffice
Markdown
AsciiDoc
Die konkrete Technologie ist weniger wichtig als der
professionelle Umgang damit. Entscheidend ist, dass du
semantisch arbeitest statt manuell zu
formatieren.
Wichtig dabei
Überschriften sollten als echte Überschriften ausgezeichnet
werden
Inhaltsverzeichnisse sollten automatisch generiert werden
Verweise, Nummerierungen und Formatierungen sollten vom
System übernommen werden
du solltest nicht während des Schreibens ständig manuell
fett, kursiv oder Größen anpassen
Wenn du mehr Zeit mit Formatierung als mit Inhalten verbringst,
beherrschst du dein Werkzeug noch nicht gut genug. Deshalb
solltest du dich lange vor der Projektdurchführung mit deinem
Textsatzsystem beschäftigen und nicht erst kurz vor der Prüfung.
Vorbereitung vor der eigentlichen Projektzeit
Niemand erwartet, dass du erst innerhalb der 40 oder 80 Stunden
lernst, wie du mit Word, LaTeX oder einem anderen System
professionell arbeitest. Diese Vorbereitung sollte vorher
passieren.
Gerade weil die Projektdokumentation für viele IT-Azubis das
erste große Dokument dieser Art ist, solltest du dir früh genug
Zeit nehmen, den Umgang mit dem Werkzeug zu lernen.
Inkrementell arbeiten und versionieren
Die Dokumentation sollte nicht erst am Ende geschrieben werden,
sondern parallel zum Projekt wachsen. Dafür empfiehlt sich eine
Versionierung, zum Beispiel mit Git.
Vorteile davon:
du kannst Zwischenstände sichern
du kannst Änderungen nachvollziehen
du kannst ältere Versionen wiederherstellen
du hast dein Dokument jederzeit griffbereit
Sinnvoll ist es, die Dokumentation schon vor Projektbeginn
technisch aufzusetzen und dann während jeder Projektphase
fortlaufend zu ergänzen.
Beispiel:
Du erstellst ein ER-Modell.
Direkt danach notierst du Stichpunkte oder formulierst schon
erste Sätze für das passende Kapitel in der Doku.
So dokumentierst du Inhalte dann, wenn sie noch frisch im Kopf
sind, statt Wochen oder Monate später rekonstruieren zu müssen.
Vorlagen nutzen
Ein weiterer klarer Zeitsparer ist die Nutzung einer Vorlage,
etwa für:
Deckblatt
Inhaltsverzeichnis
Kopf- und Fußzeilen
Seitenzahlen
Nummerierung von Überschriften
grundlegende Formatierung
Diese technische Vorarbeit hat nichts mit deiner eigentlichen
Prüfungsleistung zu tun. Du bekommst keine bessere Note dafür,
dass du Formatvorlagen oder Layouts selbst baust. Deshalb ist es
sinnvoll, eine fertige Vorlage zu verwenden und deine Zeit lieber
in Inhalt und Struktur zu investieren.
Artefakte so erstellen, dass du sie wiederverwenden kannst
Wenn du Diagramme und andere Inhalte später in Doku und
Präsentation verwenden willst, solltest du sie von Anfang an so
anlegen, dass sie dafür geeignet sind.
Ein Problem dabei ist das unterschiedliche Format:
Projektdokumentation: meist DIN A4 Hochformat
Präsentation: meist 16:9 Querformat
Daher kann es sinnvoll sein:
entweder direkt zwei Varianten eines Diagramms zu erstellen
oder zumindest schon bei der Erstellung auf gute
Verwendbarkeit im Hochformat zu achten
Wenn du nur eine Version priorisieren kannst, sollte sie für die
Dokumentation optimiert sein, weil ein PDF im Hochformat weniger
flexibel ist als eine Präsentation, in der du mit Zooms oder
Animationen arbeiten kannst.
Inhalte aus dem Projektantrag wiederverwenden
Auch der Projektantrag enthält oft schon Texte, die du in die
Projektdokumentation übernehmen kannst, zum Beispiel:
Projektbegründung
Zielbeschreibung
Anforderungen
Testideen oder Abnahmekriterien
kurze Unternehmensvorstellung
Beschreibung von Stakeholdern
Wenn du diese Texte selbst geschrieben hast, ist ihre
Wiederverwendung kein Plagiat. Du kannst sie übernehmen,
anpassen, kürzen oder erweitern, statt dieselben Inhalte noch
einmal neu zu formulieren.
Sprache-zu-Text mit KI nutzen
Ein zusätzlicher Tipp zum Zeitsparen ist, Fließtexte nicht nur zu
tippen, sondern einzusprechen und per KI transkribieren zu
lassen.
Der Vorteil:
Sprechen ist meist schneller als Tippen
Gedanken lassen sich oft direkter festhalten
moderne Transkriptions-KI kann Satzzeichen, Formatierung und
kleine Versprecher teilweise schon gut verarbeiten
Dabei gilt aber:
achte auf Datenschutz
achte auf Security
gib keine ungeeigneten sensiblen Daten leichtfertig an
externe Systeme
Beispiele für wiederverwendbare Artefakte aus Projektphasen
Je nach Projektphase können verschiedene Unterlagen direkt für
die Doku vorbereitet werden.
Analysephase
Use-Case-Diagramme
Lastenheft
Pflichtenheft
andere Formen der Anforderungsermittlung, z.B. User Storys
Entwurfsphase
Architekturdiagramme
UML-Diagramme
Mockups
Datenmodelle
Schnittstellen- oder API-Beschreibungen
Dokumentationsphase
Benutzerdokumentation
Kundendokumentation
Anwendungsdokumentation
Entwicklungsdokumentation
Administrationsdokumentation
Diese Unterlagen entstehen oft ohnehin im Projekt und können ganz
oder in Auszügen in die Projektdokumentation übernommen werden.
Fazit
Die wichtigste Idee ist, deine Projektdokumentation als
wachsendes Dokument zu sehen und nicht als etwas, das du erst am
Ende in einem Stück schreibst.
Zeit sparst du vor allem dann, wenn du:
dein Textsatzsystem vorher sicher beherrschst
mit semantischer Textverarbeitung arbeitest
eine Vorlage nutzt
deine Dokumentation früh aufsetzt und versionierst
Texte parallel zum Projekt sammelst oder einsprichst
Artefakte aus der Projektdurchführung direkt wiederverwendest
Inhalte aus dem Projektantrag übernimmst
So kannst du dich in der knappen Dokumentationszeit stärker auf
den eigentlichen Inhalt konzentrieren statt auf Technik,
Formatierung und nachträgliches Rekonstruieren.
Links
Permalink zu dieser Podcast-Episode
RSS-Feed des Podcasts
Word-Vorlage für die Projektdokumentation der IT-Berufe
Erklärvideo zur Arbeit mit Word bei YouTube: Word-Vorlage für
die Projektdokumentation der IT-Berufe
LaTeX-Vorlage zur Projektdokumentation für Fachinformatiker
Anwendungsentwicklung
Wispr Flow
Transkription der gesamten Episode
Automatisch erzeugte Transkription der Episode
[0:21] In den letzten Shorts habe ich jetzt öfter über die
Zeitvorgabe für das Erstellen der Projektdokumentation in den
IT-Berufen bei der IHK-Abschlussprüfung gesprochen. Einige IHK
erlauben ja das Erstellen außerhalb der 40 oder 80 Stunden.
Andere zwingen das in diese Zeit mit rein. Und das ist
natürlich alles super unrealistisch, habe ich jetzt alles schon
ein paar Mal erzählt. Also wie soll ich jetzt in 10, 12,
manchmal sogar nur 8 Stunden eine 30, 40, 50-seitige PDF
erstellen zu meinem Projekt? Das ist ja nicht machbar. Das
wissen wir jetzt alle auch. Jetzt wollen wir uns heute mal
damit beschäftigen, wie es vielleicht doch einigermaßen
realistisch ist, so ein Dokument innerhalb dieser Zeitvorgabe
zu erstellen. Dass ich immer noch glaube, dass das utopisch ist
und man viel länger dafür einplanen muss, als diese Zeitvorgabe
ist. Das habe ich schon im separaten Short besprochen. Aber
heute wollen wir mal gucken, wie kannst du denn tatsächlich
Zeit sparen beim Erstellen deiner Projektdokumentation.
Grundsätzlich ist das Missverständnis vielleicht, dass wenn du
jetzt in deiner Zeitplanung, sagen wir mal zwölf Stunden für
die Doku einplanst, dass du die komplette Doku von Seite 1 bis
Seite 50 innerhalb dieser Zeit erstellen musst. Das ist aber
vielleicht gar nicht der Fall. Denk mir mal an so ein
Softwareentwicklungsprojekt und du hast einen Anhang, da ist
ein Klassendiagramm drin, ein Tabellenmodell, ein ER-Modell,
was auch immer. Diese ganzen Artefakte erstellst du ja sowieso
während der ganz normalen Projektarbeit.
[1:48] Das heißt, wenn du jetzt anfängst mit einer
Entwurfsphase zum Beispiel als Softwareentwicklerin und baust
dir da ein Mockup oder ein ER-Modell, dann hast du ja auch
dafür schon Zeit in deiner Zeitplanung vorgesehen. So ein
ER-Modell zeichnet man auch nicht in fünf Minuten und muss das
nicht einplanen, genauso wenig wie ein Mockup. Da hast du ja
also vielleicht schon 1, 2, 3, 4, was auch immer Stunden für
eingeplant. Das heißt, diese Artefakte sind quasi ja schon mit
eingepreist in deine 40 oder 80 Stunden.
[2:13] Die kannst du dann ja in Anführungszeichen einfach aus
der Schublade ziehen und in deine Doku reinpacken. Das heißt,
im Prinzip sind diese, ich sage jetzt einfach mal acht bis
zwölf Stunden für die Projektdokumentation, der reine Text, den
du zusätzlich noch schreiben musst, weil die ganzen Artefakte
musst du ja eh machen. Die gehören eh zum Projekt mit dazu.
[2:33] Also das ist so ein bisschen die Grundlage auch der
heutigen Episode. Konzentrier dich auf das, was du zusätzlich
als Prüfungsartefakt erstellen musst. Die Sachen, die eh da
sind, weil du sie im ganz normalen Projekt sowieso anfertigst.
Du willst ja ein professionelles Projekt umsetzen. Als
Softwareentwicklerin zum Beispiel nicht einfach coden, sondern
vorher erstmal planen. Und dafür zeichnet man vielleicht
Diagramme. Als Systemintegrator fängst du auch nicht einfach
an. Das ist jetzt mein rudimentäres Verständnis des Berufs,
irgendwo Windows zu installieren, sondern machst dir erstmal
einen Plan. Moment mal, wie viele PCs muss ich überhaupt
bestücken? Was sind da die Standardeinstellungen? Wie verteile
ich die Software etc.? Da fängst du auch nicht einfach an und
machst, sondern du planst, du nimmst die Anforderungen auf, du
überlegst, was überhaupt gemacht werden soll, machst dir einen
Plan für die Durchführung, überlegst dir, wie du das Ganze
testen kannst. Du kommentierst das natürlich für Kunden oder
Admins oder Entwicklerinnen, wie auch immer. Und das ist auch
ja alles Teil deiner 40 oder 80 Stunden. Und diese Dinge, die
du eh machst, sind natürlich auch ein wertvoller Bestandteil
für die Projektdokumentation. Weil damit zeigst du ja, dass du
das Projekt halt eben professionell umgesetzt hast und nicht
einfach gemacht hast. Das wollen wir ja gerade in der
Abschlussprüfung sehen, dass du weißt, wie man sowas
professionell umsetzt und nicht, ne?
[3:48] Als Softwareentwicklerin gibt es immer diesen Begriff
Code-Affe, ne? Code-Monkey. Das heißt, ich bin nur dazu da,
Code in die Tastatur zu hauen. Aber genau dafür machen wir
diese Ausbildung nicht, sondern wir wollen halt eben
professionell Software entwickeln oder Systeme planen oder
Prozesse analysieren oder was du halt in deinem IT-Beruf so
machst. Also, diese Dinge fallen eh schon mit ab. Die brauchst
du halt nicht extra nochmal einplanen. Aber… Sag auch mal so,
trotzdem ist es ziemlich sportlich, auch diese Fließtext-Sachen
innerhalb dieser wenigen Stunden hinzubekommen. Also ich bin
weit in der Meinung, dass das super unrealistisch ist, aber ich
wiederhole es jetzt nicht nochmal. Wir fokussieren uns darauf,
wie kannst du dann weiterhin jetzt wirklich Zeit sparen, um das
in der kurzen Zeit umsetzen zu können. Punkt Nummer eins ist
natürlich, wenn du dich auf den Text fokussierst, brauchst du
ein vernünftiges Textsatzsystem. Das heißt, Werkzeuge wie zum
Beispiel LaTeX oder meinetwegen auch Microsoft Word oder
LibreOffice. Ist ja völlig egal. Du kannst es auch mit
Markdown-Dateien machen oder mit ASCII-Doc generieren. Ehrlich
gesagt ist die Technologie mir völlig egal. Meine Azubis machen
das oft mit LaTeX, beziehungsweise ich, also nicht oft, die
machen es immer mit LaTeX, weil ich das auch als
Ausführungsinhalt vermittle und das wichtig finde. Aber du
musst das nicht damit machen. Du kannst es auch ganz klassisch
mit Word schreiben. Wichtig wäre mir nur, dass du dich mit dem
Textsatzsystem auseinandersetzt.
[5:06] Und auch hier nicht einfach Word öffnest und mal drauf
los tippst und oh, der Begriff sollte fett sein und der kursiv,
also klicke ich auf F und K im Menü, sondern dass du dich
professionell mit dem Textsatzsystem beschäftigst. Simples
Beispiel, das Inhaltsverzeichnis für deine
Projektdokumentation. Das schreibst du nicht per Hand und
machst 1 Punkt irgendwas und 2 Punkt irgendwas, sondern das
Inhaltsverzeichnis wird generiert aus den Metainformationen des
restlichen Textes. Beispiel in Word, wenn du etwas als
Überschrift 1, Überschrift 2, Überschrift 3 markierst, sodass
die Textverarbeitung weiß, dass das Überschriften sind, dann
kann sie daraus das Inhaltsverzeichnis generieren. Wenn du das
aber nicht tust, sondern Überschriften zum Beispiel einfach nur
manuell als Fett markierst und den Text größer machst, dann
kannst du gar nichts automatisieren, weil die Textverarbeitung
einfach nicht weiß, dass das eine Überschrift ist. Es geht hier
um semantische Textverarbeitung. Und das wäre mir ganz wichtig,
gerade bei deinem Abschlussprojekt, vor dem Hintergrund, dass
du Zeit sparen musst.
[6:03] Niemand sagt ja, dass du während dieser 40 oder 80
Stunden auch noch professionelle, Textsatzsysteme lernen musst.
Das kannst du alles ja vorher machen. Du weißt, wann deine
Projektdokumentation zu schreiben ist. Das weißt du fast am
Starttag deiner Ausbildung, weil die Prüfungstermine alle
ziemlich weit in die Zukunft feststehen. Das heißt, du weißt,
dass du irgendwann in diesen drei Jahren dich vielleicht mal
irgendwie ein bisschen mit dem Texas-System beschäftigen
solltest, wenn deine Abschlussprüfung davon abhängt, ein
vernünftiges Dokument zu erstellen. Das heißt, wenn du Zeit
hast, guck dir LaTeX an. Wenn du da Bock drauf hast, musst du
nicht. LaTeX ist etwas, was eher, ja, wie soll ich sagen, etwas
programmierlastig ist. Ich will jetzt nicht sagen, dass man
damit seine Dokumente programmiert, aber am Ende ist Tech, was
da drunter liegt, tatsächlich eine Programmiersprache. LaTeX,
ein Makrosystem dafür. Das heißt, das, was du da produzierst,
sieht natürlich eher nach Code aus als nach Text. Dafür hast du
aber ganz, ganz viele Sachen, die dir geschenkt werden, zum
Beispiel automatisierte Inhaltsverzeichnisse, Verweise, saubere
Referenzen auf Bilder, Anhang etc., Seitenummerkungen, das
kriegst du alles quasi kostenfrei.
[7:06] Aber ja nicht ganz, weil du hast halt eine
Einarbeitungszeit. Wobei du die halt bei Word oder LibreOffice
oder sonst wo auch hättest. Du musst halt wissen, wie du mit
diesen Textssystemen zum Beispiel eben eine Überschrift
kennzeichnest, damit du dann ein Inners-Versignis generiert
bekommst. Also damit musst du dich auseinandersetzen und davon
gehe ich jetzt auch im Weiteren aus. Also wenn du jetzt einfach
anfängst, innerhalb deiner 40 oder 80 Stunden noch nie mit Word
gearbeitet und fängst an und machst dann Artikel, dann wird es
äußerst schwierig, das in der Zeit zu schaffen. Weil dann wirst
du wahrscheinlich mehr Zeit mit Formatierung verbringen. Als
mit dem Produzieren der Inhalte. Und wenn du eins nicht machen
solltest beim Schreiben von Texten, ist es Formatierung. Die
Formatierung musst du dem System überlassen. Du gibst dem
System die semantische Information, was du gerade bearbeitest.
Ist es eine Überschrift? Ist es ein Code-Beispiel? Ist es eine
Tabelle?
[7:52] Was ist inhaltlich das, was du da gerade machst? Und
ganz am Ende kannst du dann der Software sagen, so, Tabellen
sollen bitte so aussehen, Überschriften bitte so und Texte so.
Das heißt, wenn du Zeit, mehr Zeit in der Formatierung brauchst
als in der eigentlichen Erstellung des Textes, dann machst du
etwas falsch. Dann beherrschst du dein System nicht. Das wäre
jetzt meine pauschale Aussage. Also, plan Zeit ein für das
Erlernen eines Textsatzsystems. Es muss nicht lädlich sein, es
kann Word, Libre, was auch immer sein, aber erwarte nicht, dass
das einfach so funktioniert, sondern du musst dich damit
beschäftigen, wenn du so etwas vorher noch nie gemacht hast.
Und für viele Auszubildende ist die Projektdokumentation das
erste große umfangreiche Dokument. Man braucht ja zum Beispiel
kein Abi, um die Ausbildung zu machen. Da hat man vielleicht
schon mal in der Schule eine Facharbeit oder so geschrieben.
Inzwischen ist es, glaube ich, auch gar nicht mehr so gang und
gäbe, dass man sowas macht. Das heißt, vielleicht ist es
wirklich für ganz viele Prüflinge die allererste große, lange
Arbeit. Und dann hat man vorher noch nie mit Word oder so
professionell gearbeitet und sollte sich entsprechend die Zeit
einplanen. Aber bitte außerhalb der 40 oder 80 Stunden. Und
fang auch nicht einen Monat vorher an, wenn du gerade im
Prüfungsvorbereitungsstress bist. Fang vielleicht ein Jahr
vorher an, dich mal ein bisschen mit Word, Lateech, was auch
immer zu beschäftigen.
[9:01] So, ansonsten würde ich wie bei, meine Analogien sind
nämlich immer Softwareentwicklung, weil das natürlich mein
Steckenpferd ist, aber wie würdest du deine Softwareentwicklung
machen, auch inkrementell Zwischenstände sichern etc. Und wie
macht man das? Mit einer Versionierungssoftware. Das heißt, was
spricht dagegen, dein Abschlussdokument mit Git zum Beispiel zu
versionieren? Es muss nicht Git sein, es kann auch irgendein
anderes sein, was vielleicht in ein paar Jahren hip ist, jetzt
aktuell, 2026, machen alle Git. Finde ich auch gut, ist ein
gutes Tool, kannst du komplett lokal benutzen, du brauchst
keinen Server oder sonst irgendwas. Du kannst einfach dein
lokales Dokument versionieren, du kannst jederzeit dir die
Unterschiede angucken, alte Versionen wiederherstellen etc.
[9:36] Und dann kannst du dieses Dokument wachsen lassen,
während du an deinem Projekt arbeitest. Und genauso würde ich
es auch empfehlen. Bevor du dein Projekt startest, würde ich
als allererstes die Projektdokumentation aufsetzen. Also das
Word-Dokument vorbereiten, das Lateech-Projekt vorbereiten, was
auch immer. Und das Ding dann in Version 0 quasi, Committen in
Git, dann hast du das Teil immer griffbereit. Und wenn du jetzt
durch deine Phasen der Projektarbeit, die echten Phasen läufst,
also Analyse, Entwurf, was auch immer, dann kannst du immer
schon parallel dazu Notizen machen oder vielleicht sogar schon
ausformulieren, je nachdem, wie viel Zeit oder Lust du hast.
Wenn du jetzt zum Beispiel ein ER-Modell erstellst als
Softwareentwicklerin, dann könntest du parallel dazu oder wenn
du fertig bist mit dem ER-Modell schon mal ein, zwei
Stichpunkte in das Kapitel, Datenmodell deiner Dokumentation
schreiben und sagen, wie bist du vorgegangen, worauf habe ich
geachtet, was waren vielleicht Besonderheiten? Weil während du
das gerade erstellt oder erstellt hast, ist es natürlich noch
frisch im Kopf. Du weißt, was waren denn da die Probleme? Wie
bin ich denn da vorgegangen? Und das kannst du natürlich am
besten dokumentieren, wenn du es gerade gemacht hast und nicht
drei Monate später, wenn das Projektstudios umgesetzt ist.
Dabei tun sich dann vielleicht auch viele Prüflinge schwer,
wirklich noch den Text gut zu formulieren, weil sie gar nicht
mehr wissen, was sie gemacht haben. Also so viele Prüflinge,
die ich schon in der Prüfung hatte, wo man mal fragt, ja, in
ihrer Doku haben sie ja geschrieben XY. Und dann kommt die
Antwort, oh ja, nee, das ist schon so lange her, das weiß ich
gar nicht mehr.
[10:56] Ja, macht nicht so einen guten Eindruck. Und beim
Schreiben der Dokumentation hast du sicherlich einen Vorteil,
wenn das im Kopf noch frisch ist, was du da eigentlich gerade
gemacht hast. Also lass das Dokument wachsen, versioniere das
Ding, mach es inkrementell, so wie wir es bei agilen
Softwareprojekten auch machen würden.
[11:12] So, dann natürlich muss ein Tipp von mir sein, nutz
doch einfach eine Vorlage. Ich meine, ich habe eine Vorlage
online, sowohl für Latik, als auch für Word, als auch für
LibreOffice. Ja, kannst du einfach runterladen. Die
Word-LibreOffice-Geschichten sind kostenpflichtig. Findest du
unter dieperfekteprojektdokumentation.de. Aber das wird dir auf
jeden Fall einen Haufen Arbeit abnehmen, so eine Vorlage zu
benutzen. Denn was du auf jeden Fall machen musst in so einem
Dokument ist, wie ich gerade schon gesagt habe,
Inhaltsverzeichnis generieren lassen. Du musst, keine Ahnung,
Kopf- und Fußzeile setzen. Du musst die Seitenzahlen vernünftig
machen. Du musst die Überschriften fortlaufen,
durchnummerieren, etc. Also diese ganze
Formatierungsgeschichte, was soll fett sein, was ist kursiv,
wie sieht das Deckblatt aus, was gehört da drauf, etc. Das hat
alles weder mit deinem Projekt noch mit der eigentlichen
Dokumentation deines Projekts zu tun, sondern es ist einfach
eine technische Anforderung, weil du das im Text-System erstmal
alles umsetzen musst. Das ist reine Technik und die hat aus
meiner Sicht auch nichts in diesen 40, 80 bzw. 8 bis 12 Stunden
für die Projekte-Gruppe verloren. Das kannst du auch alles
vorbereiten. Niemand erwartet von dir, in Word mit einer leeren
Seite zu starten und dann alles zu machen innerhalb dieser
Zeit. Denk mal dran, angenommen, du willst das im Corporate
Design deiner Firma gestalten, dann erwartet auch keiner von
dir, dass du das noch nachbaust, sondern du nimmst natürlich
einfach die fertige Vorlage und schreibst damit.
[12:33] Und das Ganze würde ich genauso übertragen auf Vorlagen
wie zum Beispiel von mir. Du nimmst sie einfach, die bieten dir
einen Rahmen, die Technik ist für dich gelöst Und jetzt kannst
du dich auf deinen Job konzentrieren, nämlich die Texte
schreiben, die Struktur überarbeiten, dein Projekt vorstellen.
Du wirst nicht dafür auch nur einen Punkt besser in der Note
bewertet, wenn du tolle Überschriften formatiert hast, die
kursiv sind. Das interessiert niemanden. Du wirst hier nicht
ausgebildet zum, wie heißen denn die Berufe? Mediengestalter
wahrscheinlich? Sondern du bist in einem IT-Beruf. Man
erwartet, dass du professionell mit einem Textdassystem
arbeiten kannst, aber dafür kriegst du keine extra Punkte. Das
heißt, nimm doch einfach eine Vorlage, spar dir diese Arbeits-
und Lebenszeit, wo du noch selber deine eigene Vorlage
entwickelst. Nimm einfach eine fertige und fertig. Da kann dir
eigentlich auch keiner einen Strick draus drehen, weil es geht
ja nicht darum, dass du die Arbeit in deinem Projekt abnehmen
lässt, also dass irgendwer für dich die Software programmiert
oder das Netzwerk konfiguriert, sondern es geht nur darum,
vernünftige Vorlagen für Überschriften, Inhaltsverzeichnisse
und so weiter zu haben. Und das hat ja mit deinem Beruf nichts
zu tun, also mit dem Zeug, was du in der Prüfungsleistung
zeigen sollst. Deswegen, nimm eine Vorlage, spar dir die Zeit
und dann ist das viel einfacher damit zu starten.
[13:44] So, dann habe ich eben schon gesagt, die Sachen, die du
eh schon erstellst für dein Projekt, wirst du natürlich
wiederverwenden. Du wirst nicht für deine Projektdokumentation
nochmal ein Klassendiagramm malen, wenn du es schon in der
Entwurfsphase gebracht hast. Und hier dann aber vielleicht ein
wichtiger Tipp. Genauso wie beim Programmieren, wenn du Sachen
wiederverwenden willst, musst du sie natürlich wiederverwendbar
entwickeln. Und das ist jetzt bei den Diagrammen für die Doku
genau das Gleiche. Wenn du nochmal einen Schritt weiter denkst,
das Diagramm wirst du vermutlich auch in deiner
Projektpräsentation nutzen. Und jetzt haben wir schon ein
Problem. Die Projektdokumentation wird in Deutschland
üblicherweise im DIN A4 Format, also Hochformat gesetzt.
Präsentation ist eher 16 zu 9, also krasses Breitbildformat.
Jetzt ist die Frage, in welchem Format erstellst du denn deinen
Klassenlehrer? Machst du das für die Doku oder machst du das
für die Präsi? Und da muss ich schon mal sagen, mach einfach
zwei Versionen.
[14:32] Also während du dein Klassendiagramm erstellst, dann
musst du schon im Hinterkopf behalten, dass du dieses Ding
später mal auf zwei verschiedenen Medien darstellen möchtest.
Und deswegen würde ich tatsächlich dazu tendieren, wenn du
nicht, ich bleibe jetzt mal beim Klassendiagramm, das kannst du
ersetzen durch alles mögliche andere, was du noch machst. ein
Netzplan, ein Netzwerkplan als Physi, ein Prozessablaufdiagramm
als Daten- und Prozessanalyst, wie auch immer. Diese ganzen
Diagramme müssen einmal im Hochformat, einmal im Querformat
vernünftig dargestellt werden können. Und wenn du die Zeit hast
und es einfach möglich ist, mach doch einfach direkt zwei
optimierte Varianten deiner Diagramme für diese beiden Medien.
Und wenn du sowieso ein Diagramm hast, was quasi quadratisch
ist, also was schön als Quadrat vernünftig dargestellt werden
kann, dann nimmst du halt das, weil das kannst du in beiden
Medien darstellen. Aber du wirst später sehen, gerade bei der
Projektpräsentation hast du sehr wenig Platz auf den Folien,
weil die müssen ja entsprechend groß dargestellt werden, die
Inhalte, damit man die vernünftig lesen kann. Und dann kann es
sinnvoll sein, ein extra horizontal ausgerichtetes Ding zu
bauen, was du sonst vielleicht eher nur hochkant für deine Doku
gebaut hättest. Deswegen achte direkt, das ist ja mein Punkt
hier, achte beim Erstellen deiner Artefakte darauf, dass du sie
in einem Hochkantformat wie deiner Projektdokumentation
vernünftig darstellen musst.
[15:49] Im Zweifel, wenn du keine Zeit hast oder keine Lust,
zwei Varianten zu machen, konzentrier dich auf die
Hochkant-Variante, weil in deiner Doku muss das vernünftig
lesbar sein und da hast du auch keine einfachen Möglichkeiten,
das irgendwie aufzuteilen auf zwei Seiten oder sonst was, ohne
dass die Lesbarkeit leidet. Und wenn du ein Hochkantformat in
deiner Präsi zeigen willst, hast du immer die Möglichkeit, in
PowerPoint zum Beispiel mit Animationen zu arbeiten, mit Zooms,
mit Hoch- und Runtersliden und was auch immer du machen kannst.
Da hast du ja ein ganz anderes Medium und das ist ein
interaktives Medium, wo du auch selber noch hin und her
schieben kannst. Aber auf einem gedruckten PDF wird das nicht
so einfach funktionieren. Deswegen im Zweifel orientiere dich
schon, während du die Artefakte erstellst, an einem DIN A4
Format, auf dem das nachher vernünftig dargestellt werden muss.
Das wäre hier an der Stelle schon mal die Empfehlung. Dann
sparst du dir nämlich einen Haufen Zeit, um die Diagramme
umzuformatieren, weil sie nicht in deinen PDF passen.
[16:42] So, dann nächster Punkt Text. Wir haben ja eigentlich
schon gesagt, dass es in diesen acht bis zwölf Stunden darum
gehen soll, dass du dich auf den Text fokussierst, weil die
Artefakte kommen ja eh mit raus und viele der Texte, viele
vielleicht nicht, aber einige der Texte kannst du vielleicht
sogar schon eins zu eins aus deinem Antrag übernehmen. Ich
denke an sowas wie eine Projektbegründung. Was sind die
Anforderungen? Wie soll man das am Ende vielleicht testen? Also
gibt es irgendwie ein Testszenario, Abnahmekriterien, irgendwie
sowas. Das ist etwas, was du für einen Projektantrag in vielen
Fällen schon schreiben musst. Projektanträge sind ja super
spezifisch, je nach IHK. Das kann ich jetzt nicht für alle
sagen. Aber ganz oft kannst du Texte fast eins zu eins wieder
übernehmen. So, keine Ahnung, du musst dein Unternehmen grob
vorstellen. Du musst in wenigen Sätzen erklären, was dein
Projekt überhaupt macht. Was ist das Ziel? Wer will was von dem
Projekt? Was sind die Stakeholder? Was auch immer. Also diese
allgemeinen Informationen zum Projekt, die musst du schon dem
Projektantrag ja normalerweise angeben, damit man dein Projekt
bewerten kann, ob das zum Beruf passt. Und die könntest du in
vielen Fällen einfach an deine Doku übernehmen.
[17:42] Und das ist auch nicht geklaut oder sonst was, also ein
Plagiat, weil du hast die Texte selber geschrieben. Und niemand
sagt, dass du nichts aus dem Projektantrag übernehmen darfst
für deine Projektdokumentation. Vielleicht musst du es, damit
es sich vernünftig liest, ein bisschen umformulieren, kürzen
oder erweitern, wie auch immer. Aber wenn du dir die Arbeit
schon gemacht hast, dein Projekt auf wenigen Zeilen zu erklären
für den Projektantrag, wäre es ja dumm, das Gleiche nochmal zu
machen für die Projektdokumentation, wenn es eh schon fertig
ist. Also Wiederverwendung, nicht nur während der
Projektdurchführung, sondern auch aus dem Projektantrag kannst
du die Sachen schon übernehmen.
[18:17] So, jetzt sind wir im Jahr 2026. Da würde, weil ich das
persönlich auch nutze, ich noch einen weiteren Tipp geben. Und
zwar, tipp doch nicht so viel, sondern lass einfach die KI
transkribieren und sprech deine Texte ein. Das fällt einigen
Menschen vielleicht ein bisschen schwer, wenn sie nicht gewohnt
sind, so wie ich das jetzt übrigens gerade mache. Ich nehme
jetzt hier meinen Podcast auf, ohne dass ich da jetzt genau
weiß, was ich sagen muss und wie die Sätze formuliert werden.
und ab und zu ist auch mal ein Versprecher drin, ja. Aber die
KI ist heutzutage, 2026, so stark, da kannst du, genau wie ich
das gerade mache, einfach ein paar Sachen erzählen und die
transkribiert das.
[18:53] Wenn du eine schlechte KI hast, wortwörtlich mit Ams
und Pausen und irgendwas, aber wenn du eine gute KI hast, ich
kann nur einen Tipp geben, ohne dass ich dafür Geld bekomme,
Whisperflow zum Beispiel benutze ich dafür, kriegt das sehr,
sehr gut hin, auch Versprecher auszumerzen, sage ich mal. Die
macht automatisch Punktlisten, Wenn du sagst, es kommt eine
Auflistung oder 1, 2, 3, macht das automatisch, sei es
Formatierung ist sogar mit drin, mit Satz, Endezeichen,
Grammatik etc. Also das ist eine super gute KI für
Transkription, aber es gibt auch noch andere, du musst jetzt
nicht die benutzen. Aber wenn es wirklich um den Fließtext
geht, dann kann es wirklich sehr viel Zeit sparen, wenn du
nicht tippen musst. Auch wenn das für mich persönlich irgendwie
auch eine komische Geschichte ist. Ich meine, wir sind
Softwareentwickler, ITler, was auch immer. Und die Tastatur ist
natürlich unser Weg, um mit unserem System zu kommunizieren und
wird das wahrscheinlich auch noch lange bleiben. Aber der
Sprachkanal ist einer, der einfach viel schneller funktioniert.
Also du kannst viel schneller deine Texte einsprechen, als sie
tippen. Selbst wenn du Tipp-Weltmeister bist, wirst du nicht an
das Sprachtempo rankommen. Deswegen erstes vielleicht eine
Überlegung, eine KI dafür zu benutzen. Und Disclaimer
natürlich, achte auf Datenschutz und Security etc.
[20:03] Wie bei allem, was du mit KI so machst. Wenn du da
jetzt hochsensible Firmendaten eingibst für dein
Abschlussprojekt, dann würde ich da vielleicht lieber keine KI
für benutzen. Wobei, ehrlich gesagt, hochsensible Firmendaten
als Abschlussprojekt, da hast du vielleicht auch das falsche
Projekt dann gewählt. Aber das ist ein anderes Thema. Also
sprich vielleicht deine Texte ein, anstatt sie zu tippen. Ernst
gemeinter Tipp, ich mache das ganz ehrlich auch fast immer so.
Ich habe auch schon gar keine Lust mehr zu tippen, weil das
Sprechen viel, viel schneller geht und meine Lebenszeit ist
begrenzt. Das ist einfach so.
[20:33] So, dann gucken wir nochmal kurz, was du vielleicht
während deiner Projektdurchführungszeit so an Artefakten
erstellen könntest, die du halt direkt für die Doku aufbereiten
könntest. Ich orientiere mich wieder jetzt stark an
Softwareentwicklungsprojekten. Für andere IT-Berufe fallen dir
da bestimmte Entsprechungen ein. In der Analysephase zum
Beispiel gibt es Use-Case-Diagramme oder Lasten- und
Pflichtenheft. Das könnte man sogar für alle anderen IT-Berufe
anführen, Lasten- und Pflichtenheft oder irgendeine andere Form
der Anforderungsermittlung. Das musst du sowieso machen für
dein Projekt und schon hast du ein, zwei, je nachdem, drei
Seiten für den Anhang schon gefüllt, wenn du das entsprechend
schon mal so aufbereitest, dass du es nachher einbauen kannst
in die Doku. In der Entwurfsphase jetzt könntest du
Architekturdiagramme machen mit UML rauf und runter. Du kannst
Mockups zeichnen, Datenmodelle erstellen, Schnittstellen, APIs
beschreiben, was auch immer. Das machst du ja eh alles und sind
alles wertvolle Artefakte für deine Projektdokumentation. Und
auch wieder für alle IT-Berufe, Dokumentationsphase gibt es
auch in jedem Projekt. Und hier reden wir jetzt wieder von
Benutzer, Kunden, Anwender, Entwickler-Doku und nicht der
Projekt-Doku für den Prüfungsausschuss. Die musst du eh
erstellen. Da sind normalerweise auch immer drei, vier, fünf
Stunden für einzuplanen, weil das sind ja dann wirklich auch
umfangreiche Word-Dokumente oder Markdown oder wie auch immer
du deine Doku halt erstellst für deine Kunden. Und die kannst
du natürlich auch eins zu eins in deiner Projekt-Doku wieder
aufführen. Vielleicht auch nur in Auszügen, weil es sonst zu
lang wird. Aber die Dinger sind ja fertig. Also pack die doch
nachher einfach in deine Projektdoku rein.
[21:57] So, ein paar Anregungen nochmal zum Schluss, was du da
alles reinpacken kannst. Ich habe auch nochmal eine eigene
Episode gemacht zum Thema, was gehört eigentlich alles in die
Projektdoku und was erwartet man da so. Aber hier waren jetzt
nochmal ein paar Stichpunkte drin.
[22:08] Und mein Fazit für heute ist, du sparst Zeit, wenn du
deine Doku nicht ganz am Ende des Projektes schreibst, so wie
wir das in der Softwareentwicklung und anderen IT-Projekten
auch oft machen. Ja, erstmal umsetzen und ganz am Ende
schreiben wir Doku und ach, dann schreiben wir doch eigentlich
in den meisten Fällen gar keine Doku, weil wir haben keine Zeit
mehr und das nächste Projekt kommt und das ist viel spannender.
Mach doch die Doku wirklich begleitend zu deinem Projekt. So
ist sie ja eigentlich auch gedacht. Du sollst deine
Projektdurchführung dokumentieren und im Prüfungsausschuss
demonstrieren. Und das kannst du tatsächlich am besten, wenn du
das parallel zu deiner Projektdurchführung machst. Dann sind
die Gedanken noch frisch. Du hast das Klassendiagramm gerade
gezeichnet, dann kannst du nochmal eben zwei Sätze dazu
schreiben. Und wenn es auch erstmal nur Stichpunkte sind, um
die später auszuformulieren, aber du denkst dann zumindest dran
und musst dir später nicht überlegen, was habe ich da jetzt vor
acht Wochen nochmal gemacht?
[22:57] Also sieh das als wachsendes Dokument. Ich plane aber
genug Zeit ein, um dich in den Textsatz einzuarbeiten, und zwar
vor der Projektdurchführung. Das wäre ganz wichtig. Und nutze
gerne Vorlagen, um dir einfach die technische Zeit zu ersparen,
wo du sonst selber rumfrickeln müsstest mit Überschriften,
Formatierung und ich weiß nicht was.
[23:14] So, das wäre meine Idee zum Thema Zeitsparen bei der
Projektdokumentation. Vielleicht war für dich was Gutes dabei.
Wenn ja, lass mir gerne einen Kommentar da oder gib mir
Feedback. Vielleicht hast du noch andere Ideen, wie man noch
mehr Zeit sparen kann. Hau es in die Kommentare unter die
Episode, würde mich sehr freuen. Ansonsten wünsche dir viel
Erfolg bei deiner Projektdokumentation, wichtiges
Prüfungsartefakt, nicht unterschätzen, plan da vernünftig Zeit
rein.
[23:37] Aber mit meinen Tipps heute ist es vielleicht möglich,
das auch in endlicher Zeit zu schaffen. Ich wünsche dir alles
Gute, bis demnächst.
Kommentare (0)
Melde dich an, um einen Kommentar zu schreiben.