Wie haltet ihr es mit der Dokumentierung eines Typo3-Projektes?

  • tandem tandem
    Jedi-General
    0 x
    1053 Beiträge
    1 Hilfreiche Beiträge
    02. 03. 2006, 08:54

    Ich habe mehrere Typo3-Projekte begonnen.
    Erfahrungen habe ich besonders in der Entwicklung
    von Datenbank basierten Anwendungen.
    Ich arbeite nicht in einem Team und habe auch keine
    persönlichen Kontakte zu anderen Entwicklern.
    Ich kann mich also nicht austauschen und so sehen,
    dass meine Anwendungsentwicklung nachvollziehbar ist.

    Nun zu meiner Frage:
    Wie haltet ihr es mit der Dokumentierung eines Typo3-Projektes?

    Meine Arbeitstechniken entstehen aus der Erarbeitung der
    Entwicklungsmethoden der Autoren folgender Bücher:
    TYPO3 - Enterprise Content Management
    TYPO3 - Das Handbuch für Entwickler.

    Die Template-Datensätze wachsen in Zahl und Umfang.
    Für mich scheint sich ein "System" zu entwickeln.
    Aber ob es wirklich kommunizierbar ist - oder wird und bleibt?
    Typo3 ist wie eine Blackbox und nur unter großen Mühen
    läßt sich hier und da ein kleines Fensterchen öffnen.


  • 1
  • just2b just2b
    TYPO3-Yoda
    0 x
    18741 Beiträge
    2 Hilfreiche Beiträge
    04. 03. 2006, 08:11

    Hi,

    nun ist gar nicht so einfach!
    Die Frage ist aber nun, ob du dich austauschen _musst_? Erstmals musst du ein System für dich haben und das beibehalten bzw durchziehen. Und aufs Kommentieren nicht vergessen

    IMHO suchst du einen allgemeinen "Standard" den es nicht gibt

    lg georg

  • Winteretti Winterett...
    Sternenflotten-Admiral
    0 x
    66 Beiträge
    0 Hilfreiche Beiträge
    01. 08. 2006, 10:13

    Jau, so als Einzelkämpfer ist es in der Tat schwierig. Mir geht es genausso. Mittlerweile kenne ich mich in "meinem" System recht gut aus. Aber mir graust es davor, wenn ich daran denke, dass ich vielleicht eines Tages einmal die Stelle wechsel und jemand anderem erklären soll, wie und warum ich was gemacht habe. Es ist einfach sehr schwierig die Entwicklung zu dokumentieren, da es so viele Stellschrauben gibt, die es zu benennen gilt. Zudem läuft eben vieles nach dem trial-and-error-Verfahren. Manches was ich gebastelt habe, hat einige Wochen gut funktioniert, dann ist mir aber eine noch bessere Idee gekommen. Wenn ich das noch alles dokumentiert hätte, wäre ich ja gar nicht mehr fertig geworden.

    Habe mir schonmal überlegt ein Blog zur Dokumentation anzulegen. Da mein Hauptprojekt aber schon so weit fortgeschritten ist, wäre es dafür jetzt zu spät. Falls aber mal ein neues folgt, würde ich das auf jeden Fall empfehlen. So kann man jeden Tag die Fortschritte (in Kategorien sortiert) dokumentieren und hat so irgendwann sein eigenes Handbuch wie man was gemacht hat. Das ist dann nicht nur für eventuelle Nachfolger gut, sondern auch als eigene Gedächtnisstütze. Manchmal wundert man sich ja sonst selber wie man manches hinbekommen hat.

    M;ke

  • stephi stephi
    Jedi-Ritter
    0 x
    147 Beiträge
    0 Hilfreiche Beiträge
    01. 08. 2006, 11:16

    ich kenn die problematik.. ich persönlich schreibe mir manchmal eigene anleitungen, wie bestimmte dinge gemacht werden können.. das habe ich beispielsweise vor kurzem für die front-end-user-geschichte oder die konfiguration des rte gemacht... ich notiere mir in einem word-dokument alle notwendigen schritte dazu, kopiere oft auch den entsprechenden code rein..
    aber ob ich das alles in 2 jahren noch kapieren würde, weiß ich auch nicht ;)
    es funktioniert ja jetzt schon nicht bei jedem projekt nach meinem "strickmuster".

    die idee mit dem blog ist eigentlich recht gut, da man so ja recht einfach auch eine zeitliche sortierung hinbekommt. in meinem persönlichen blog hab ich mir bisher nur eine kleine linksammlung angelegt, das war alles.. vielleicht erstell ich mir so einen "arbeitsblog"...

  • chris3 chris3
    Sternenflotten-Admiral
    0 x
    232 Beiträge
    0 Hilfreiche Beiträge
    01. 08. 2006, 11:42

    Doku, Doku, Doku ... kein Kunde will dafür bezahlen, alle wollen sie haben ... #angry#

    "Inlined Comments" sollten natürlich vorhanden sein und - im BestCase - von jedem Entwickler nachvollziehbar sein ... #paralyzed#

    ... aber wenn ein Kunde/Arbeitgeber nicht explizit nach Doku fragt & bereit ist, dafür Resourcen zur Verfügung zu stellen (sei es jetzt Geld oder Arbeitszeit), dann ist das nicht der Fehler des Entwicklers ... man kann die "Entscheider" darauf hinweisen, aber entscheiden kann man darüber in 90% aller Fälle ja nicht ... #evil#

    Mit der "eigenen" Doku halte ich es wie stephi - allerdings in .TXT 'Dokumenten' ... ;)

  • just2b just2b
    TYPO3-Yoda
    0 x
    18741 Beiträge
    2 Hilfreiche Beiträge
    01. 08. 2006, 11:44

    [quote="chris3"]
    ... aber wenn ein Kunde/Arbeitgeber nicht explizit nach Doku fragt & bereit ist, dafür Resourcen zur Verfügung zu stellen (sei es jetzt Geld oder Arbeitszeit), dann ist das nicht der Fehler des Entwicklers ... man kann die "Entscheider" darauf hinweisen, aber entscheiden kann man darüber in 90% aller Fälle ja nicht ...
    [/quote]
    Extensions dokumentier ich so oder so - und zwar für mich.. arbeit grad an was eher länglichen, da bist sonst arm ;)

    georg

  • 1