Ich hab gestern beim Chat mit Grufo festgestellt das es fr potentielle neue Coder schwer ist sich in phpChrystal einzuarbeiten. Da es an Entwickler-Dokumentationen mangelt.
Es mangelt halt an ner. Beschreibung der phpChrystal eignene Klassen, Strukturen, Datentypen etc.
Evtl. knnte man noch die Benutzer-Dokumentation. Auerdem sollte man gerade die User-Docs aktuell halten und essentielle Vorgnge darin Beschreiben. Quasie Howtos. Fr den Sitzplan, Eingangslisten usw.
Mir schwebt zur Zeit ne Dokumentation im CHM Format vor. Das ist allerding fr Linux-User mist. Da wre denk ich ne Lsung in PHP besser. Das klammert allerding nich ganz so bewanderte User aus.
Auf alle Fllle sollte die Dokumentation durchsuchbar sein.
Ich fnd es genial wenn jeder mal seine Meinung dzu uern wrde.
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
Anonymous
-
2003-02-12
Also ich dachte erst ich mach das in XML hab das dann aber doch erstmal verworfen, da ich nicht so bewandert darin bin. Ich mach in den nchsten 14 Tagen (den Zeitraum fass ich absichtlich ein wenig grer, da ich grad sehr beschftigt bin) ein neues Doku-Design imd readme.xml style entwerfen. Die wird dann auch durchsuchbar sein. Wir sollte sie hier bei SF online stellen und per Nightly-Tar downloaden lassen knnen, oder
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
Die Idee an sich finde ich ausgezeichnet, nur will ich darauf hinweisen, dass ich mich um die Dokumentation nur schwerlich auch noch kmmern kann. Klar bei Fragen stehe ich gerne zur Verfgung, aber generell werde ich daran nicht arbeiten, da ich mit dem Programmieren an sich mehr als gut ausgelastet bin.
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
Anonymous
-
2003-02-13
Dafr habst du ja auch Chmee Schatzi und mich... *G*
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
Ich hatte nicht vor die Arbeit noch auf Goldenhawk abzuwlzen. Eher hatte ich das mal fr mich ins Auge gefasst.
Mir geht auch nicht so um die User-Documentation.
Sondern mehr um die fr Entwickler. Da es halt noch keine Klassen Beschreibung o.. Das wollte ich als Ziel setzen so ne Dokumentation zu erstellen. Und zu pflegen
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
ich finde das ganze sollte auf einer ganz einfachen basis gebaut sein - html!
und zwar vom einfachsten, hnlich wie bei selfhtml!
einfaches design und einen guten index dazu - dann findet man schnell was man sucht oder braucht.
und zur wartung braucht man auch keine besonderen tools - max. einen html editior! - online stellen ist auch kein problem :-)
die idee finde ich wunderbar, wenn das ganze dann noch in kategorien unterteilt ist, dann findet man z.b. alles zum tabellenaufbau in wenigen sekunden - also genau das was ich fr phpchrystal schon immer gebraucht hab!
If you would like to refer to this comment somewhere else in this project, copy and paste the following link:
Ich hab gestern beim Chat mit Grufo festgestellt das es fr potentielle neue Coder schwer ist sich in phpChrystal einzuarbeiten. Da es an Entwickler-Dokumentationen mangelt.
Es mangelt halt an ner. Beschreibung der phpChrystal eignene Klassen, Strukturen, Datentypen etc.
Evtl. knnte man noch die Benutzer-Dokumentation. Auerdem sollte man gerade die User-Docs aktuell halten und essentielle Vorgnge darin Beschreiben. Quasie Howtos. Fr den Sitzplan, Eingangslisten usw.
Mir schwebt zur Zeit ne Dokumentation im CHM Format vor. Das ist allerding fr Linux-User mist. Da wre denk ich ne Lsung in PHP besser. Das klammert allerding nich ganz so bewanderte User aus.
Auf alle Fllle sollte die Dokumentation durchsuchbar sein.
Ich fnd es genial wenn jeder mal seine Meinung dzu uern wrde.
Also ich dachte erst ich mach das in XML hab das dann aber doch erstmal verworfen, da ich nicht so bewandert darin bin. Ich mach in den nchsten 14 Tagen (den Zeitraum fass ich absichtlich ein wenig grer, da ich grad sehr beschftigt bin) ein neues Doku-Design imd readme.xml style entwerfen. Die wird dann auch durchsuchbar sein. Wir sollte sie hier bei SF online stellen und per Nightly-Tar downloaden lassen knnen, oder
Die Idee an sich finde ich ausgezeichnet, nur will ich darauf hinweisen, dass ich mich um die Dokumentation nur schwerlich auch noch kmmern kann. Klar bei Fragen stehe ich gerne zur Verfgung, aber generell werde ich daran nicht arbeiten, da ich mit dem Programmieren an sich mehr als gut ausgelastet bin.
Dafr habst du ja auch Chmee Schatzi und mich... *G*
Ach gottchen wie putzig *g*
Ich hatte nicht vor die Arbeit noch auf Goldenhawk abzuwlzen. Eher hatte ich das mal fr mich ins Auge gefasst.
Mir geht auch nicht so um die User-Documentation.
Sondern mehr um die fr Entwickler. Da es halt noch keine Klassen Beschreibung o.. Das wollte ich als Ziel setzen so ne Dokumentation zu erstellen. Und zu pflegen
Wrde mich freuen. Wollte irgendwann auch mal was beitragen.
also hier noch mein senf dazu :-)
ich finde das ganze sollte auf einer ganz einfachen basis gebaut sein - html!
und zwar vom einfachsten, hnlich wie bei selfhtml!
einfaches design und einen guten index dazu - dann findet man schnell was man sucht oder braucht.
und zur wartung braucht man auch keine besonderen tools - max. einen html editior! - online stellen ist auch kein problem :-)
die idee finde ich wunderbar, wenn das ganze dann noch in kategorien unterteilt ist, dann findet man z.b. alles zum tabellenaufbau in wenigen sekunden - also genau das was ich fr phpchrystal schon immer gebraucht hab!