Allgemeine Fragen zu Dokumentation

[MidnightRun]

Hallo,

ich muss Ende des Jahres mein Projektantrag abschicken und komme dann somit in die heiße Phase meiner Ausbildung. Ich habe bereits ein paar gute Projektideen die mal etwas anderes sind als die typischen Zeiterfassungsprojekte die ich oft sehe.

Mein Hauptaugenmerk ist aber zurzeit die Dokumentation selber. Ich habe schon von AE gehört das sie mit einer 4 bestanden hatten weil ihre Dokumentation falsch war.

Der eine hatte ein Handbuch, keine Dokumentation geschrieben. Und viele andere Geschichten.

Mit einer sehr kompetenten Lehrkraft hatte ich ein längeres Gespräch über die Schlussphase der Ausbildung. Diese ist/war auch im IHK Ausschuss und mir wurde nahe gelegt das es eine "fleiß" Aufgabe ist.

Ich selbe stelle mir meine Dokumentation etwas moderner vor. Schöne Grafische Elemente und ein lockerer Schreibstil.

Wir haben nun aber letzte Woche Referate machen müssen und ich habe eben meinen lockeren Schreibstil dort verwendet.

Der Lehrer meinte nur das mein Referat toll ist aber ich in der Abschlussphase darauf achten sollte nicht diesen "Märchenstil" einsetzen sollte. Da man dafür Punkte abgezogen bekommt.

Er meinte es soll eine ernste nüchterne Ausarbeitung sein.

Nun ist meine Frage wie nüchtern muss so eine Dokumentation sein ? Ich selber finde Texte viel interessanter in denen komplexe Sachverhalte mit einem witzigen Bild erklärt werden anstatt trocken drum rum zu reden.

In meinem Referat hatte ich auch selbergezeichnete Figuren, nicht besonderes, die den CPU darstellen sollten bei der Arbeit.

Ausserdem bin ich mir noch nicht sicher welches Programm das richtige für mich ist für die Doku. Ein Lehrer meinte das wenn man es in LaTex machen würde man schonmal ein paar Pluspunkte haben "kann" etc.

Über Links wie eine Dokumentation am besten aussehen würde oder Vorschläge von euch würde ich mich freunen.

Auch über Anregungen

Danke!

[mapr]

Hallo,

im Normalfall ist eine nüchterne und sachliche Ausarbeitung (natürlich wo sinnvoll mit Grafiken) gewünscht.

Der von dir beschriebene Stil mag zwar noch für ein Referat gut sein, um die beschriebenen Dinge anschaulich zu erklären, aber meiner Meinung nach für die/eine Doku ungeeignet.

[MidnightRun]

Hey,

danke für deine Antwort. Natürlich will ich super locker schreiben aber auch manchmal abstrakte Beispiele nennen um es besser zubeschreiben.

Am Layout würde ich mich hieran gerne Orientieren :

Sample Chapter

Auch Grafike etc. finde ich ganz gut. Ist das auch too much ? Ist wirklich eine monotone Schwarz/Weiss alles super trockner Schreibstil Doku gewünscht ?

Bearbeitet 16. September 2010 von MidnightRun

[mapr]

Der Link funkioniert nicht.

Du kannst auch eine Antwort posten und die Datei mit anhängen.

Ich kann nur von meiner Doku ausgehen, da ist alles sachlich, nicht monoton, beschrieben und ich hab ne 2 drauf bekommen. Wenn du die pdf-Datei nochmal postest schau ich sie mir mal an und dann sehen wir weiter.

[MidnightRun]

So,

Link gefixt.

Du hast eine 2 bekommen ? Das hört sich schonmal gut an. Weisst du woran es lag wieso es nicht noch besser war ? Also irgendwelche Anmerkungen von den Prüfern ?

Danke

[mapr]

Ok, schau mir die Datei mal an und meld mich später wieder.

Kann dir leider nicht sagen, woran das mit der Doku genau gelegen hat.

Habe keine Anmerkungen von den Prüfern bekommen.

Das einzige was ich weiß, war ne Grafik mit einem kleinen Fehler.

