Gliederung der Projektdokumentation

[Gremix]

Hi,

ich sitze gerade an meiner prozessorientieren Projektdokumentation

und habe festgestellt, das nicht nur bei Elmo Fragezeichen auftauchen.

Selbstverständlich habe ich mir alles mögliche hier zu diesem Thema aus

dem Forum angesehen. Jedoch sind trotz allem noch Lücken bei mir.

PROJEKTBESCHREIBUNG:

-------------------------------

Bei dem Projekt handelt es sich um einen Kundenauftrag des DMK.

Für die Nutzung des geschützten Bereichs im Internetangebot des DMK soll ein Überwachungs- und Verlängerungsmodul implementiert werden. Diese Module sollen in ein bestehendes Anmeldeverfahren integriert werden. Dabei soll das Überwachungsmodul, unter Beachtung von verschiedenen Benutzergruppen, die restliche Nutzungsdauer für den geschützten Bereich kontrollieren.

Gegebenenfalls soll ein entsprechender Hinweis für den Benutzer bzw. die Benutzergruppe mit der Anzahl der verbleibenden Nutzungstage ausgegeben werden. Weiterhin soll dem Benutzer die Möglichkeit eingeräumt werden, durch das Verlängerungsmodul seine Nutzungsdauer zu verlängern.

Dafür muss eine bestehende Mitgliederdatenbank gewartet und erweitert werden, um die verschiedenen Benutzergruppen zu integrieren.

Hier meine Gliederung der Dokumentation:

1 PROJEKTUMGEBUNG

1.1 UNTERNEHMENSVORSTELLUNG

1.2 PROJEKTBESCHREIBUNG

1.3 PROJEKTUMFELD

1.4 PROJEKTZIEL

1.4.1 Sachziel

1.5 PROJEKTPLANUNG

2 PROBLEMANALYSE

2.1 IST-ANALYSE

2.1.1 Bewertung des Ist-Analyse

2.2 SOLL-ANALYSE / FACHKONZEPT

2.2.1 Systemziele

2.2.2 Benutzermodell

2.2.3 Basismaschine

2.2.4 Benutzerschnittstellen

2.3 DURCHFÜHRBARKEITSANALYSE

2.3.1 Kosten / Nutzenrechnung

3 ENTWURFSPHASE

3.1 SYSTEMENTWURF

3.1.1 Datenbank

3.2 PROGRAMMENTWURF

4 REALISIERUNGSPHASE

4.1 IMPLEMENTIERUNG

4.2 TESTPHASE / QUALITÄTSSICHERUNG

4.2.1 Testplanung

4.2.2 Testdurchführung

4.2.3 Testergebnisse

5 EINFÜHRUNGSPHASE

5.1 INTEGRATION DER NEUEN MODULE IN DAS BESTEHENDE SYSTEM

6 PROJEKTABSCHLUSS

6.1 ABNAHMEPROTOKOLL DES KUNDEN

6.2 Soll-Ist-Vergleich

6.3 FAZIT

7 APPENDIX

7.1 ERKLÄRUNG ÜBER SELBSTSTÄNDIGE ERARBEITUNG DES PROJEKTES

7.2 GLOSSAR

7.3 DV-TECHNISCHE DOKUMENTATION

7.3.1 Datenfluss-Diagramm

7.3.2 Entscheidungstabellen

7.3.3 Struktogramm

7.3.4 Programmablaufplan

7.4 WIRTSCHAFTLICHKEITSANALYSE

7.5 QUELLTEXTE

7.6 TESTERGEBNISSE

Und nun meine Fragen:

1.)

Unter den Punk 1.4 Projektziel bzw. Sachziel, habe ich kurz geschrieben, was erreicht werden soll, also Minimierung des Verwaltungsaufwandes.

Kann ich Projektziel weglassen, da das selbe ausführlicher in der

Soll-Analyse->Systemziele auftaucht ?

2.)

In der Projektplanung (Punkt 1.5 ) habe ich eine chronologische Vorgangstabelle mit Zeiteinteilung dargestellt, sollte meiner Auffassung auch reichen, da das Projekt von mir selbstständig erarbeitet wird. Also ein Pert-Diagramm etc. aus der Netzplantechnik wären doch überflüssig, oder ?

