Projektdoku gliederung

[mhanel]

Ich mache ein internes Projekt zum logging der angemeldeten Benutzer

der Internet Applikation meiner Firma.

Ich hab hier mal meine Gliederung reingestellt. Wäre echt

super, wenn ihr mir sagen könntet, was ihr davon haltet.

Meine Doku ist ausserdem voll von UML-Diagrammen.

Im Anhang findet sich bis auf die javadoc's nichts.

Ich habe ausserdem meine komplette Anforderungsspezifikation

in die Doku aufgenommen.

Die einzelnen Teilkapitel sind teilweise sehr mickrig geraten.

Was haltet ihr davon?

Inhaltsverzeichnis

1 Einleitung

1.1 Unternehmensbeschreibung

1.2 Die Anwendung chainNet®

1.2.1 Anwendungsbereich

1.2.2 Architektur

1.3 Projektvergabe

2 Analyse

2.1 Grobkonzept

2.1.1 Ist-Zustand

2.1.2 Soll-Analyse

2.2 Projektplanung

2.3 Verantwortlichkeiten

2.4 Anforderungsspezifikation

2.4.1 Einzelanforderungen

2.4.1.1 Am System anmelden

2.4.1.2 Präsenzmeldung der Client-Applikation

2.4.1.3 Vom System abmelden

2.4.1.4 Umanmelden

2.4.1.5 Fehlerfälle

2.5 Qualitätsmerkmale

2.6 Abnahmefälle

2.6.1 Benutzer löschen

2.6.2 Applikationsserver nicht erreichbar (Leitungsunterbrechung)

2.6.3 Applikationsserver abschalten

2.6.4 Datenbank nicht erreichbar

2.6.5 Datenbank abschalten

2.6.6 Werte Testen

2.7 Aktivitäten

2.7.1 Am System anmelden

2.7.2 Vom System abmelden

2.7.3 Umanmelden

2.7.4 Präsenzmeldung der Client-Applikation

3 Entwicklung

3.1 Vorraussetzungen

3.2 Datenbankdesign

3.3 Klassenentwurf

3.3.1 Client-Applikation

3.3.2 EJB

3.3.3 Programmablauf

3.4 EJB Konfiguration

4 Projektabnahme

5 Verwendete Software

6 Glossar

7 Quellenverzeichnis

8 Anhang

8.1 Javadoc

[Matrixmaster]

Hi

Meiner Meinung nach sieht das nach sehr viel Arbeit aus.:-)

Allerdings Frage ich mich wie Du die ganzen Themen auf 10 Seiten bekommst.

Ich weiß nicht wie es Momentan ausschaut aber wir haben damals 11 Seiten als Maximum bekommen (FA/AW). Und Diese sollte man möglichst +/- 1 nicht überschreiten. Auf Diese Vorgabe achten die Prüfer dann schon. Bei uns hatte jemand ne super tolle Doku mit 30 Seiten. Dennoch gabs dafür nur ne 4 da Diese Vorgaben nicht eingehalten wurden.

In Diesen Seiten (11) sollte dann auch das wichtigste von dem Projekt beschrieben sein.(Lieber eine grafische Darstellung weniger) Wenn Du wie Du sagst jede Menge an UML Diagrammen in der Doku hast würde ich die samt Beschreibung lieber in den Anhang mit reinbringen. Im Anhang kannste jede Menge unterbringen. Selbst wenns 30 - 40 Seiten sind....Kein Problem.

Aber wie gesagt wenn Du Diese Vorgaben eingehalten hast ist es wirklich gelungen meiner Meinung nach.

Gruß Marko

www.ITFachinformatiker.de

[timmi-bonn]

Originally posted by mhanel

Ich mache ein internes Projekt zum logging der angemeldeten Benutzer der Internet Applikation meiner Firma. [...]

Vergiß dabei nicht die Datenschutz-Aspekte (ggf. Betriebsrat).

[P3AC3MAK3R]

Allein die Menge der Gliederungspunkte schreckt mich auch bereits ab. :eek:

[mhanel]

Also die IHK-München hat die Vorgabe von 12 bis 16 Seiten.

Der Anhang darf maximal 10 Seiten mehr sein.

Ich bekomme alles mit 16Seiten hin.

Im Anhang habe ich dann nur noch Javodoc's

Die Anzahl der Gliederungspunkte ist zwar groß bloß ist der Text, der Dabei steht nicht

sonderlich umfangreich.

Wenn ich keine Zeichnungen drinnen habe schaff ich es nicht mal bis 12 Seiten.

[timmi-bonn]

Originally posted by mhanel

Also die IHK-München hat die Vorgabe von 12 bis 16 Seiten.

Der Anhang darf maximal 10 Seiten mehr sein.[...]

Huch?!? Da ist wirklich der Anhang seitenmäßig limitiert?

gruß, timmi

[mhanel]

Ja ist leider so.

Ich hab in den Anhang meine Javadocs reingetan.

Jetzt tu ich sie gerade kürzen, damit ich auf 26 Seiten komme.

MfG Matthias

[Daidalos]

Originally posted by mhanel

Also die IHK-München hat die Vorgabe von 12 bis 16 Seiten.

Der Anhang darf maximal 10 Seiten mehr sein.

Hi,

ich gebe heute meine Projektbericht ab - 26 Seiten - denke dass es da keine Probleme gibt.

Euch allen Viel Erfolg!

Grüße Daidalos

(auch in MUC)