Plugin-Doku

[rolinux]

Hallo Plugin-Coder,

einige der Plugins versteht man erst, wenn man sie ausführlich getestet hat und weiß auch erst dann, ob man sie wirklich brauchen kann und wie man sie verwendet.

Ich habe die Bitte, dass Ihr Euren Plugins eine ausführlichere Doku der Funktionalität und der Einstellungsmöglichkeiten beilegt (am besten im Plugin-Admin oder zumindest dort verlinkt, wenn's zuviel Text ist, vielleicht sogar mit Hardcopys, wie das Ergebnis aussehen kann), damit man als User evtl. schon vor der Installation besser entscheiden kann, ob sich das Plugin eignen könnte und ob man sich eine z.T. langwierige Testphase antun möchte.

Ich stehe z.B. grade vor der Frage, ob ich meine trickreich gebastelte 3. Menüebene auf einer Homepage durch das MENUES-Plugin ersetzen soll.
Um das Plugin zu testen und herauszufinden, ob sich die Umstellung lohnt, müsste ich aber in Kauf nehmen, dass ich evtl. erstmal einen Teil der Homepage zerschieße und einige Dateien von einer Kategorie in eine andere verschieben muss, nur um herauszufinden, wie man das Plugin anwendet und ob das dabei rauskommt, was ich möchte.

Doku schreiben ist lästig, ich weiß. Aber die Benutzerfreundlichkeit von mozilo sollte in den Plugins weitergeführt werden. mozilo richtet sich auch an CMS-Anfänger, und auch die haben Wünsche, die mit den Plugins evtl. abgedeckt werden können.
Ihr kennt Euer Plugin, der Anwender nicht.

Gruß
Rolf

[HoMe]

Hallo Rolf,
grundsätzlich kann ich dich unterstützen, aber ich muss auch sagen, dass du fürn kostenfreies System ganz schön hohe Erwartungen hast.
Ich bin auch froh, wenn ich vieles beschrieben bekomme, von dem was möglich ist. Allerdings ist es auch so, dass viele Funktionen sehr individuell einsetzbar sind (und das ist gut so), daher auch schwierig zu beschreiben. Ich denke, du kannst aber die Coder und Programmierer der Plugins sehr unterstützen, wenn du slebst Vorschläge zur Dokumentation einbringst oder auch im Forum postest.

Hey und mal ganz ehrlich, ein wenig Bastelei gehört doch nun mal dazu.
Ein Tipp fürs ausprobieren, einfach Subdomains anlegen und dort testen oder aber offline auf dem System zu Hause.
Funktioniert ganz gut und du musst dir nicht deine Seiten zerschießen.



HoMe

[azett]

Danke für die ehrliche Kritik. Ausprobieren kann sicher lehrreich und spannend sein, ist aber natürlich nicht jedermanns Sache.
Bei vielen Plugins steht bereits eine kurze Beschreibung im Pluginarchiv, auch lohnt sich immer mal ein Blick in die Kommentare der Plugin-index.php. (Die von mir persönlich entwickelten Plugins dokumentiere ich außerdem seit Kurzem ausführlich auf meiner eigenen Website, auf die ich aus dem Pluginarchiv heraus verlinke.)

Wir schreiben uns das aber hinter die Ohren und geloben Besserung Ist halt immer auch eine Zeitfrage...

[azett]

Konnte es in der Zwischenzeit mal ausprobieren...sooo schlecht ist das MENUES-Plugin gar nicht dokumentiert. Details hier

[hausl78]

Super wäre wenn "man sich" also "wir uns" bzw. "ihr euch"      auf einen Standard der Dokumentation einigen.. Bisher haben wir ja:

- Beschreibung im Plugin-Archiv wo man des downloaden kann
- die index.php des plugin selbst
- die Beschreibung im Plugin die dann in der Plugin-Conf angezeigt wird
- eine zusätzliche redame.txt im Plugin-Dir
- Homepage des schreibers..

Ist mir schon klar das es je nach Umfang schwierig sein kann (zB beim calendar Plugin) alles in die Plugin-Conf reinzuknallen aber so ist es irgendwie auch sub-ideal wenn alles an 5 möglichen Stellen verteilt ist...

Und DIE Super-Drüber-Idee hab ich natürlich nicht, ich nörgel nur mal!    

[azett]

Ich seh da ganz klar die Beschreibung im Pluginarchiv als führend. Steht dort alles drin, ist alles gut; möchte der Plugin-Autor die Doku etwas detaillierter gestalten (z.B. auf einer eigenen Website), sollte das in der Pluginbeschreibung stehen (in diesem Fall eben ein Link). Denkbar wäre auch eine liesmich.txt im Plugin-Verzeichnis oder Kommentare in der index.php oder [...] - Hauptsache, in der Pluginbeschreibung steht, wo man die Infos findet.