dedlfix: Arbeitsmethodik, Dokumentation

Beitrag lesen

Hi!

Es gibt das PHPDoc-Format.
Mir war doch so, aber mir fiel der Begriff nicht ein. Müffelt allerdings sehr nach Javadoc.

Ja.

Oh, und wo wir gerade beim Wiki sind: Wikis *können* das Schreiben der Doku an eine Community auslagern.

Darum geht es hier vermutlich nicht, aber wenn man schon Trac aufsetzt, kann man es auch gleich für die Dokumentation nutzen.

Wenn ich das Bedürfnis habe, an der Doku mitzuwirken, kann ich den Entwicklern Patches schicken.

Das geht nur dann effizient, wenn auch die Dokumentation als Quelltext vorliegt. Mit einer CMS-gepflegten sieht das schon anders aus. Letzlich muss man sicher den Aufwand gegeneinander aufwiegen. Es ist ja nicht nur, dass du nach der Korrektur einen Patch erstellen muss, du wirst ihn vor dem Absenden auch noch mit einem Anschreiben versehen. Und am anderen Ende braucht es Ressourcen, den Patch einzupflegen.

Lo!