[mapr]

So, da bin ich wieder.

Ging schneller als gedacht mit dem durchschauen (habs auch nur überflogen).

Wenn du das so in etwa schreiben würdest wie in der Datei finde ich das durchaus ok.

Mich hat am Anfang auch deine "selbstgezeichnete Grafik" für den Prozessor n bißchen "geschockt". Ich denke mal, gegen eine solche Grafik wird evtl. keine PA was haben. Könnte die Sache vielleicht sogar n bißchen auflockern. Aber halt nicht übertreiben damit. Wie schon gesagt eher sachlich mit schönen Screenshots.

[hmaas]

Auch Grafike etc. finde ich ganz gut. Ist das auch too much ? Ist wirklich eine monotone Schwarz/Weiss alles super trockner Schreibstil Doku gewünscht?

Das vorgestellt Layout ist doch für ein Buch gedacht, ob das in einer 15-Seitigen Doku benötigt wird? Zumal du viel Platz durch die Formatierung verliest (was ja bei dem ein oder anderen evtl. sogar gewünscht ist).

Das ein Programm plus Punkte bringen soll ist wohl auch eher ein Gerücht, woran soll der Prüfer das denn erkennen? Nutzte ein Programm, dass du kennst und mit dem du umgehen kannst, während der Dokumentation noch mal eben LaTex lernen bringt dich nicht zwingend zum optimalen Ergebnis, da du deine Zeit/Energien teilen mußt.

Viel wichtiger als das Layout ist der Inhalt der Prüfung.

Es sollen auch keine Märchenstunden bzw. Beschreibungen ala "Mein schönstes Ferienerlebnis" erstellt werden, sondern du sollst dein Vorgehen und deine Entscheidungen begründet darlegen. Es muss eine gute Strucktur haben, einen roten Faden aufweisen und das Projekt in all seinen Phasen darstellen.

Wenn du mit Bildern/Grafiken sinnvoll das Geschrieben visualisieren kannst, machen diese sinn. Nur als Schmuck sind sie überflüssig.

Du schreibst leider deine IHK nicht ins Profil, aber die IHKs geben eigentlich genügend Hinweise was/wie bewertet wird:

IHK Aachen eher allgmein (2.2.3)

IHK Düsseldorf mit dem Bewertungsbogen

Aus dem Düsseldorfer Bewertungsbogen geht deutlich hervor das das Layout/Schreibstil maximal mit 15% (diese verteilen sich aber auf 5 Punkte) bewertet wird.

Da sieht man sehr schnell, worauf es wirklich ankommt.

Gruß Pönk

Bearbeitet 16. September 2010 von Pönk

[MidnightRun]

...

Gruß Pönk

Danke für deine Ausführliche Info. Meine IHK Standort ist Hannover. Muss mich mal schlau machen ob es da auch sowas gibt.

Der Lehrer der LaTex als Pluspunkt erwähnte war vor einigen Jahren noch IHK Prüfungsmitglied, deswegen auch der Gedankengang.

[JGlueck]

Der Lehrer der LaTex als Pluspunkt erwähnte war vor einigen Jahren noch IHK Prüfungsmitglied, deswegen auch der Gedankengang.

Wie bereits gesagt, wie will er denn am Ende, wenn er eine PDF oder eine gedruckte Ausgabe vor sich liegen hat, ausmachen, auf welche Art und Weise die Dokumentation erzeugt wurde? Du verdienst dir aber sicher Zusatzpunkte, wenn du es in der Dokumentation erwähnst (ein- bis zweimal pro Seite sollte ausreichen, um deine Fachkenntnis zu unterstreichen).

Und bitte: Die Dokumentation deiner betrieblichen Abschlussarbeit ist keine witzige Angelegenheit. Wenn du später mal für einen Kunden eine Dokumentation schreibst, erwartet der vermutlich auch eine zielgruppengerechte und damit sachliche Schreibweise.

Eine meiner Meinung nach recht gute Seite zu dem Thema findest du hier. Ich hab mich daran gehalten und bin damit sehr gut gefahren.