Inhaltsverzeichnis Projektdokumentation

[rocket]

Hallo,

ist mein u.g. Inhaltsverzeichnis für die Projektdokumentation in Ordnung oder gibt es euerer Meinung nach daran etwas auszusetzen. Bitte um eure Kritik!

Hier ist meine Projektbeschreibung: Installation und WAN -Einbindung eines zusätzlichen Windows 2003 Domain Controllers in die bestehende Domäne mit Datensicherungs- und Virenschutzkonzept.

1. Einleitung

1.1 Die Firma

1.2 Das Netzwerk

1.3 Projektauftrag

1.4 Prozessschnittstellen

2 Projektplanung

2.1 Projektumfeld

2.2 Ist-Analyse

2.3 Zeitplanung

2.4 Soll-Konzept

3. Projektrealisierung

3.1 Installation und Konfiguration des Servers / Domänen Controllers

3.2 Auswahl der Software

3.3 Einrichten von Datensicherungs- und Virenschutzsoftware

3.4 Konfigurieren eines Backups

4. Testen

4.1 Domänenanmeldung von Client PC testen

4.2 Backup testen

4.3 Virenschutz testen

5. Übergabe / Abnahme

5.1 Soll / Ist Vergleich

6 Anhang

- Testprotokoll

- Kosten-Nutzen-Vergleich

- Übersicht über die Netzwerkstruktur der Firma “X“

- Liste der eingesetzten Hard- und Software

- Handbuch für den Administrator

7 Quellen

[MBaeuml]

Quellen gehören glaube ich vor den Anhang

[Shinak]

Mal ne andere frage noch bezüglich Inhaltsverzeichnis und Doku.

Wird das Inhaltsverzeichnis zu den 10 Seiten Doku dazu gerechnet oder beginnen die 10 Seiten nach dem Inhaltsverzeichnis?

Dann noch was wegen der Doku.

Ich habe von meiner IHK (Koblenz) hier "Infomationen zur Abschlussprüfung"

darin steht "Die Dokumentation soll zehn DIN A4-Seiten (Arial 11) plus Anlagen und Tabellen nicht überschreiten...

Auf Uli's Page steht was von groben Regeln:

Schriftgröße 10-12

1.5-zeilig

Fließtext, Blocksatz, Serifenschrift

Rand links 3.5 cm, rechts 2.5 cm

Mir geht es jetzt um den Blocksatz und den Zeilenabstand von 1.5.

Ich finde das der Text mit Blocksatzt teils sehr auseinander gezogen aussieht und mit dem 1.5 Zeilenabstand die Zeilen auch recht weit auseinander sind.

Sollte ich es trodem besser so bei behalten ?

[DjaDja]

Also Benutz grad schriftgröße 10-12 je nach wichtigkeit Überschrift bla blabla..

und Arial aber den 1,5 absatz hab ich net drin find das wirkt recht seltsam so auseinander gezert muss man das drin haben??

Die meisten Dokus die ich mir so angeschaut habe haben einen 1 Absatz

[Sandrin]

Ich finde das der Text mit Blocksatzt teils sehr auseinander gezogen aussieht und mit dem 1.5 Zeilenabstand die Zeilen auch recht weit auseinander sind.

Es liest sich aber einfacher. Wenn deine IHK das so haben will, solltest du das beibehalten.

[Shinak]

Naja bei meiner IHK steht darüber soweit ja nix drin ich hab das auf Uli's Page gelesen und hab es erst mal soweit übernommen.

[CyberDemon]

Original geschrieben von Shinak

Naja bei meiner IHK steht darüber soweit ja nix drin ...

Ich dachte, folgendes steht drin? :confused:

Original geschrieben von Shinak

Ich habe von meiner IHK (Koblenz) hier "Infomationen zur Abschlussprüfung"

darin steht "Die Dokumentation soll zehn DIN A4-Seiten (Arial 11) plus Anlagen und Tabellen nicht überschreiten...

