Multi: erstes echt großes Projekt

Beitrag lesen

Mahlzeit,

Nö, ich hab schon Dokumentation gemeint!
(Soll etwas ausführlicher als nur eine Zusammenfassung der Klassenbeschreibungen sein)

Bei grossen Projekten (und da rede ich nicht von Projekten mit 200 Stundne, das fällt noch unter klein) wird erst ein Fachkonzept entwickelt, anschliessend ein Fachfeinkonzept, was die P>unkte im Fachkonzept weiter auffächert.
Aufgrund dieses Fachkonzeptes wird ein DV-Konzept erstellt, was im Endeffekt die komplette Software im Klartext ist. Du musst dieses dann nur noch in Programmcode "übersetzen".

V.a. da vermutlich alle zwei Monate neue Module hinzukommen werden...

In dem Fall ist vorallem die Schnittstellendokumentation wichtig. Die muss so exakt sein, dass jeder Programmierer ohne jegliche Vorkenntnisse in kürzester Zeit damit umgehen kann.

Dinge wie PHPDoc sind dabei maximal eine Ergänzung aber kein Ersatz für eine Vorabdokumentation.

Also je nachdem, wie die komplette Grösse des Projektes sein wird, fällt die Doku aus. Umso langfristiger das Projekt, umso ausführlicher muss die Doku sein. Plane zwischen 10 und 20% deiner Projektdauer für die Dokumentation ein, dieser Wert ich bei grossen Projekten üblich, da in den meisten Fällen mehrere Personen mit Dokumentation und deren Absegnung beschäftigt sind.