3.)

Was muss alles in System- und Programmentwurf rein ?

4.)

Gibt es Mängel an der Gliederung oder können sogar einige Sachen raus ?

Besten Dank im vorraus für jede Hilfe !!

Gremix

[Fxer]

Hi,

wo ich gerade sehe dass du ein Glossar im Anhang machen willst, wollt ich dir nur raten möglichst viel im Text selbst zu klären. Haben jedenfalls unsere Lehrer so gesagt. Ich würde versuchen das Glossar, wenn du eins machst klein zu halten, denn ein Prüfer hat bestimmt nicht so den Bock andauernd hinten nach zusehen was der Begriff den bedeutet. Naja nur so als Tip.

Fxer

[Gremix]

Hi Fxer,

mein Glosaar möchte ich schon selbst darstellen. Welcher Prüfer weiss schon was z.B. : "ICQ", TCP","relativ" zu "e =mc²" ist ?

Nein im Ernst genommen, mein Glossar soll dazu betragen, dass mein Projetbericht auch wirklich von jeden Fachidioiten verstanden wird ;-) (natürlich unter Vorbehalt und ohne Gewähr)

Es soll vielmehr zeigen, dass ich eine Basis der einheitlichen Begriffsdefintion

schaffe.

Der Trick dabei ist, das Glossar im Anhang abzulegen, denn dann kann man behaupten, dass das 23 Seiten umfassende Glossar nicht eingesehen worden ist

Cu,

Gremix

[sheep]

@ Gremix

23 Seiten Glossar ? Mein Gott, wie umfangreich soll deine Dokumentation werden ? Du solltest beachten, das im Prüfungsausschuss durchaus Leute sitzen, die sehr viel Ahnung von der Materie haben. Es sind also mitnichten Laien. Natürlich gibt es immer die eine oder andere Sache die unklar ist, aber wenn man bei Adam und Eva anfängt und Begriffe wie Browser, Client, Server etc. erklärt kann das u.U. sehr negativ wirken, da die Prüfer das Gefühl bekommen könnten, man wollte sie für dumm verkaufen.

[Der Kleine]

Originally posted by Gremix

Welcher Prüfer weiss schon was z.B. : "ICQ", TCP","relativ" zu "e =mc²" ist ?

Falls ich es nicht weiss, frag ich hier auf dem Board mal.

Im Ernst : 23 Seiten Glossar, für mich immer spannend zu lesen (egal ob im Anhang oder nicht).

Dort weiss ich wenigstens, ob du die Begriffe richtig beschrieben hast (wie es ein FI können sollte) und außerdem habe ich genug Stoff, um in einem Fachgespräch mal nachzuhacken, ob die Fachbegriffe dir auch alle klar sind.

Es ist immer schön, wenn Prüflinge meine Arbeit vorweg nehmen.

Aber negativ würde ich es nicht bewerten, sofern fachlich korrekt.

[Gremix]

@ Der Kleine

23 Seiten sind es noch nicht und werden es wohl auch nicht werden,

sonst nehme ich ja noch am Ende den Prüfern die Arbeit weg ;-)

Sonst schon mal circa dreiundzwanzig Seiten Glossar gehabt ?

@ sheep

"bei Adam und Eva anfängt und Begriffe wie Browser, Client, Server etc."

