[OP] Allgemeine Doku Fragen

[Static]

Hallo mal wieder,

aufgrund der Übersicht habe ich einen neuen Thread erstellt. Vor einigen Tagen habe ich mit dem Schreiben der Dokumentation begonnen, komme aber nicht wirklich voran da ich mir selbst im Weg stehe oder nicht weiß ob ich die Doku richtig schreibe.

 

1. Schreibstil: Ich habe 2 zum OP passende Dokus vorliegen an denen ich mich etwas orientiere. Vom Schreibstil her kann ich allerdings nicht mithalten wobei ich den Stil der anderen Dokus als sehr gut empfinde. Meine Sätze klingen für mich abgehakt und sind dementsprechend kurz. Inhaltlich, denke ich, kann ich trotzdem alles irgendwie verpacken. Nur lese ich dann über die Texte und denke mir jedes mal dass da irgendwas fehlt oder die Formulierung schlecht ist. Das hemmt mich in meiner Kreativität und kostet mich unnötig Zeit. Nun habe ich mir schon meine Ausbildungsabschlussdoku als Inspiration genommen, die ich wie jetzt auch aus freien Stücken verfasst habe und am Ende sogar mit 90 Punkten bestanden habe.

Muss ich mit großen Punkteinbußen rechnen aufgrund meines eher sem-iprofessionellen Schreibstils?

 

2. Komplexes System vorher erklären: Thema des Projektes ist die Wartung und Inbetriebnahme von Hard- und Software innerhalb eines Serververbundes. Der Verbund hostet eine Software die aus mehreren Modulen besteht. Die Software und den gesamten Verbund zu erklären würde den Rahmen sprengen und ist nicht relevant da nur bestimmte Server des Verbundes gewartet werden. Nun überlege ich noch, ob ich einen gesonderten Punkt in der Einleitung einfüge mit dem Namen "Kurzerklärung und Aufbau des Verbundes" in dem ich grob aber möglichst verständlich den Aufbau des Verbundes erkläre (auch Server die nicht im Projekt gewartet werden) oder ob ich noch kürzer im Punkt "Ist-Zustand" (Projektinitialisierung) einbinde und damit nur ganz kurz die Funktion der Software erkläre, die Anzahl der Server im Verbund nenne und in der richtigen Ist-Analyse nur auf die von der Wartung betroffenen Server genauer eingehe.

 

3. Wertung in der Ist-Analyse: Passend zu Punkt 2 hakt es auch etwas in der Ist-Analyse. Ich hatte gelernt dass in der Ist-Analyse keine Wertungen vorkommen sollen. Das ist allerdings nur schwer realisierbar da ich ja eine Begründung einfügen muss? Bspw. ist Server 1 unterdimensioniert bestückt. Meine Begründung: "Die Last liegt bei 90% was auf die speicherhungrige Software zurückzuführen ist.". Speicherhungrige ist nur ein Füllwort, Umgangssprache wird ja auch nicht gerne gesehen. Ist mein Beispiel bereits eine Wertung so dass ich nur aufnehmen muss, dass die RAM Auslastung zu hoch ist?

 

4. Schreibweise zweistelliger Zahlen: Ich hantiere immer wieder mit Zahlen zwischen 50 und 200. Soweit ich weiß sollen Zahlen ausgeschrieben werden. Bei fünfzig ist das kein Problem aber Einhundert sechsundachtzig empfinde ich als etwas merkwürdig. Gibt es dafür eine Regel seitens IHK?

 

5. Zeitform Präsens: Dokus sollen in Präsens geschrieben werden. Nun habe ich bspw. diesen Satz: "Mithilfe einer Monitoring-Software wurden/werden die
durchschnittlichen Lastwerte des Datenverkehrs ausgelesen.". Ich würde gerne "wurden" nehmen da die Werte weit vor dem eigentlichen Projekt ausgelesen wurden.

 

Grüße

Static