Klärungsbedarf zur Funktion von UML

[tobias-digital]

Hi!

Ich bin zwar kein Anwendungsentwickler, wurde aber dennoch jetzt zusammen mit Kollegen mit einem Software-Projekt beauftragt, bzw. wir haben dieses grade abgeschlossen.

Jetzt stehe ich vor der Aufgabe ein bißchen zu dokumentieren (hätte man natürlich auch wärenddessen machen können ;-) aber egal).

Mir stellt sich nur die Frage ob UML die geeignete Möglichkeit darstellt die einzelnen Programmmodule zu dokumentieren, oder ob ich damit UMLs Funktion degradieren würde.

Vielleicht kennt einer einen Link der ein bißchen in das Thema UML einleitet...

mfg ___

[smokie]

Hallo

Zum Ueberblick (weiss ja nicht was ihr dokumentieren sollt/muesst):

- Datenflaussplan:

Grobe Uebersicht ueber den Verlauf der Daten. --> Daten werden von Diskette gelesen -> auf Festplatte gespeichert oder sonstwie erstellt/geaendert.

-Struktogramme:

Darstellung des logischen Programmablaufs mit genormten Symbolen. Verwendung fuer Strukturierte Programmablaeufe.

- UML (Unified Modeling Language):

Dastellung von Klassen, Objekten und Hierachien und den Beziehungen unter der Betrachtung der syntaktischen und semantischen Regeln.

Denke das war es.

Wenn du schreibst was Dokumentiert werden soll kann man dir sicherlich eine etwas genauere Antwort geben.

(Datenbank, Programmablaeufe, Schnittstellen, ....)

smokie

[tobias-digital]

Hi!

Also im groben haben wir eine Datenbank und ein Webinterface mit PHP und mysql realisiert. Das Webinterface hält bestimmte Funktionen bereit. Objektorientiert haben wir nicht gearbeitet.

Wir haben auch nicht den Auftrag großartig zu dokumentieren, aber der Vollständigkeit halber würde ich schon gerne ein bißchen Doku machen, aber ohne viel Text. Ein ER-Diagramm habe ich schon und eine Anleitung für die User auch, fehlt noch ein bißchen erläuterndes Material für den Code...UML fällt ja dann weg wenn es für OOP gedacht ist.

[Crush]

"UML fällt ja dann weg wenn es >für OOP< gedacht ist."

-> Das ist es!

[smokie]

Hallo!

Also, UML kann auch zum Design von Tabellenabhaengigkeiten/-strukturen untereinander in einer DB verwendet werden und somit auch zur Dokumentation dieser.

[OUT]

Was sich natuerlich schoen macht sind Masken Dokumentationen - Anordung und Pfad der einzelnen Webseiten usw.. Dies kann mit viel Bild und relativ wenig Text geschehen. Ich wuerde noch Routinen die besondere Aufgabe erfuellen als Struktorgramm darstellen. Wobei ich die Block-Ausfuehrung dem PAP vorziehe.

Eventuell den gesamten Programmablauf grob strukturiert darstellen.

Nun ich persoenlich bestreite die Ansicht das der Code die beste Doku ist. Entsprechenden Code + Kommentare vorausgesetzt.

[/OUT]

smokie

[tobias-digital]

Ok! Danke an alle, ich denke ich werde das tun was smokie geraten hat und den code anhand von kommentaren dokumentieren, ist wahrscheinlich das beste...

...kann mir einer ein Buch zu OOP empfehlen? :-]

[Schledo]

Habe noch zwei sehr interessante Lnks dazu,

einmal eine Einführung von einer Uni-Seite : http://ivs.cs.uni-magdeburg.de/~dumke/UML/index.htm

und eine Ineressengruppe :http://www.umlsig.de/

[Elo]

Original geschrieben von ___

Ok! Danke an alle, ich denke ich werde das tun was smokie geraten hat und den code anhand von kommentaren dokumentieren, ist wahrscheinlich das beste...

...kann mir einer ein Buch zu OOP empfehlen? :-]

probiersmal hiermit:

http://www.amazon.de/exec/obidos/ASIN/3486255657/qid=1029839161/sr=2-2/ref=sr_2_3_2/302-0402491-3716018

[Elo]

oder hiermit :-)

http://www.amazon.de/exec/obidos/ASIN/3486255738/ref=pd_bxgy_img_2/302-0402491-3716018

[fmarx2000]

UML benutzt man zur Analyse (bevor man hackt) und dann zum Design (bevor man hackt) .

Um Datenbankmodelle darzustellen sollte man ER-Modelling verwenden (Entity - Relationship - Modelling).

Frank

[Elo]

Original geschrieben von fmarx2000

UML benutzt man zur Analyse (bevor man hackt) und dann zum Design (bevor man hackt) .

Um Datenbankmodelle darzustellen sollte man ER-Modelling verwenden (Entity - Relationship - Modelling).

Frank

Natürlich erstmal bevor man programmiert, aber natürlich auch während man programmiert! Zur Analyse verwende ich die UML sicher nicht.

[fmarx2000]

Man verwendet zur Analyse UML (siehe Lehrbuch der Objektmodellierung oder Object Patterns). Man modelliert dann das Ergebnis der Analyse und dann dieses Ergebnis weiter im Design Modell zu spezifizieren.

Das geht aber mehr das statische Modell an.

Frank

[Elo]

von dem Buch: "Object Patterns" hab ich noch nie was gehört. Könntest du mir bitte ne ISBN geben, würd mich interessieren.

Vielen Dank!

[fmarx2000]

Original geschrieben von Elo

von dem Buch: "Object Patterns" hab ich noch nie was gehört. Könntest du mir bitte ne ISBN geben, würd mich interessieren.

Vielen Dank!

Anscheinend hast du von vielen Dingen bezüglich OOA, OOD noch nichts gehört sonst würdest du nicht teilweise so grundlegend falsche und unsinnige Aussagen tätigen.

Hier ist die URL zu dem Buch:

http://www.amazon.de/exec/obidos/ASIN/0138401179/qid=1031662679/sr=1-2/ref=sr_1_2_2/028-3891051-7522911

Frank