Sicher, sicher würde ich auch ggf. bei Eva (Eingabe-Verarbeitung-Ausgabe") anfangen. Aber besser ist es, wenn es auch der Kontext erfordert.

D.h. wenn es bedarf und relevant für das Projekt ist. Daher findet man auch die Begiffe: "Browser","Cookie","Login","Content Managment System" in meinem Glossar.

Tipp:

Ein Glossar dient auch zur eigenen Überprüfung seines Wissen* !

YOGAR SAGT:

"Wer Wörter schreibt und sie zu erklären weiss,

braucht keinen Angstschweiss."

...

*Darunter ist folgendes zu Verstehen:

1. Erst mal alle Wörter aufschreiben, die im Projekt auftauchen und einem selbst (mal nicht) spanisch vorkommen.

2. Die Wörter mit eigenen Worten erklären.

3. Eigene Antworten mit nachgeschlagenen Erläuterungen vgl.

4. TIEF EINARTMEN ! und wieder ausatmen ...

5. Weiter so !!

.. oder so NOT ??

JEDENFALLS nicht die MOTIVATION verlieren !!

Gremix

[Der Kleine]

Originally posted by Gremix

*Darunter ist folgendes zu Verstehen:

1. Erst mal alle Wörter aufschreiben, die im Projekt auftauchen und einem selbst (mal nicht) spanisch vorkommen.

2. Die Wörter mit eigenen Worten erklären.

3. Eigene Antworten mit nachgeschlagenen Erläuterungen vgl.

4. TIEF EINARTMEN ! und wieder ausatmen ...

5. Weiter so !!

.. oder so NOT ??

Ist ja richtig. Bloß das Veröffentlichen in der Doku oder das Herausarbeiten (auch für die AP) sind unterschiedliche Dinge.

Originally posted by Gremix

Sonst schon mal circa dreiundzwanzig Seiten Glossar gehabt ?

Nein, aber so um die 10 Seiten in großer Schriftart und mit wahnsinnigen Zeilenabstand und sehr diletantisch (also für meine Mutter ) erklärt. Entsprechend war auch die Gesamtbewertung.

[Crow T. Robot]

Hallo Gremix!

Hier sind meine 0,02 € zu deinen Fragen...

Originally posted by Gremix

1.) Unter den Punk 1.4 Projektziel bzw. Sachziel, habe ich kurz geschrieben, was erreicht werden soll, also Minimierung des Verwaltungsaufwandes.

Kann ich Projektziel weglassen, da das selbe ausführlicher in der

Soll-Analyse->Systemziele auftaucht ?

Würde ich nicht sagen, da hier Inhalt, Umfang und Ergebnis abweichen. Das "Projektziel" sehe ich eher als zielorientierte Themeneinleitung, so wie der Auftraggeber es formulieren würde, quasi eine Art "kleines Lastenheft". Im Soll-Konzept ("Soll-Analyse" halte ich für nicht ganz passend) wird ein fachlicher Entwurf des späteren Produkts generiert, das Ergebnis hiervon ist dann das Pflichtenheft.

2.) In der Projektplanung (Punkt 1.5 ) habe ich eine chronologische Vorgangstabelle mit Zeiteinteilung dargestellt, sollte meiner Auffassung auch reichen, da das Projekt von mir selbstständig erarbeitet wird. Also ein Pert-Diagramm etc. aus der Netzplantechnik wären doch überflüssig, oder ??

Das musst du schon selber wissen. Wegen des Projektumfangs und der Tatsache dass ich die Durchführung alleine vornehme, habe ich mich ebenfalls auf eine einfache Tabelle beschränkt. Insbesondere einen Netzplan halte ich bei einem "Ein-Mann-Projekt" für ziemlich unsinnig. Meilensteine übrigens auch, aber die habe ich trotzdem drin, weil's die Prüfer gerade schick finden.

3.) Was muss alles in System- und Programmentwurf rein ???

Ich würde sagen Analyse der Produktumgebung, Ableitung der dafür benötigten Schnittstellen, Entwurf der Module bzw. Klassen und Schnittstellen. Das Ergebnis kann man durch PAP/Struktogramm, ETs und/oder UML darstellen.

4.) Gibt es Mängel an der Gliederung oder können sogar einige Sachen raus ?

Man sollte es vermeiden, auf einer Gliederungsebene nur ein Element zu haben, bei dir z.B. 1.4.1 Entweder kommt mindestens noch ein 1.4.2 dazu oder 1.4.1 wird auch weggelassen (natürlich nur als Gliederungspunkt, der Inhalt bleibt). Ausserdem sollte man darauf achten, dass die Menge der Untergliederung über alle Abschnitte hinweg gleichmäßig ist. Aber das ist nur eine Empfehlung, kein Muss.