Abschlussdokumentation Netzwerküberwachung

[boost]

Hallo Zusammen,

ich bin gerade dabei meine Abschlussdokumentation über eine Netzwerküberwachungs- und Wartunglösung zu schreiben (nein kein Nagios...heißt Ridgeline 3.0). Ich habe das Projekt auch soweit durchgeführt. Die Frage ist nun, wie mach ich es mit der Aufteilung Projekt + Anhang. Es heißt ja immer man soll in die eigentliche Projektarbeit keine Screenshots mit Anleitung einpflegen...

Wie würdet ihr es mir empfehlen, dass ich vll. im eigentlichen Projekt grob darauf eingehe z.B. Geräte wurden eingebunden, Alarmmeldungen wurden erstellt ...das ganze ein bisschen oberflächlich beschreibe und dann einen Verweis auf den Anhang wo es Screenshot für Screenshot und klick für klick erklärt wird...vll. so?

Die ganze Netzwerküberwachung findet betriebsintern statt, sprich der Auftrag kommt von meinem Chef, kann ich hier auch eine Kundendokumentation schreiben?

Bzw. brauche ich hier ein Pflichtenheft?

Danke und schönen Gruß Boost

[Trunks2117]

Habs bei mir (Win 7 Integration) so gelöst. In die Doku kommt eine kurze Übersicht was ich gemacht habe und wo Probleme aufgetreten sind. Im Anhang habe ich ein mehrseitiges How to welches das Was und das Wie beschreibt.

[Cath]

Also ich sehe es so, die Mischung macht es.

Sei nicht zu oberflächlich in deiner Doku, damit man den "Faden" nicht verliert.

Komplexe und ausführliche Installationsvorgänge, kannst du natürlich im Anhang beschreiben, dann aber am besten im Text einen Verweis auf den Anhang mit Seitenzahl.

Du kannst auch Anleitungen (Kundendokus, Angebote, Verträge, Rechnungen etc) in den Anhang verbasteln. Nur achte darauf, dass es nicht zu überfüllt wird. Was geeignet ist, deine Projektarbeit zu verdeutlichen, zu unterstützen und die Klar- und Echtheit zu eröhen, wird verwendet. Alles andere laß weg, denn überladen schadet mehr als es nutzt.

Gruß Cath

[boost]

Hi Leute,

glaubt ihr ich soll lieber eine Kundendokumenation schreiben mit allen Anleitungen und im Hauptteil dann immer auf das jeweilige Kapitel der Kundendoku im Anhang verweisen.

Oder lieber einfache Tutorials die ich in den Anhang packe und dann im Hauptteil immer darauf verweise.

Ich weiß nicht ob hier eine Kundendokumentation angebracht wurde, der Projektauftrag wird von meinem Chef gestellt?

danke und schönen Gruß

boost