Klassendiagramme im Abschlussprojekt (FIAE)

[MarkusLe]

Hallo alle zusammen,

ich bin gerade am überlegen ob ich meine Klassendiagramme alle, oder nur die Übersichtsdiagramme in die Anlagen der Projektdokumentation aufnehmen sollte.

Falls ich alles aufnehme, wären das wohl an die 10 Seiten, was alles in Allem dann zu einem ca. 20 Seitigen Anhang führen würde.

Dahe meine Frage, wie detailliert sollten die Klassendiagramme in der Projektarbeit sein, und gibt es eine Größenbegrenzung zur Anlage? Wie habt ihr das mit Euren Use Cases, Ablauf-, und Klassendiagrammen gemacht?

MfG

Markus

[etreu]

Ganz klar: alles mit rein.

Ich hatte damals im Anhang ca. 160 Seiten wegen meinem Quelltext. Das sollten die 10 gar nicht auffallen.

Ich weiß allerdings nicht, wie deine IHK das handhabt. Am besten du fragst deinen Ausbilder, der sollte dir dabei weiterhelfen können.

[developer]

@Enrico T.

Welche Absicht hattes du damit, den ganzen Quellcode (160 Seiten) in deine Anlage zu packen? Das hast du auch alles in den 70h Zeitrahmen machen können, inkl. Doku etc. ? Respekt! Ich als Prüfer wäre nicht unbedingt mit einer riesigen Motivation an so eine Doku gegangen. Just my 5 cent...

@MarkusLe

Sicherlich könntest du alle Diagramme mit hinein bringen. Ich würde dir allerdings eher dazu raten, entweder eine grobe Übersicht mit ca. 1-2 Seiten hinzufügen oder auch nur ein, zwei interessante Punkte zu beleuchten. Gerne auch mit ein wenig Quellcode. Zu viel ist in diesem Fall wirklich 'zu viel'. Gute Dokumentationen unterscheiden sich zu den weniger Guten meiner Ansicht nach auch dadurch, dass der Autor wichtige, interessante Informationen zu den überflüssigen Infos abgrenzen konnte. Der PA wird sicherlich nicht den 160 Seiten Quellcode durchsehen, das schreckt eher ab, wohl aber interessante, nicht überladene Informationen positiv bewerten.

Gestaltet eure Doku interessant und übersichtlich! Vermeidet nichts aussagende Diagramme und zu viele Screenshots.

[MarkusLe]

Also erstmal danke für die Infos,

ich werde werde jetzt zwei oder 3 Klassendiagramme und ein Aktivitätsdiagramm in den Anhang bringen. Quellcode werde ich keinen in die Dokumentation bringen, hat meiner Meinung nach nichts in einer Projektdokumentation zu suchen, ausser es wäre ein API-Projekt.

MfG

Markus

[PIPOKIPP]

Also erstmal danke für die Infos,

ich werde werde jetzt zwei oder 3 Klassendiagramme und ein Aktivitätsdiagramm in den Anhang bringen. Quellcode werde ich keinen in die Dokumentation bringen, hat meiner Meinung nach nichts in einer Projektdokumentation zu suchen, ausser es wäre ein API-Projekt.

MfG

Markus

Ich hab ein Teil des Quellcodes reingepackt (2 relativ große Methoden). Wurde ich auch empfehlen. Die Screenschots kann man nachmalen mit Photoshop & Co. Die Quellcode - nicht. Und das Teil gut debuggen, falls Fragen seitens PA dazu auftauchen.

[perdian]

Ich bin bei solchen Dingen immer jemand, der sagt: Überhaupt keinen Quellcode mit in die Dokumentation rein! Ich dokumentiere den Verlauf des Projektes, und nicht den Inhalt meines Werkzeugkoffers.

Code ist Mittel zum Zweck - nicht weniger, aber auch nicht mehr. Ich brauche ihn um mein Ziel zu erreichen, aber nur das Ziel (also die Applikation) ist es, die letzten Endes von Interesse ist. Eine kurze Übersicht "Für die Umsetzung wurde dabei auf Technologien X, Y und Z zurückgegriffen, weil A, B und C" sehe ich als vollkommen ausreichend an.