Vorläufige Doku (50% fertig) - bitte um Bewertung oder Kritik

[zeiman]

Hallo!

Habe letztes Jahr eine Doku zu Trainingszwecken zur Hälfte erstellt und würd gern eure meinung hören ob man so eine Dokumentation über Firewalls machen könnte. Ich mache jedoch ein anderes Thema...

Jede Kritik erwünscht!

MfG

Realisierung einer Linux.doc

Bearbeitet 21. Mai 2008 von zeiman

[SoL_Psycho]

Ah ok, jetzt hab ichs auch verstanden

Hmm ja, also ich finds i.O., aber bin kein Prüfer

Bearbeitet 21. Mai 2008 von SoL_Psycho

[zeiman]

Habs anders formuliert

[zeiman]

Meinst sollte man noch mehr auf die Techniken an sich eingehen, oder kommts im Endeffekt bei der Doku drauf an wie und warum man was macht?

Quasi, wie was funktioniert wird dann beim Ausfragen geprüft? z.B. ACL's...

[SoL_Psycho]

NIEMALS "Ich" schreiben in der Doku

Vorweg ist zu sagen dass Begriffe die Sie im Glossar Nachschlagen können mit [eckigen Klammern] geschrieben werden

Ebensowenig jemanden direkt ansprechen, lieber:

"Begriffe in eckigen Klammern können im Glossar nachgeschlagen werden"

Zum Inhalt kann ich dir nicht viel mehr sagen, da ich FIAN bin und wenige Fisi Dokus bisher bis zum Ende ausgehalten habe

[Navy]

Jede Kritik erwünscht!MfG

Dann mal los:

- um eine neue Seite zu beginnen solltest Du einen Seitenumbruch einfügen und *nicht* so viele Zeilenumbrüche erstellen bis eine neute Seite beginnt

- das Inhaltsverzeichnis sollte automatisiert erstellt worden sein und auf keinen Fall manuell so wie Du es gemacht hast. Nutze dafür die Formatvorlagen für Überschriften, Abschnitte usw.

- Das Deckblatt hat im Normalfall keine Kopf- und Fußzeile, die Seitennummerierung entfällt hier ebenso

- Die Seitennummerierung für Verzeichnisse (Inhalts-, Tabellen-, und Abbildungs-) sollten sich von der laufenden Nummeriung des Dokumentenkörpers unterscheiden

- Die Indizierung der Überschriften sollten keinen abschließenden Punkt haben: (1 Analysephase, 1.1 Projektvorfeld, etc), bei Dir ist das zudem inkonsistent

- eher beiläufig: zwischen 2 Überschriften egal welcher Hirachie sollte (nicht muss) immer Text stehen - siehe "Planungsphase" <-> "Erstellen einer Entscheidungsmatrix [...]"

- Versuche so wenige Linien wie nur möglich in Tabellen unterzubringen, sie stören eher als das sie helfen, ebenso brauchst Du in markante Zellen nicht fett schreiben /und/ sie farbig markieren - verwende nur eines der Beiden

- Die Spalten in den Tabellen sollten konsistent ausgerichtet sein, Überschriften nicht getrennt zentrieren und den Rest dann recht- oder linksbündig setzen, ausgenommen davon sind Zahlen, Werte oder Größen

- Benenne Deine Tabellen

- Die Rechtschreibung überarbeiten (flüchtig aufgefallen: "Netzwork")

Ich hab einfach mal zusammengefasst was mir in 5 Minuten ansehen aufgefallen ist. Da ich OpenOffice verwende kann es natürlich sein, dass Du Formatierungen vorgenommen hast, die OO dann zerschießt, so dass etwaige Punkte oben nicht mehr zutreffen.

[Gast freescale]

Für den Praxisteil der Dokumentation finde ich das ganz gut, aber ich vermute das könnte Punktabzug geben da viele andere Themen nicht angesprochen sind.