Du solltest dich auf jeden Fall an die Vorgaben deiner IHK halten.

[Shinak]

Ja wieviel Seiten und welche Schriftgrösse schon aber nicht ob es 1,5 Zeilig sein soll und Blocksatz.

Und was ich noch nicht genau wiess ist ob die 10 Seiten das Inhaltsverzeichnis mit einbeziehen oder ob das noch ausen vor bleibt.

[Sandrin]

Dann ruf am besten bei deiner zuständigen IHK an, die werden dir das sagen können.

[Fachchaot]

Bei mir steht aber auch nix von Zeilenabstand drin. Nur Schriftart, Schriftgröße, das 10 Seiten nicht überschritten werden sollen und das die Doku gut lesbar sein soll.

[sYnTaxx]

hmm lol bei mir steht garnix... ^^ außer 10-15din a4 :-)

[timmi-bonn]

Original geschrieben von sYnTaxx

hmm lol bei mir steht garnix... ^^ außer 10-15din a4 :-)

Ich wäre da mal sehr vorsichtig. Gerade PAs / IHKn, die keine festen Format-Vorgaben machen, können sehr kleinkariert reagieren, wenn ein Prüfling von der, von ihnen als "normal" empfundenen, Standardeinstellung abweichen.

"Arial condensed 6 Punkt ohne Durchschuß" würde ich mir als Azubi im eigenen Interesse doch schon lieber verkneifen.

gruß, timmi

[sYnTaxx]

hmm die sollen mal nicht kleinkarriert sein... verwende verdana weils einfach schöner aussieht und schriftgröße 10 also das müsste denen doch reichen ich mein ich find so sieht das ganez schön und professionell aus...

wenns denen nicht passt dann weis ich auch nich... tuts mir dann halt leid...

[PibeY2k]

Original geschrieben von DjaDja

Also Benutz grad schriftgröße 10-12 je nach wichtigkeit Überschrift bla blabla..

und Arial aber den 1,5 absatz hab ich net drin find das wirkt recht seltsam so auseinander gezert muss man das drin haben??

Die meisten Dokus die ich mir so angeschaut habe haben einen 1 Absatz

Das auseinander gezerte bekommst du eventuell mit Silbentrennung weg.

Bei Word kann man das unter Sprache einstellen. Vielleicht hilfts!?

[timmi-bonn]

Original geschrieben von sYnTaxx

hmm die sollen mal nicht kleinkarriert sein... verwende verdana weils einfach schöner aussieht und schriftgröße 10 also das müsste denen doch reichen ich mein ich find so sieht das ganez schön und professionell aus...

wenns denen nicht passt dann weis ich auch nich... tuts mir dann halt leid...

Hier in Bonn wuerde Dir das dann tatsaechlich leid tun - anschliessend.

Wir schreiben 12 Punkt Schriftgroesse vor. Denn was soll die Vorgabe "15 Seiten", wenn das aufgrund der unterschiedlichen Schriftarten und -groessen dann doch nicht mehr vergleichbar ist? "Kleinkariert" kann ich das nicht finden. Ich sehe eher die Chancengleichheit dadurch gewahrt.

Was "schoen" aussieht und was nicht, das ist dann doch sehr individuell verschieden. Da sind sich selbst die Fachleute nicht letztendlich einig.

gruß, timmi

[CyberDemon]

Original geschrieben von timmi-bonn

Was "schoen" aussieht und was nicht, das ist dann doch sehr individuell verschieden. Da sind sich selbst die Fachleute nicht letztendlich einig.

Da gebe ich dir vollkommen recht! Die "Schönheit" einer Dokumentation sollte aber sekundär betrachtet werden. In erster Linie soll sie professionell aussehen und da eignet sich meiner Meinung nach Arial am besten.

Wenn aber keine konkreten Vorgaben gegeben sind, dann sollte man die IHK/ den PA solange nerven, bis man sie hat.

[Chipmunky]

Original geschrieben von Shinak

