Projektdokumentation eines Anwendungs Programms - brauche ein bisschen Hilfe

[acidK]

Moin,

ich mache zur Zeit meinen FOS abschluß. Auch dafür müssen/mussten wir ein Projekt machen. Nun muss ich langsam meine Projektdokumentation fertig bekommen. Dabei habe ich noch ein paar Probleme. Es geht bei dem Projekt übrigens um eine Programm welches in Java geschrieben ist.

Ich weiß nicht recht was ich unter dem Punkt "Projektdurchführung" schreiben soll. Soll ich da schreiben wie und wieso ich einzelne Arbeitspakete (z.B. Datenbankaufbau) gelöst habe?

Sollt ich eigentlich in der Doku auch Quelltext zeigen oder es lieber vermeiden?

[chooter696]

Quellentext -> Ja aber in maßen und in den anhang

in den Punkt Projektdurchführung kommt rein wann du welchen schritt gemacht ahst mit welchem risultat. also am

2.2.2005 entwicklung der oberfläche

Die entwicklung de oberfläche hat net geklappt wiel ich kein bock auf das projekt hatte ^^

also das kommt in die durchführung

[acidK]

Okay, es ist wirklich notwendig zu schreiben wann ich welches Arbeitspaket behandelt habe? Für mich wäre es ehr uninteressant für die Doku wann ich z.B. die oberfläche gemacht habe, das gehört doch wenn, dann in den Zeitplan oder nicht? Aber ich bin ja auch nur der dumme Schüler . Soll ich auch schreiben welchen komponenten ich gewählt habe, jList etc.?

[chooter696]

http://fiae.rcmd.org/abschlussprojekt/dokumentation/001_Projektdokumentation_MyBAQ.pdf

hier der link wo ich sie mir gedownloadet habe.

[acidK]

Ich finde so, wie es in der pdf, beschrieben ist, schaut das einfach nur ein Protokoll aus. Dort wird einfach beschrieben was wann gemacht wurde. Sollte man nicht noch ein bisschen mehr dazu schreiben? Was man wieso gemacht hat z.B.?

[chooter696]

na sich ist es nur ein protokoll. also das warum du das so gemacht hast ist dort nicht relevant sondern nur das du etwas gemacht hast. es sit an sich dafür da damit der auftraggeber sehen kann wofür er dich bezahlt

[acidK]

Aso, und wo beschreib ich des alles dann alles bisschen genauer?

[acidK]

Noch eine andere Frage, kann mir wer sagen wie das Programm an sich benotet wird (in der Regel, hängt natürlich auch vom Lehrer ab). Wird nur auf Funktionalität geachtet? Oder auch auf den Quellcode? Weil meine sieht...sagen wirs ma so...wahrscheinlich steig nur ich da durch. Da is noch viel unnötziges drin, viel auskommentiert und vor allem nicht ausreichend kommentiert...

[acidK]

Sry, für das viele doppel/dreifach posten. Ich hab ein neues Problem. Bei der Projektdurchführung, das soll ja wie ein Protokoll sein. Nur dummerweise hab ich während der Projektaufgabe kein Protokoll geführt und weiß somit nicht genau was wie viel Stunden gedauert hat. Wie soll ich damit umgehen? Soll ich mir einfach was ausdenken, sodass es realistisch wirkt? Oder richtig dreist/dumm sein den Zeitaufwand gar erst zu erwähnen?

[chooter696]

Wie soll ich damit umgehen? Soll ich mir einfach was ausdenken, sodass es realistisch wirkt? Oder richtig dreist/dumm sein den Zeitaufwand gar erst zu erwähnen?

an sich natürlich schlecht das du kein protokoll geführt hast aber da kann man jetzt ja nix mehr machen. Aber zum lügen in der Doku möchte ich dich nicht anstiften deshalb gebe ich dir mal eine richtung vor und du entscheidest es dann selbst.

Die Projektdurchführung nicht zu erwähnen wäre nicht nur dreist sondern tödlich. Das kann dir in deiner Projektverteidigung mal schnell den kopf kosten als was du da jetzt machst ist dir überlassen aber auf keinen fall unter den tisch fallen lassen.

Zum Thema

Wird nur auf Funktionalität geachtet? Oder auch auf den Quellcode?

Ich muss z.B. meinen gesamten Quellcode mitschicken. Deshalb muss auch alles kommentiert sein. darauf wird natürlich geachtet. Weil egal wie popelig ein Programm ist. Es gibt 1000 möglichkeiten es zu realiseren naja bis auf hallo welt natürlich. Deshalb ist komentierung das a und o in der softweare entwicklung nach der planung jedenfalls

Darum lege ich dir ans Herz Kommentiere deinen Quellecode nicht weil das andere möchten sondern weil DU möchtest das andere da durch sehen.

Da is noch viel unnötziges drin, viel auskommentiert

Auf jeden fall aus dem ding rausschmeisen was nicht hilft verwirrt nur.

Aso, und wo beschreib ich des alles dann alles bisschen genauer?

Was möchtest du genauer beschreiben?

warum du das so gemacht hast und nicht anders?

Wenn dann ins Pflichtenheft.

Denn im Fall der fälle kann ein gutes Pflichtenheft vor Gericht gewertet werden da dort alles drin steht.

[acidK]

In der pdf wurde gar nicht riichtig der Soll-Zustand beschrieben oder?

m SOLL-Zustand wird – ebenfalls aus Sicht des Projektleiters (d.h. auf einer technisch, dezidierten Sicht/ Ebene) das angestrebte Ergebnis beschrieben.

Also da wird doch quasi beschrieben was das Programm können soll. Wo soll ich das in der Doku einordnung? Noch in Projekdefinition?

[mfgmicha]

Erfahrung aus meinem Projekt: (Hab noch keine Note daher mit Vorsicht zu genießen ^^)

- Projektdoku:

> Dokument für die Prüfung, also ein Art Protokoll

> Zeitplan: Projektschritte mit Angabe der geplanten Stunden (Bei mir in Kundendoku als Zeitvergleich SOLL-IST)

> Projektdurchführung: Projektschritte mit Tages-/Stundenangabe und Beschreibung was und wieso du es gemacht hast

- Evtl. Lastenheft: Was will der Auftraggeber

- Pflichtenheft: Wie will ich die Anforderungen des Auftraggebers umsetzen

- Kundendoku: Das was der Kunde bekommt, beinhaltet bei mir: Zeitvergleich, Kosten-Nutzen-Analyse, Systemvorraussetzingen, Funktionen, Diagramme wie die Software aufgebaut ist (Klassend., Aktivitätsd. und Pseudocode), Testprotokoll und Installationsanleitung