webEdition - Forum

Hallo

Die Seite documentation.webedition.org ergibt sich mir noch nicht ganz.

Unter http://documentation.webedition.org/wik ... playground finden sich Testeinträge. Tatsächliche Benutzer der Dokumentation könnte das ggf. verwirren, bzw. es ist ja schon nervig wenn man sich da erstmal durchgeklickt hat um dann in der letzten Ebene festzustellen, dass das ganze gar keinen Inhalt hat.

In der Core-Dokumentation unter http://documentation.webedition.org/core/ kann ich mir die ganze Dokumentation gar nicht ansehen, sehr wohl aber die Liste der Fehler Das ist ja irgendwie auch nicht zielführend im Sinne des OpenSource - Entwicklungsgedankens, oder?

In der eigentlichen webEdition Dokumentation wiederum ist irgendwie keine richtige Struktur erkennbar. Ist ja schonmal nicht soo 100% verständlich wenn ich von http://documentation.webedition.org auf "webEdition Dokumentation" gehe, dann Playground, Wiki, Deutsch - und Englische Dokumentation auswählen kann (Na was ist es nun, eine Dokumentation oder ein Wiki oder eine Kombination oder vielleicht doch ein Playground?) und wenn ich mich dann für die tatsächliche Dokumentation in einer Sprache entschieden habe, dann stehe ich nochmal vor der Wahl ob ich denn wirklich etwas über webEdition oder doch lieber etwas über PHP oder JavaScript oder eines der anderen Themengebiete erfahren möchte. Wobei ... auch die Unterteilung ist wieder nicht ganz klar, denn in webEdition finden sich sehr wohl auch PHP basierte Lösungen. Und so eine allgemeine Befehlsreferenz für PHP und JavaScript ist (aus meiner Sicht) auch nicht hilfreich, wenn ich mich als Benutzer in der webEdition Doku befinde.

