Genauigkeit der Projektdokumentation

[whoami312]

Hallo zusammen,

 

da dies mein erster Eintrag ist, stelle ich mich kurz vor:

Mein Name ist Nico, ich arbeite bei einer Firma mit ca. 1300 Mitarbeitern in Deutschland, Österreich und Italien.

Wir haben eine interne IT-Abteilung welche an einem Standort für alle anderen Standorte zuständig ist.

Ich bin seit 2018 als Azubi (FISI) in dem Unternehmen tätig. Die Ausbildung erfolgt in einem Standort in Oberbayern.

Derzeit schreibe ich meine Projektdokumentation, jedoch kommen bei mir einige Fragen auf.

Warum ist die Anzahl der Seiten für die Projektdokumentation auf 20 Seiten festgelegt? Was passiert wenn die Doku z.B 25 Seiten umfasst?  Eine wirkliche Dokumentation hat meiner Meinung nach mehr als 20 Seiten, vor allem mit Screenshots, genauen erklärungen etc.

Wie geanu muss die Dokumentation ins Detail gehen? Bei meinem Projekt muss ich unter anderem einen Stack (3 zusammen hängende Switches)  einrichten, muss ich dort jeden Klick sozusagen erläutern? Wenn ich z.B anfangs erläutert habe dass ich mich nun am Switch anmelde mit bestimmten Zugangsdaten, den Swtich neu starte, muss dann auch in meiner Doku stehen dass ich wieder die Zugangsdaten eingebe?

 

Über eine hilfreiche Antwort würde ich mich sehr freuen.

 

Lg und eine schöne Woche euch

[Listener]

vor 6 Minuten schrieb nico.pf:

Eine wirkliche Dokumentation hat meiner Meinung nach mehr als 20 Seiten, vor allem mit Screenshots, genauen erklärungen etc.

Sowas gehört nicht in die Projekt- sondern in die Kunden-/Anwenderdokumentation. 

vor 7 Minuten schrieb nico.pf:

Wie geanu muss die Dokumentation ins Detail gehen? Bei meinem Projekt muss ich unter anderem einen Stack (3 zusammen hängende Switches)  einrichten, muss ich dort jeden Klick sozusagen erläutern? Wenn ich z.B anfangs erläutert habe dass ich mich nun am Switch anmelde mit bestimmten Zugangsdaten, den Swtich neu starte, muss dann auch in meiner Doku stehen dass ich wieder die Zugangsdaten eingebe?

S.o.

Wenn ihr in der Berufsschule nicht gelernt habt, wie die Projektdokumentation aussehen soll, kannst du hier im Forum oder auf der Website von Stefan Macke nach Beispielen Ausschau halten. 

 

[Chief Wiggum]

Mahlzeit,

du sollst in der Doku nicht in einer Art Comic darstellen, was du wann wie geklickt hast sondern das WARUM.

Sprich: nicht beschreiben, durch welche Einstellungen du dich genau durchhangelst, sondern Warum und zu welchem Zweck du welche Einstellungen setzt.

[SR2021]

Wichtig zu wissen, du sollst das WIE ( Projekt ) dokumentieren, nicht das Produkt ansich.

[charmanta]

vor 21 Minuten schrieb nico.pf:

Warum ist die Anzahl der Seiten für die Projektdokumentation auf 20 Seiten festgelegt? Was passiert wenn die Doku z.B 25 Seiten umfasst?  Eine wirkliche Dokumentation hat meiner Meinung nach mehr als 20 Seiten, vor allem mit Screenshots, genauen erklärungen etc.

Das hat Deine IHK in der Prüfungsordnung so beschlossen. Eine Abweichung von mehr als 10% führt zur Abwertung der Doku.

Die Seitenanzahl bezieht sich NUR auf das Projekt selbst, etwaige Benutzer- oder Admindok sowie Screenies, die NICHT zum Verständnis des Projekts gehören, kommen in den Anhang und werden nicht gezählt

[treffnix]

vor 9 Minuten schrieb SR2021:

Wichtig zu wissen, du sollst das WIE  WARUM dokumentieren

Habe es mal korrigiert..  

[Bitschnipser]

vor 10 Minuten schrieb charmanta:

Die Seitenanzahl bezieht sich NUR auf das Projekt selbst, etwaige Benutzer- oder Admindok sowie Screenies, die NICHT zum Verständnis des Projekts gehören, kommen in den Anhang und werden nicht gezählt

NICHT bei der IHK Muc und OBB! Sinngemäßes Zitat vom IHK-Mitarbeiter auf meine Nachfrage ob eben obiges gilt: "Die GESAMTE PDF die hochgeladen wird, darf 20 Seiten umfassen"

[MazzeGO]

Es kommt auf das Thema an wie umfangreich eine Doku sein kann oder nicht sein kann. Mach dich nicht verrückt, erfülle die Vorgabe innerhalb der 10% Toleranz und alles ist gut. Hinterfrage es nicht, es ist so vorgegeben, daran änderst du nichts und verschwendest nur unnötige Lebenszeit.

[charmanta]

vor 50 Minuten schrieb Bitschnipser:

NICHT bei der IHK Muc und OBB! Sinngemäßes Zitat vom IHK-Mitarbeiter auf meine Nachfrage ob eben obiges gilt: "Die GESAMTE PDF die hochgeladen wird, darf 20 Seiten umfassen"

deswegen sage ich "seine IHK" ... bei uns in Deutschland sinds 10 Seiten plus Anhang

[whoami312]

Hallo Zusammen, vielen Dank euch für eure Antworten. Ich werde meine Dokumentation überarbeiten.

Habe jedoch noch die folgende Frage.

Bei meinem Projekt muss ich einen Stack einrichten mit Priority Member 1, 2 etc. Muss ich dann die Befehle (z.B wie ich bestimmte Ports ausschalte) dann gar nicht mehr mit rein nehmen?

Wenn doch, reicht als "Warum" sozusagen wenn ich allgemein schreibe warum ich einen Priority Member einrichte oder muss jeder Befehl sozusagen ein Warum enthalten?

[charmanta]

das WARUM gehört in die Doku. Das DETALLIERTE WIE in den Anhang ...

Du begründest das Projekt bzw enthaltene Entscheidungen. Ohne das Projekt zu kennen ( oder kennen zu dürfen ) halte ich eine einzelne Begründung pro Befehl für grundsätzlich nicht nötig