Supportnet / Forum / Plauderecke
Dokumentation
Frage
Morgen alle,
ich muss für mein Abschlussprojekt eine Dokumentation schreiben (10 Seiten), da hab ich unter anderem den Punkt Dokumentation als Unterpunkt von Projektdurchführung. Ich habe diesen Standardsatz geschrieben:
Die Dokumentation erstreckte sich über den kompletten Zeitraum der Projektbearbeitung. Sie wurde mit jedem Teilabschnitt der Bearbeitung erweitert und endete mit der Projektbewertung.
Jetzt meint mein Chef, ich soll da noch mehr hinklatschen, sowas wie wie wurde dokumentiert und so.
Ich kann mir da gar nix drunter vorstellen! Was soll ich da bitte schön schreiben? Dokumentiert wurde mit den Fingern auf der Tastatur in Word? Schwachsinn
Antwort 1 von Nhuya
Zum Beispiel wo du den Schwerpunkt der Dokumentation gelegt hast, welche Schwierigkeiten es gab, was daran gut war... soclhe Sachen, nicht was du dazu genutzt hast. Hebe die Vorteile einer Dokumentation hervor :)
Antwort 2 von MCC1
Die wichtigste Frage ist was dokumentiert wurde.
Beispiel: Netzwerk aufbauen. Du kannst die technische Dokumentation recht lässig handhaben oder sehr genau. Alleine im Bereiche der Kabelverlegung geht das von Prinzipskizzen bis zur Kabeltrommelnummer von der das Kabel genommen wurde......
Bestell und Garantieunterlagen der eingesetzten Komponenten, Bedienungsanleitungen etc.
Und als jemand der oft genug unter mangelnder Doku gelitten hat, kann ich dir nur raten dieses Thema sehr sehr ernst zu nehmen.
Wenn du das erste Mal nachts im Betrieb auftauchst weil irgendwas nicht funktioniert, wirst du eine gute Doku zu schätzen lernen.
Gruss
Stefan
Beispiel: Netzwerk aufbauen. Du kannst die technische Dokumentation recht lässig handhaben oder sehr genau. Alleine im Bereiche der Kabelverlegung geht das von Prinzipskizzen bis zur Kabeltrommelnummer von der das Kabel genommen wurde......
Bestell und Garantieunterlagen der eingesetzten Komponenten, Bedienungsanleitungen etc.
Und als jemand der oft genug unter mangelnder Doku gelitten hat, kann ich dir nur raten dieses Thema sehr sehr ernst zu nehmen.
Wenn du das erste Mal nachts im Betrieb auftauchst weil irgendwas nicht funktioniert, wirst du eine gute Doku zu schätzen lernen.
Gruss
Stefan

