ProjektDoku: Wie genau sollte man eine Klasse beschreiben?

[ixitixel]

Hallo,

Bin gerade dabei meine Projektdokumentation zu schreiben. Die Hauptarbeit bei meinem Projekt war das Design und die Implementierung zweier Klassen. Diese sollten dann schließlich noch mit einem Prototypen-GUI verknüpft werden (GUI war also nicht so wichtig).

Bin jetzt beim Hauptteil der Doku angelangt. Wie genau sollte ich mit Worten die Klassen beschreiben? Bisher beschreibe ich was die Klassen machen und die wichtigsten Methoden - eine genaue Übersicht gibt es noch per UML Diagramm im Anhang.

Um den Ablauf sichtbar zu machen wollte ich jetzt noch einen Datenflussplan einfügen.

Sollte ich die Klassen genau beschreiben (sehr technisch) oder mehr Planungsaspekte reinbringen...

Grüße,

André

[Hotliner f.Hell]

Hi,

hatte auch was mit ner Klasse in meinem Projekt....

bei mir hat es gereicht, das ich die Klasse und die Methoden beschrieben habe.

In der Präsi hatte ich dann noch nen Klassendiagramm. In der Doku war noch nen PAP , der den Ablauf einer Methode der Klasse dastellte.

Im Fachgespräch waren dann doch einige Fragen zu UML.

...alles ohne schieß Gewähr!

Gruß

Michael

[TonicTickle]

Du hast aber doch kein UML benutzt, oder?!

Was fragen die da so? Nur was es ist, oder auch welche Symbole es gibt, etc. ??

[Ganymed]

Original geschrieben von TonicTickle

Du hast aber doch kein UML benutzt, oder?!

Was fragen die da so? Nur was es ist, oder auch welche Symbole es gibt, etc. ??

Es kann sein, dass du dein eignenes UML Diagramm (i.d.R. benutzt man eher die Klassendiagramme) erläutern musst (schleisslich hast du es ja auch gemacht) und anhand dessen können Dinge wie Vererbung, Polymorphie, Abstrakte Klassen, Nachrichten, etc... abgefragt werden.

Es kann aber auch nach anderen Darstellungsformen in der UML gefragt werden. wozu sie benötigt werden, etc...