Wie genau Inhalt ausführen?

[aggrop]

Hey,

ich frage mich, wie genau ich den Inhalt der Dokumentation ausführen soll? Ich verfasse unter anderem die Installation eines SQL Servers. Gehört jeder einzelne Klick dokumentiert + Bild im Anhang? Oder reicht es die für mich "wichtigsten" Punkte der Installation aufzuführen?

Genauso in der Konfiguration eines (in meinem Fall) Netzwerkmanagementsystems. Ich greife per Weboberfläche darauf zu und kann bspw. über Reiter wie System -> Operator Management -> Operator User hinzufügen. Muss das so ausführlich  (System -> Operator Management -> Operator) geschrieben werden, bzw. Bilder davon festgehalten werden?

Mein Ausbilder sagt, JEDER Klick muss festgehalten werden.. Aber ich bin mir nicht sicher ob das wirklich so stimmt?

 

Danke und Grüße

[mapr]

Du musst nicht jeden einzelnen kleinen Klick dokumentieren.
Die "wichtigsten" Punkte reichen (ich glaube, dass jeder der Prüfer weiß, wie ein Server installiert wird).
Auch beim Netzwerkmanagementsystem musst du nicht jeden kleinen Schritt festhalten.

[stefan.macke]

Ich würde den kostbaren Platz in deiner Doku besser für die Dinge nutzen, die deine fachlichen Fähigkeiten unter Beweis stellen. Klickorgien mit 15 Seiten Screenshots sind keine ausreichende Projektarbeit. Du musst dein methodisches Vorgehen zeigen, deine Entscheidungen begründen, die Wirtschaftlichkeit berechnen, das System mit üblichen Diagrammen dokumentieren, Anbieter vergleichen, Tests durchführen usw. Es gibt so viele spannende Inhalte, die du in der Doku unterbringen kannst. Bitte spar dir die "Installationsanleitungen" bzw. reduziere sie auf ein Minimum.

Ich vergleiche das mal mit einem Anwendungsentwickler: Wenn der mir auf 3 Seiten detailliert eine for-Schleife beschreibt, weiß ich, dass das Projekt kaum Substanz hat. Für die Projektdoku sind z.B. eher die architekturellen Entscheidungen interessant, also das große Ganze. Die trivialen Details kleiner Algorithmen haben in einer Doku meiner Meinung nach nichts verloren.

Um es wieder in deinen Kontext zu setzen: Anstatt detailliert zu zeigen, wie du einen Installationswhizard durchklickst, solltest du lieber schreiben, warum du diesen überhaupt nutzt. Wieso wurde dieses Tool überhaupt ausgewählt? Welche Vor- und Nachteile hat es? Welche Alternativen wurden aus welchen Gründen ausgeschlossen?

Was soll ich als Prüfer bewerten, wenn du mir eine "Klickorgie" zeigst? Dass du gut auf "Ok" klicken kannst? Das kann bereits ein Azubi im 1. Lehrjahr ohne Nachzudenken. Nach 3 Jahren Ausbildung solltest du darüber hinaus sein und stattdessen Entscheidungen auf höherem Niveau treffen können. Zu deinem konkreten Beispiel: Welche Rollen gibt es überhaupt in deiner Software? Warum wird ein "Operator" angelegt? Welche Rechte muss/darf er haben? Welches grundlegende Authentifizierungs- und Autorisierungskonzept wird verwendet und warum? Wird das Tool an einen Verzeichnisdienst angebunden und warum (nicht)?