Bin ich dann aber bei der wirklichen Dokumentation von webEdition die ich suche (über http://documentation.webedition.org [Englischsprachige Übersichtsseite] > webEdition Documentation [Deutschsprachige Übersichtsseite] > Dokumentation (deutsch) > webEdition) finden sich hier Punkte wie Codebeispiele, Problemlösungen, Frameworks einbinden (ohne JQuery aber dafür mit allem anderen ^^), Validierungsdienste (?? als Linkliste).

Ich weiß nicht - ich frage mich eben nur, ob die Dokumentation jetzt wirklich so zielführend ist. Ich finde es macht nach außen eher den Eindruck, dass das so ein Sammler aus allen möglichen Projekten ist. Playground, Linksammlungen (egal ob we bezogen, oder doch eher Entwicklungsgrundlagen, Validationsdienste, etc.), Fehlerbehandlung usw.

Ist das nicht eine Stelle, an der wir hier aus der Community auch mal konkret weiterhelfen können - auch ohne konkret in die Programmierung einzusteigen?

Viele Grüße
Martin

Hallo Martin,

kurze Antwort:
ja, es ist ein Sammelsurium aus verschiedenen Ansätzen im Laufe der Jahre.

Und JA! Du kannst da gerne weiterhelfen. Es wird langfristig vier Bereiche geben:
1. Wiki
2. Tag-Referenz
3. Core Doku (da müsstest Du alles sehen können, nur ist der Core bisher nur zum kleinen Teil mit den nötigen php Doc Blöcken ausgezeichnet, das kommt in diesem Jahr)
4. ggf. die API-Doku für die Entwicklung von Apps, wobei diese eventuell in 3. aufgehen wird.

Ja nun lasst euch doch nicht alles aus der Nase ziehen Dann her mit den konkreten Handlungsaufforderungen oder zumindest mit nem Vorschlag wie wir weiter vorgehen könnten.

@Thomas: auf jeden Fall funktioniert die phpdoc nicht wirklich:
http://documentation.webedition.org/cor ... tants.html

@Carrera: ich stimme dir da jedenfalls zu. Das was an Doku da ist, ist nicht wirklich zu gebrauchen. Leider traut sich nie einer, etwas hier mal zu löschen!

Es gab schon ein paar mal das Ansinnen von Leuten sich um die Doku zu kümmern - ist aber immer im Sande verlaufen...

Aus der Doku sollte zum einen das Englische raus (wenn es eh nicht da ist), dann alles, was nichts mit WE zu tun hat.
Die http://www.we-devedge.de/ sollte mal abgeschaltet werden.
Dann würde ich am ehesten einen neuen Bereich anlegen und dort die relevanten Teile aus we:devegde und der alten Doku übernehmen und um neue ergänzen.

Hier muß halt einer einfach mal anfangen - bisher wurde immer nur drüber geredet. Da es ein Wiki ist, sollte es vermutlich reichen wenn man einen Account hat. Keine Ahnung ob man für die Verschiebungen mehr Rechte braucht? Thomas?

Hallo Marc,

phpdoc schaue ich mir an, da läuft unsere JiffyBox gerade amok.

Ich bin ja seit kurzem der Doku Beauftragte und stehe unter anderem mit Dirk Einecke wegen der we-devedge in Kontakt. Das wird alles in diesem Jahr besser werden. Ab August habe ich mehr Zeit, mit dann auch intensiver um Wiki etc. zu kümmern. Ich habe dann auch kein Problem rigoros zu löschen...

@Martin: wir brauchen keinen großen Wurf mehr, kein riesen Konzept. Sondern erst einmal im Wiki strukturierter z.B. HowTos / Tutorials. Da kannst Du heute schon anfangen.

Hallo Thomas, also WÜRDE man mich in die Aktualisierung der Dokumentation einbinden, würde ich in keinem Fall auch nur einen ersten Schritt machen bevor ich mir den vorher sehr gut überlegt und das ganze mal zu Papier gebracht habe.

Welche Infos braucht man an welcher Stelle,
wie würde ein Benutzer suchen,
welche 'Arten' von Querverlinkungen machen wo Sinn,
nach welchen Blöcken sollte man Gliedern?

Du ganz ehrlich. Dann stecke ich da doch lieber nochmal 5 Stunden Denkarbeit rein, bevor in 2 Jahren dann mal wieder jemand feststellt, dass die Struktur die vorhanden ist eigentlich wieder gar nicht so richtig das gelbe vom Ei ist Ist ja nicht nur, dass dann die Arbeit für den Eimer war, sondern auch die Zeit die bis dahin vergangen ist, kann keiner mehr zurück holen um sich im 'Wettbewerb' mit anderen CMS zu halten. Und dazu, genauso wie zur Umsetzung wäre ich natürlich entsprechend bereit! Das ist für mich keine Frage.

Hallo Martin,

Du kannst da gerne auch noch 5 Stunden Denkarbeit reinstecken. Jedoch haben schon 5 verschiedene Personen da mehrmals mehrere Stunden Denkarbeit reingesteckt, versucht, eine richtige Struktur zu finden etc. Das Ergebnis siehst Du aktuell. Letzlich müssen wir im Ehrenamt immer mit den (zeitlichen) Ressourcen arbeiten, die da sind und daraus das beste machen.
Wenn Du diese Zeit gerade hast, mache gerne eine Konzeptidee!

Hallo miteinander,

Ich kann mir gut vorstellen mich an diesem Prozess (Konzeption aber auch Umsetzung) zu beteiligen. Meine Zeit ist zwar auch sehr beschränkt, aber ein bisserl was geht ja immer .

Cheers,
Sascha

Ja gut, war vielleicht auch gut gemeint, aber irgendwie finde ich die Denkarbeit darin nicht wieder. Sicher weil jeder auf das aufgesetzt hat was schon da war. Ich mache mir mal Gedanken und teile meine Vorstellungen dann hier mit. Dann kann ja konstruktiv darüber diskutiert werden, was Sinn macht und was nicht.

@Sascha, @Martin:

sehr gerne! Das einfachste ist wirklich, "live" im Wiki (das soll unser System sein, weil alles andere u.a. deutlich mehr Arbeit in der Vorbereitung erfordert) einen neuen Bereich einzurichten und dort anzufangen.

Aber gerne richte ich uns auch einen Bereich in unserem Projektmanagement Tool ein, in dem wir unsere Gedanken austauschen können. Wenn ihr daran interesse habt, schickt mir bitte eine PM mit der E-Mail Adresse, die ich dort eintragen darf.

Gerade macht es für mich erstmal Sinn das hier zu machen. Solang die Beteiligung so überschaubar ist, ist es mir lieber alles an Feedback und Gedankengut mitzubekommen, das vorhanden ist. Sollte hier irgendwann ein Schwall an Menschen unsachlich herumdiskutieren kann man immernoch umschwenken Oder wie seht ihr das? Generell ist doch alles gut was Aktivität und Interesse weckt.

Ich bin ja seit kurzem der Doku Beauftragte und stehe unter anderem mit Dirk Einecke wegen der we-devedge in Kontakt. Das wird alles in diesem Jahr besser werden. Ab August habe ich mehr Zeit, mit dann auch intensiver um Wiki etc. zu kümmern. Ich habe dann auch kein Problem rigoros zu löschen...????

@all: Wer bei der Dokumentation mithelfen möchte, kann sich einfach unter http://documentation.webedition.org/wiki/de/webedition/ registrieren und loslegen. Wir werden unsere Aktivitäten erstmal auf hier konzentrieren, da es sich auch um eine Wiki-Software handelt.

Herzlichen Dank und viele Beiträge

Andreas