Fachinformatiker Projektdokumentation Probleme

Zurzeit bin ich im dritten Lehrjahr zum Fachinformatiker Systemintegration. Ich bin gerade dabei, meine Projektdokumentation zu schreiben und habe damit einige Schwierigkeiten, da ich nicht genau weiß wie ich diese schreiben soll. In der Schule wurde uns das überhaupt nicht erklärt. Mein Thema lautet wie folgt. Desktopvirtualisierung von acht Clients mit der Software VMware View in einer VMware vSphere Umgebung. Das hört sich zwar nun kompliziert an, ist aber für das Thema nicht so richtig wichtig.

Ich bin also nun dabei die Dokumentation darüber zu schreiben, nur mein Problem ist, ich weiß gar nicht in welcher Zeitform ich diese schreiben soll. Entweder in der Gegenwart oder in der Vergangenheit. Im Internet wird manchmal gesagt sie solle in der Gegenwart geschrieben werden, aber wenn ich nun ein Teil fertig habe, sagen wir mal die Installation eines Servers, dann ist dies doch bereits geschehen. Also müsste ich doch sagen: "Der Server wurde installiert" anstatt "Der Server wird installiert" Ich bin da nun etwas verwirrt.

Das nächste Problem, welches ich habe ist, dass ich nicht weiß, in wie fern ich alles erklären soll. Soll die Dokumentation allgemein gehalten sein oder soll ich alles ganz genau erklären? Also hier klicken um das zu machen, dann hier klicken und so weiter?

Ich habe meine Projektdokumentation in der Gegenwart geschrieben. Denn sie soll doch im Ernstfall dazu dienen, das es jemand mit Hilfe deiner Aufzeichnungen selbst machen kann. Selbst wenn dein Projekt selbst schon abgeschlossen ist.

Dazu habe ich alles so erklärt, das es auch Computerlaien verstanden haben. Allerdings hatte ich halt auch einen Fachmann und einen wirklichen Computerneuling zum Kontrolllesen. Von daher solltest du schon so ausführlich wie möglich erklären.

Dabei machen sich auch Grafiken immer recht gut. Denn wer will schon mehrere Seiten nur Text lesen? Wenn man mit Bildern und kurzen Texten arbeitet, ist das ganze anschaulicher. Bei der Installation eines Servers kann man das sogar auf verschiedene Weisen einbauen. Einmal halt in den normalen Ablauf der Arbeiten die gesamte Vorgehensweise dokumentieren.

Oder aber man erwähnt im Ablauf nur die Installation des Servers, wobei man eben auch schreiben muss, was dazu alles benötigt wird. Die Anleitung dazu kann man halt auch in den Anhang packen, so das halt Leser ohne entsprechende Kenntnisse dort nachlesen. Für alle anderen geht es ohne die Erklärungen vorne im Ablauf weiter.

Achja und solche Dinge wie Inhaltsverzeichnis nicht vergessen. Überschriften und Zwischenüberschriften werden ja durchnummeriert und der Zeilenabstand beim Text sollte 1 1/2 betragen. Schriftgröße wird meist in Arial 11 verlangt und Überschriften nicht größer als 14. War jedenfalls vor 10 Jahren bei mir noch so.

Üblicherweise ist bei einer solchen Arbeit die verwendete Form der Präsens. Jedoch solltest du die Vergangenheitsformen dort setzen, wo sie hingehören. Auch solltest du darauf achten, die Ich-Form möglichst wenig zu verwenden. Schließlich soll die Arbeit ja sachlich und professionell klingen.

Hast du deinen Ausbilder schon gefragt, in welcher Zeit er damals seine Projektarbeit gehalten hat? Versuch dir doch einfach mal dein Projekt in beiden Zeiten vorzustellen. Welche klingt in deinen Ohren besser? Ein Projekt ist außerdem keine wissenschaftliche Arbeit, sondern soll eine von dir durchgeführte Handlung beschreiben.

Man findet jedoch im Internet recht kontroverse Ansätze zu deiner Frage. Ich an deiner Stelle würde wirklich beim Ausbilder nachfragen, der hat vielleicht einige nützliche Tipps für dich.

Soweit ich weiss musst du circa 15 Seiten vollschreiben, inklusive Deckblatt und Quellenangaben. Wenn du auch noch einige Grafiken einbindest, solltest du diese Seiten locker gefüllt bekommen. Meiner Meinung nach solltest du dich einerseits allgemein halten, aber auch wichtige Details nennen. Die Angaben zur Formatierung kannst du ja den IHK-Unterlagen entnehmen, dort steht nämlich alles genau beschrieben.

Richtig ist bei einer solchen Arbeit natürlich die Gegenwart, da man ja nicht berichten möchte, was man getan hat (so wie du es in deinem Berichtsheft machst), sondern es geht ja um die Beschreibung eines bestimmten Problems und dessen Lösung. Aus dem gleichen Grund hat ein "Ich" auch absolut nichts in der Projektdokumentation zu suchen.

Zumindest bei wissenschaftlichen Arbeiten ist das Standard und es schadet sicherlich nicht, diese Standards auch bei einer solchen Projektarbeit einzuhalten.

Normalerweise beginnt man in der Einleitung das Problem zu beschreiben und was man mit seiner Arbeit überhaupt erreichen will. Bei einer wissenschaftlicher Arbeit beschreibt man hier den Stand der Technik und wie man quasi über diesen Stand hinausarbeitet. Bei einer solchen Projektarbeit wird man das in der Regel nicht tun, deshalb wird wohl eine einfache Problembeschreibung ausreichen.

Normalerweise folgt dann der Teil, in dem man seine verwendeten Werkzeuge beschreibt, in diesem Fall also die verwendete Software. Evtl. geht man auch allgemein auf Grundlagen ein - in deinem Fall wäre das vielleicht die Beschreibung von Virtualisierungstechnologien.

Erst dann folgt eigentlich die Dokumentation der Realisierung des Problem. Und als Schlusskapitel kann man noch einmal die Ergebnisse zusammenfassen und einen Ausblick stellen, was man mit der Projektarbeit anfangen kann und welche Ansätze man darauf aufbauend weiter verfolgen kann.

Das ist zumindest eine mögliche Struktur, es gibt aber möglicherweise noch weitere Pflichtinhalte, die von euren Lehrern gefordert wird. Ich persönlich würde eine Schritt-Für-Schritt-Beschreibung nicht unbedingt in die Dokumentation einbauen, das wäre eher etwas für den Anhang.

Ich stand schon mehrmals vor dem Problem, in welcher Zeitform eine Dokumentation geschrieben sein muss. Sowohl Vergangenheits- als auch Gegenwartsform klangen für mich immer sehr plausibel. Mein Ausbilder brachte da mehr Licht ins Dunkle: Eine Dokumentation ist ja mehr eine Anleitung als ein Bericht. Da du davon ausgehen musst, dass man deine Dokumentation auch nachvollzieht, um den Wahrheitsgehalt zu überprüfen, sollte sie in der Gegenwart geschrieben sein. So, als würdest du es einem Nutzer erklären, der direkt vor dir sitzt und dein Thema umsetzen soll.