Wie viele Befehle in die Doku? (FISI)

[Promeier]

Moin Leute, ich schreibe gerade an meiner Projektdoku zum Thema "Installation und Konfiguration eines ITAM-Systems" und befinde mich gerade bei der Beschreibung der Durchführung.  Über VMware vSphere habe ich eine VM erstellt und auf dieser dann einen Ubuntu Server installiert/eingerichtet. Bevor ich die ITAM Software installiert hatte, musste ich noch den LAMP Stack installieren und dazu waren einige Befehle notwendig. 

Meine Frage ist nun, ob ich nun jeden Befehl in der Beschreibung der Durchführung angeben muss, oder können die in dem Glossar landen oder kann ich per Querverweis auf die Befehle mit Bildern im Anhang verweisen? Möchte eigentlich nicht, dass die Beschreibung mit Befehlen "vollgestopft" wird.

VG

Bearbeitet Sonntag um 15:06 von Promeier

[Earl Hickey]

Befehle haben nichts in der Doku zu suchen. Wenn dann maximal als Anhang falls diese wirklich aus deiner Sicht erforderlich sind.

[Promeier]

Also sollte ich diese auch wenn ich die in den Anhang packe, eher auf ein Minimum beschränken?

[Earl Hickey]

Immer getreu dem Motto so wenig wie möglich aber so viel wie nötig Ich kenne deine Doku und deinen PA nicht. Daher, mach dir da deine Gedanken, was benötigt der PA um aus der Dokumentation heraus festzustellen dass du für den Beruf geeignet bist (Stichwort "Berufliche Handlungsfähigkeit" ).

 

[t1nk4bell]

Stell dir die Perspektive der Prüfer vor . Du machst x und y , wozu erklären mit welchem Befehl du das machst, außer es gäbe da eine Stelle wo man sagt ich habe Befehl xy benuzt statt yx weil .... ( Falls es irgendwas besonderes ist ) 

Ich hatte z.b an einer Stelle eine File Server Migration über ein grafisches robocopy tool da Copy für diesen Fall viel mehr Zeit gefressen hätte. 

Das aber auch nur kurz angeschnitten beim namens glossar in dem der Name der gui stand.

Du würdest sonst auch je nachdem was du so machst Seitenweise Befehle haben ... Das interessiert niemandem denke ich 

Bearbeitet Montag um 08:26 von t1nk4bell