Mal ne andere frage noch bezüglich Inhaltsverzeichnis und Doku.

Wird das Inhaltsverzeichnis zu den 10 Seiten Doku dazu gerechnet oder beginnen die 10 Seiten nach dem Inhaltsverzeichnis?

Es werden nur die Seiten mitgezählt, die nach dem Inhaltsverzeichnis sind, also wirklich nur dein geschriebener Text. Anhang, Inhaltsverzeichnis und Deckblatt gehören nicht dazu.

Zu den Quellen, gehören die nicht sogar in den Anhang rein?

[diana]

Hallo,

Quellen, Literaturverzeichnis, Glossar und Abbildungsverzeichnis gehören in die eigentliche Dokumentation. Vergesst diese Dinge nicht;)

[carstenj]

Nicht, dass ich einer Frau widersprechen würde . Aber woher weisst du das so genau? Offensichtlich herrscht hier ja keine so 100%ig Einigekeit darüber.

[MBaeuml]

Original geschrieben von carstenj

Nicht, dass ich einer Frau widersprechen würde . Aber woher weisst du das so genau? Offensichtlich herrscht hier ja keine so 100%ig Einigekeit darüber.

öhm ja, weil man das halt so macht:D

steht doch überall(Bücher, Webseiten) das erst die ganzen Punkte wie Ist-Analyse, Soll-Konzept, Realisierung, Test & Abnahme und Resumee kommen, danach dann evtl. Abbildungsverzeichnis, Glosar und Quellenangaben. Das ist die Dokumentation. Alles andere wie z.B. ein Benutzerhandbuch, Rechnungen, Angebote gehören in den Anhang.

[hellspawn79]

Nun will ich auch mal . Was ist zu meiner Gliederung zu sagen??

Bereich: FI/AE.

Thema: Softwareintegration in eine Portalsoftware

Derzeitiger Umfang der Doku 8 Seiten + Anhang.

Schrift: Arial 10

I Inhaltsverzeichnis

1 Projektumfeld

2 Ist-Analyse

2.1 Projektziel

3 Projektplanung

3.1 Zeit und Ablaufplanung

4 Projektrealisierung

4.1 Erstellen eines Programmablaufplans

4.2 Konzeption / Erstellen der Klassen

4.3 Entwurf / Erstellen der Seitenansicht

4.4 Einbinden des Moduls in das Portal

5 Funktionstest

6 Projektübergabe an die Fachabteilung

I Glossar

1 Literaturverzeichnis

2 Abkürzungsverzeichnis

3 Abbildungsverzeichnis

4 Benutzeranweisung

5 Auszug aus dem Quellcode

6 Testbericht

7 Schnittstellenspezifikation

[Borges]

Original geschrieben von hellspawn79

Nun will ich auch mal . Was ist zu meiner Gliederung zu sagen??

...

2 Ist-Analyse

2.1 Projektziel

3 Projektplanung

3.1 Zeit und Ablaufplanung

4 Projektrealisierung

...

Standardfehler:

-Untergliederungen verlangen mindestens zwei Unterpunkte.

-Ich hoffe, gleichwertiger Inhalt ist nicht auf verschiedene Gliederungsebenen verteilt (z.B. 2 und 2.1, 3 und 3.1)

-Keine nackten Schlagwörter als Überschriften

Die Suchmaschine Deiner Wahl findet für Dich viele Hinweise, wie Gliederungen auszusehen haben. Auf fast jedem Uni-Server findet man entsprechende Merkblätter.

Gruß,

Borges

[hellspawn79]

Original geschrieben von Borges

Standardfehler:

-Untergliederungen verlangen mindestens zwei Unterpunkte.

...

OK das seh ich soweit ein, 2 und 2.1 muss ich mir was überlegen, bei 3 kommt noch ein zweiter Unterpunkt hinzu, aber..

Original geschrieben von Borges

-Keine nackten Schlagwörter als Überschriften

...

was sollte ich stattdessen schreiben?? Ist-Analyse erstellen??