Open Source Projekt Dokumentieren

[koli.bri]

Hallo ihr fleißigen Programmierer.

Der ein oder andere hat vielleicht schon mitbekommen, dass ich zur Zeit an einem Open Source-Spiel-System arbeite.
Zur Zeit ist es zwar noch ein "Ein-Mann-Projekt", da ich vor der ersten Veröffentlichung das Grundgerüst fertig haben will, aber dennoch verliere ich das Ziel, auch anderen Programmierer an dem Projekt teilhaben zu lassen nicht aus den Augen.
Doch wenn ich andere auf den Code stürmen lassen möchte, sollte das ganze ja auch gut Dokumentiert sein.

Nur, wie stelle ich das ganze an?
Angefangen von der eingesetzten Software (lieber per HTML/PHP mit Links und allem drum und drannn, oder via Latex als PDF), bbis zu der Art der Dokumentierung (Funktion für Funktion erklären, was die tun, mit Eingabe/Ausgabeparameter, etc)

Was muss alles drinstehen, worauf kann man eventuell verzichten, damit das ganze nicht überladen wird...

Wie fängt man an?
Reicht vielleicht ein ausführliches Pflichtenheft?
Sollte ich direkt ein ganzes Forum einrichten?

man merkt, ich hab sowas noch nie gemacht und ganz ehrlichh keinen Plan davon.
Das Projekt entsteht zur Zeit ohne jegliche Vorlage, schriftliches zur Planung habe ich eigentlich gar nicht, da ich eher der "Munter drauf los-Programmierer bin", der im Kopf hat, was alles getan werden muss, und dann Stück für Stück alles niederschreibt.


Also, was für tipps könnt Ihr mir geben, damit das Projekt einen guten Start in die Open Source Gemeinschaft erhält?

(Man möge mir verzeihen, dass ich diese Frage, obwohl sie zu einem Webprojekt gehört, im Programmmiererforum stelle)

mfg
Lukas

 

[oneOeight]

in welcher sprache machst du das denn überhaupt?
für die meisten sprachen gibt ja so automatische doku generierer, die sich aus dem code kommentaren die infos suchen und eine webseite machen (wie z.b. bei java)...
d.h. du solltest halt gut deinen code kommentieren...

unter welcher lizenz willst du es denn machen?
ich wüsste gerade nicht was ein pflichtenheft bei GPL nützen sollte...

 

[AxlF]

Hi,


also erstmal vorweg: Ich habe sowas auch noch nie gemacht, es haben sich einfach noch nie die richtigen Leute für meine Projekte gefunden. Aber ich habe mich damit Beschäftigt.

Da ich auch nicht genau weiß, was Du nun überhaupt programmierst und mit welcher Sprache, kann mein Tipp für Dich auch völlig daneben sein.

Ich würde ersteinmal Trac installieren. Das ist meiner Meinung nach für ein Open Source Projekt am besten, da es Hand in Hand geht. An Bord ist ein Wiki, ein SVN Browser, ein Ticketsystem, etc...
Vielleicht noch ein Forum und/oder eine Mailingliste einrichten. Dann hast Du eigentlich mal eine Solide Kommunikationsplattform geschaffen.

Bei einem grösseren Projekt, an dem auch mehrer gleichzeitig Entwickeln sollen, ist es meiner Meinung nach sehr sehr SEHR wichtig eine schriftliche Planung aufzusetzen. Das kann sonst sehr schnell unübersichtlich und letztendlich planlos werden.
Je mehr Infos die Entwickler bekommen, desto strukturierter und Zielnaher kommst Du Deinem Projekt. Also CodingGuidelines, Release Infos, etc...

Ich wünsche Dir auf jedenfall viel Erfolg bei deinem Vorhaben.

Viele Grüße,
Alexander

P.S.: Vielleicht hilft es Dir Dich bei anderen OpenSource Projekten umzukucken, wie die das machen.

 

[koli.bri]

Oh, an die Lizen hab ich ja auch noch gar nicht gedacht

Geschrieben ist es in PHP und JavaScript mit httpRequests (so halbes AJAX )
Wenns da was gibt, würd ich gleich im Kreise hüpfen.
Nachkommentieren an entscheidenen Stellen wäre im Prinzip das einfachste (was jetzt aber nicht den falschen eindruck erwecken soll, dass ich gar nicht kommentiert habe )

Mal gucken, was noch für Tipps/Anregungen kommen (noch nie dagewesenes wird freillich auch dankend engtgegengenommen)

mfgl
Lukas