Beim Abschlussprojekt beschreibungen lieber in den Text oder den Anhang?

[tims1998]

Hallo zusammen,

ich arbeite zurzeit an meiner Projektdokumentation und habe dazu einmal eine Frage, würdet Ihr Beschreibungen von Installationen eher in den Text oder in den Anhang packen?
Teil meines Projektes ist z.B. eine Ubuntu Server VM, da habe ich nicht geschrieben was ich alles im Detail gemacht hat sondern nur:  Server wurde nach Firmenstandards aufgesetzt und eingerichtet, Leitfäden sind im Anhang.
Wie seht ihr das?

[t1nk4bell]

Ich persönlich finde Installations/konfigurations klick Anleitungen/ Screens massiv überflüssig. 

Außer wenn was besonderes gemacht wird mit entsprechender Erklärung 

[BitteNichtSchubsen]

vor 5 Minuten schrieb t1nk4bell:

Ich persönlich finde Installations/konfigurations klick Anleitungen/ Screens massiv überflüssig. 

Außer wenn was besonderes gemacht wird mit entsprechender Erklärung 

Ich sehe das auch so, 
Bei meinem Projekt habe ich den Fehler gemacht und wurde auch darauf angesprochen.
Dadurch war halt mein Anhang auch etwas länger als wie die "erlaubten" Seiten.
An deiner Stelle @tims1998 lass es einfach.

 

[xsunshinelight]

Ich habe auch eine Ubuntu VM für mein Projekt aufgesetzt und sitze gerade an der Doku.. ich packe es nicht rein. Evtl. dann als Bild irgendwie in die Präsentation, aber in der Doku schreibe ich nur was ich getan habe.

[charmanta]

das gehört auf jeden Fall nicht in den Hauptteil. Bei uns ist der Anhang nicht begrenzt und ich kenne solche Ergänzungen stets im Anhang.

[t1nk4bell]

Wenn es keine Begrenzung gibt kann man alles Reinklatschen:) also Anhang. War bei mir nicht der Fall , darum alles unwichtige weglassen.

[Dr. Octagon]

Man kann spezielle Installations-/Konfigurationsanweisungen aber auch als Teil des Projekts in Form "IT-Handbuch für nachfolgende Generationen" als gesonderten Teil (der Doku) - quasi als Anhang der besonderen Güte - ausgeben. Gilt insbesondere, wenn der reguläre Anhang nicht begrenzt ist (warum eigentlich begrenzen - kurzfassen bedeutet niemals, Wichtiges weglassen, was aber dadurch mitunter geschieht)?

Hinführung: Dokumentation wird in fast allen Betrieben sehr klein geschrieben... denn "dafür gibt es doch das Internet!?"

[houseshow]

Ich hatte meine „Klicki Bunti“ Anleitung/Dokumentation in den Anhang verfrachtet. War bei mir eine Anwender- und Administratordokumentation. Wenn es im Zusammenhang mit dem Projekt Sinn macht, spricht glaube ich nichts dagegen.

[IT Wikinger]

Also, wenn du einen Punkt in deiner Doku aufführst, dann beschreibst du den auch. Wenn es speziell ist und dementsprechend auch passt, kannst du beispielsweise bei Bildern oder ganz speziellem Text auf den Anhang verweisen (Begründung: du willst den Fließtext nicht erschweren...)

Anders sieht es aus, wenn ihr, beispielsweise in einem internen Wiki, ein festgelegtes Dokument oder sonst was, fixe Installationsanweisungen habt, die jeder Mitarbeiter i.d.R. zu befolgen hat. Dann kannst du, wenn du darfst, dass Anhängen und darauf verweisen, fertig ist der Lachs. Darfst du das von der Firma nicht, weil die nen Stock quer haben, dann schreibst du das halt (netter) in einem Satz und beschreibst es vielleicht grob.

Machst du es aber so, dann würde ich das schon erwarten, dass es dort erklärt ist, wo auch der Punkt in der Doku aufzufinden ist, da ich als Prüfer
A: Kein Bock hab die ganze Zeit hin und her zu Blättern
B: Ich nachvollziehen muss, wieso du das so gemacht hast und dafür eben die Beschreibung brauche. 
Ich habe dafür auch schon Punkte abgezogen bezüglich Form Einhaltung. Mach ich aber nicht pauschal..

Es kommt eben auf den einzelnen Fall an und kann nicht pauschalisiert werden. Wenn es logisch ist, warum, wieso & weshalb, ja. Wenn nein, dann eben nicht. Hoffe ich konnte dir damit weiterhelfen.

VG und viel Erfolg