Dokumentierung eines größeren Projekt (BLL)?

[daniel987]

Also da ich ja nun angefangen habe eine Bll in PHP und MYSQL zu schreiben mache ich mir langsam Gedanken über die richtige Dokumentierung, die ich dann mit dem Skript abgeben kann.
Deshalb hier meine Frage, wie geht ihr normalerweise vor um größer Projekte zu dokumentieren, welche Programme nehmt ihr dazu, wann fangt ihr an das ganze zu schreiben, während das ganze entsteht oder erst ganz am Ende wenn schon alles steht.

Bis jetzt hatte ich mir das ganze so vorgestellt, während der Entwicklung (die übrigens 1 Jahr dauern soll) mache ich mit Word Notizen und skiziere das mal so grob, und am Ende versuche ich das ganze dann nochmal ordentlich mit InDesign in ein an das Projekt angelehnte Design zu verpacken (dummerweise versteh ich das mit Indesign noch nicht, obwohl es schon welten besser ist wie Quark Xpress).

Wie und in welcher Form ist es eigentlich sinnvoll UML Diagramm einzubringen, (wozu sind die überhaupt gut) wäre vielleicht gut wenn mir jemand mal ein kostenloses Progi zum erstellen nennen könnte.

Danke an jeden der mir hier weiterhilft und seine Erfahrungen & Ratschläge postet.

[Quetschi]

Re: Dokumentierung eines größeren Projekt (BLL)?

Original geschrieben von daniel987
...während der Entwicklung (die übrigens 1 Jahr dauern soll)

OffTopic:

---

ui

---

Dokumentieren tu ich irgendwie nie was - einzig ein paar Kommentare in den Scripten geben mir nach längerer Zeit Aufschluss darüber, was ich da mal verbrochen hab. Aber mit dem Kommentaren geh ich viel zu sparsam um und so kommt's dann immer zur großen Sucherei, wenn mal ne bestimmte Funktionalität oder so geändert werden soll

Auch wenn ich dir nicht aktiv helfen kann - ich kann dir trotzdem empfehlen konsequenter zu Dokumentieren als ich es tu.

[mrhappiness]

Ich dachte immer, man hätte zuerst ein Grobkonzept, dann ein Feinkonzept (und dann evtl. noch ein Technisches Konzept).

Im Konzept ist dann natürlich eine Leistungsbeschreibung enthalten und Lasten-/Pflichtenheft (letzteres kann auch gerne ein eigenständiges Dokument sein).

Änderungen der Dokumente sollten schon am Dateinamen erkennbar sein.

Wenn das steht und abgenommen ist, geht's los mit der Entwicklung.

Bei der Entwicklung so kommentieren (ist ja auch eine Art von Doku), dass du in 5 Jahren und ein am Prozess Unbeteiligter mit Entwicklungshintergrund jetzt verstehen kann, was da abläuft.

Nach der Entwicklung kommt eine technische Doku, da erfahrungsgemäß Realisierung und Konzept an der ein oder anderen Stelle auseinanderlaufen.

-------

Wenn dein Projekt nicht wirklich groß ist (bei einer reinen Entwicklungszeit? von 1 Jahr ist es aber auch nicht wirklich klein), geht's aber auch weniger umfangreich

Dann würde ich trotzdem _bevor_ ich irgendwas entwickle, ein Konzept erstellen, dabei kriegst du schon mal einen groben Überblick. Nach dem Konzept (wird vermutlich eher Richtung Leistungsbeschreibung) gehen, machst du dir Gedanken über ein vernünftiges Datenbankdesign, malst ER-Diagramme und speicherst die auch (logisch, oder?)

Jetzt schaust du dir dein Konzept an:
Was für Sachen gehören inhaltlich zusammen?
Schreibe dein Konzept neu. :-)

Entwickle und kommentiere wie oben.

[aimbot]

also ERM kann ich wie happy wärmstens empfehlen. genauso die "nebenher-doku" (manche nennen es auch kommentiern )
ein konzept und ein fachkonzept halt ich auch für wichtig.

[daniel987]

Erstmal danke für eure Vorschläge, welche Programme kann man denn zum erstellen solcher Diagramme nutzen?

[aimbot]

im bezug auf flowcharts:
kostenlos wäre Draw (in open office org enthalten)
bietet mE aber nicht soviel funktionen wie z.b.
das kostenpflichtige iGrafx flowcharter.

[martinm79]

Re: Dokumentierung eines größeren Projekt (BLL)?

Original geschrieben von daniel987
Deshalb hier meine Frage, wie geht ihr normalerweise vor um größer Projekte zu dokumentieren,

Naja, wenn du jetzt schon von 1 jahr ausgehst, dann kann es ja sogar noch länger dauern...
Bin zwar kein ausgebildeter Informatiker, aber beschränke dich doch erstmal auf die Grundfunktionen des Programmes. Das du vielleicht auf 3 Monate oder ein halbes jahr kommst.
Wenn du denn fertig bist, kannst du es doch immer noch verfeinern und vergrößern.
Das hätte dann schon gewisse Vorteile.

[daniel987]

Re: Re: Dokumentierung eines größeren Projekt (BLL)?

Original geschrieben von martinm79
Naja, wenn du jetzt schon von 1 jahr ausgehst, dann kann es ja sogar noch länger dauern...
Bin zwar kein ausgebildeter Informatiker, aber beschränke dich doch erstmal auf die Grundfunktionen des Programmes. Das du vielleicht auf 3 Monate oder ein halbes jahr kommst.
Wenn du denn fertig bist, kannst du es doch immer noch verfeinern und vergrößern.
Das hätte dann schon gewisse Vorteile.

Aus diesem Grund verwende ich einen Modularen Aufbau, dadurch kann ich nicht besonders in Zeitdruck gelangen, denn je nachdem wie viel Zeit ich letztendlich noch habe, kann ich dann einfach noch mehr einbauen.