Hab' dir mal mein eigenes Inhaltsverzeichnis angehängt (feel free to copy, share, etc...), da stehen alle Punkte drin.*

Deine Dokumentation würde dann glaub ich Punkt 3.2 in meiner entsprechen.

* kein Anspruch auf Vollständigkeit

inhaltsverzeichnis.pdf

[zeiman]

oioi. is ja ganz schö viel - ich les mich mal durch und meld mich :old

[zeiman]

@ Navy:

Das Deckblatt hat im Normalfall keine Kopf- und Fußzeile, die Seitennummerierung entfällt hier ebenso

wie macht man das in Word?

@ freescale:

Für den Praxisteil der Dokumentation finde ich das ganz gut, aber ich vermute das könnte Punktabzug geben da viele andere Themen nicht angesprochen sind.

was hast du gelernt? ich bin FISI.

[SoL_Psycho]

wie macht man das in Word?

Das kannst du machen, indem du deine Doku auf drei Dokumente verteilst (Deckblatt, Doku, Anhang), oder mit Abschnittswechseln beispielsweise

Bearbeitet 25. Mai 2008 von SoL_Psycho

[zeiman]

Hehe, joa. so hätt ich das auch gemacht...

:upps ich dachte da gibtsn button in word...

[zeiman]

v2 im anhang wers sehn will... ich mach dann mal weiter... :old

Realisierung einer Linux.doc

[xkillax]

Hey,

also bei mir ist die Formatierung ziemlich durcheinander, liegt wohl am Word

Was mir gleich als erstes Auffiel sind die vielen Rechtschreib, Grammatik und Formulierungsfehler! Da auf jedenfall nochma drüber schauen und am besten jemand anderen Querlesen lassen (Ausbilder, Chef usw)

Dann würde ich die Budgetberechnung mit in die Planung nehmen...

Außerdem könntest du deine Azubi-Identnr. noch oben in die Kopfzeile schreiben, ist aber geschmackssache!

Für dein Titelblatt/Bild solltest du dir noch eine passende Grafik suchen oder eine Erstellen, z.B mit Visio

Das Wort "Projektvorfeld" würde ich ersetzen, evtl IST-Analyse oder IST-Zustand..

Evtl. deinen Ausbildungsbetrieb vorstellen bzw. die Firma in der das Projekt durchgeführt wurde.

Du musst außerdem die Bescheinigung für dein Projekt noch (am besten vorm Inhaltsverzeichnis) einbinden.

Ich weis nich wie das bei euch FIAE ist, aber bei mit als ITSE musste auch min. eine Überprüfung stattfinden z.B der Netzwerkleitungen.

Ich würd außerdem deine Ausgewählte Software noch einmal genauer vorstellen!

So wars erstmal alles sehr ungeordnet

Ich hoffe das hilft dir vll.!

PS: Ich würde dir Raten parallel schon mal mit dem Anhang anzufangen

Bearbeitet 26. Mai 2008 von xkillax

[Gast freescale]

@zeiman

Ich bin (war) FIAE.

Außerdem könntest du deine Azubi-Identnr. noch oben in die Kopfzeile schreiben, ist aber geschmackssache!

Dies war bei mir (IHK Darmstadt) explizit gefordert...

(der Smiley, da bei den ganzen Pflichtangaben - Name, Prüf-Nr, Ausbildungsberuf, Abteilung, Firma mit Anschrift + Tel, Ansprechpartner, Gesamtprojektleiter, Durchführungszeitraum mit Tel das Deckblatt einfach nur noch... hm.. sehr bescheiden... aussah)

[zeiman]

Hallihallo!

Also Doku ist weg, ich werd wenn ich mal Zeit hab das Ganze nach der Prüfung zum Download stellen (Falls sie gut bewertet wird ;-)) Is 30MB groß. deshalb hier auch kein Anhang...

Vielen Dank noch an alle die mir geholfen haben!