webEdition: Fokus auf die Dokumentation

Fragen und Infos zur Installation & Update von webEdition.
mokraemer
Senior Member
Beiträge: 3619
Registriert: So 8. Aug 2010, 01:23
Wohnort: Mainz

webEdition: Fokus auf die Dokumentation

Beitragvon mokraemer » Mo 19. Apr 2021, 21:24

Mit dem heutigen Erscheinen von webEdition 9.0.8 stellen wir die Entwicklung bis auf weiteres ein!

Wir werden in uns in den nächstens Wochen und Monaten nur der Dokumentation widmen, die von der Community immer zugesagt, aber nie in Angriff genommen wurde. Das traurig Bild davon findet sich unter
https://documentation.webedition.org. Das Forum kann kein Ersatz für eine fehlende Dokumentation sein. Mit der Entwicklung von webEdition 9, gab es zudem viele Neuerungen die den wenigstens bekannt sein dürften. Da wir diesen Zustand in der Form nicht länger dulden möchten, werden wir nun die Dokumentation selbst in die Hand nehmen und entsprechend dazu die weiteren Arbeiten an webEdition bis auf weiteres einstellen.
webEdition-Kern-Entwickler

WBTMagnum
webEdition Partner
webEdition Partner
Beiträge: 1825
Registriert: Di 7. Mär 2006, 16:50
Wohnort: Wien
Kontaktdaten:

Re: webEdition Entwicklung wird vorerst zurückgestellt - Fokus auf die Dokumentation

Beitragvon WBTMagnum » Mo 19. Apr 2021, 22:19

Hallo Marc,

Der Titel des Posts hat mich jetzt kurz geschockt :shock: :shock: :shock: und könnte schnell mal falsch verstanden werden.
Daher folgender Alternativvorschlag für den Betreff: "webEdition Entwicklung wird vorerst zurückgestellt - Fokus auf die Dokumentation".

Gibt es irgendwo Infos wie man an der Überarbeitung mitwirken kann? Sind Redaktionsmeetings o.ä. geplant?

Liebe Grüße,
Sascha

mokraemer
Senior Member
Beiträge: 3619
Registriert: So 8. Aug 2010, 01:23
Wohnort: Mainz

Re: webEdition: Fokus auf die Dokumentation

Beitragvon mokraemer » Di 20. Apr 2021, 09:43

Konkrete Planungen haben wir nicht dazu. Ich stelle mir das ähnlich wie bei wikipedia vor, jeder trägt das bei, was er kann, oder überarbeitet bestehendes.
Primär will ich hier kein wie beginnt man mit webEdition, oder was ist ein Dokument machen (dazu kann es sich entwickeln). Sondern vielmehr Übersichtsseiten zu
[*] Modulen
[*] interessanten Funktionen (Cache, davfs, Sitzungsdauer, Cookies, Bildeditor, CodeEditor, Tiny, Hooks, .....)
[*] Problemen und Lösungen (Install, Migration, Update, ...)

Auch können die alten Artikel als Grundlage genutzt werden um sie entweder wegzuwerfen, weil es die Funktion nicht mehr gibt, oder wir die Unterstützung so nicht mehr wollen (php statt we-tags) oder sie eben zu überarbeiten und auf den aktuellen Stand zu bringen.
webEdition-Kern-Entwickler

ThomasGoebe

Re: webEdition: Fokus auf die Dokumentation

Beitragvon ThomasGoebe » Di 20. Apr 2021, 13:18

Vom Grundsatz her finde ich die Processwire Doku ganz ok: https://processwire.com/docs/
Das System hat einen leicht anderen Ansatz (letzlich ist es "nur" ein Framework und eine API das Frontend ist auch damit gebaut), aber gerade die API Referenz (= Tag Referenz?) und die Tutorials fand ich oft hilfreich. Vielleicht kann sich da etwas abgeschaut werden?

Dazu kann ich noch sagen, dass bei Bedarf auch Inhalte aus dem webEdition Buch genommen werden können. Zumindest "meinen" Part kann ich freigeben, Andreas hat da meines Wissens auch nichts gegen. Die Rechte sind an uns Autoren zurückgegangen, als der Verlag die Arbeit eingestellt hat. Aber leider ist das inzwischen schon sehr veraltet und eben doch mehr eine grundlegende Beschreibung gewesen.

Bei Processwire macht der Entwickler m.E. die Doku. Bei jeder neuen Funktion wird das gleich mitgedacht und gemacht (und ggf. im Blog dann noch mal mit Beispielen gefüttert). Klar, die Basis ist da bereits vorhanden und die Deltas zwischen den Versionen sind ziemlich klein.

Ich kann mir nur schwer vorstellen, wie bei den vielen Änderungen in webEdition jemand die Doku aktuell halten soll, der die Dinge nicht mitentwickelt oder zumindest bei der Planung der Änderungen involviert war. Wie soll ich ein neues Feature / eine Änderung nur aus einem Mantis Eintrag heraus im Detail beschreiben? Aber vielleicht fehlt auch nur mir da die Phantasie.

mokraemer
Senior Member
Beiträge: 3619
Registriert: So 8. Aug 2010, 01:23
Wohnort: Mainz

Re: webEdition: Fokus auf die Dokumentation

Beitragvon mokraemer » Di 20. Apr 2021, 13:25

@Thomas: vielen Dank für die Konstruktiven Hinweise. Werde ich mir anschauen. Meine Vorstellung ist da wie gesagt ähnlich wie bei Wikipedia, jeder trägt etwas bei und in Summe entsteht hier etwas. Wenn es Artikel gibt, die vorhanden sind, können die Entwickler diese ja auch ergänzen und danach geht jemand bspw. textlich noch mal drüber.
webEdition-Kern-Entwickler

mokraemer
Senior Member
Beiträge: 3619
Registriert: So 8. Aug 2010, 01:23
Wohnort: Mainz

Re: webEdition: Fokus auf die Dokumentation

Beitragvon mokraemer » Mo 26. Apr 2021, 14:55

Die Erstellung der Doku kommt langsam voran. Wir würden uns hier sehr über Mithilfe freuen.
webEdition-Kern-Entwickler

WBTMagnum
webEdition Partner
webEdition Partner
Beiträge: 1825
Registriert: Di 7. Mär 2006, 16:50
Wohnort: Wien
Kontaktdaten:

Re: webEdition: Fokus auf die Dokumentation

Beitragvon WBTMagnum » Mo 26. Apr 2021, 21:28

Hallo Marc,

Ich würde schon gerne was beitragen. Die Frage ist, wo und wie? Gibt es hier schon infos zum "Einstieg"?

Liebe Grüße,
Sascha

mediavantis
Senior Member
Beiträge: 238
Registriert: Do 16. Feb 2012, 12:51

Re: webEdition: Fokus auf die Dokumentation

Beitragvon mediavantis » Di 27. Apr 2021, 08:35

Hallo,

ich schließe mich der Frage von Sascha an.
Darüber hinaus hätte ich aber auch gerne erfahren, ob die Entwicklungspause auch die Beseitigung von Bugs betrifft?

mokraemer
Senior Member
Beiträge: 3619
Registriert: So 8. Aug 2010, 01:23
Wohnort: Mainz

Re: webEdition: Fokus auf die Dokumentation

Beitragvon mokraemer » Di 27. Apr 2021, 09:55

Es geht wie schon beschrieben
a) um das Sichten vorhandener Doku (http://documentation.webedition.org/suche.php) - alles mit dem Präfix "old"
b) die Neuordnung und Ergänzung

Unter https://documentation.webedition.org sind schon die ersten Ansätze zu erkennen. Es muß noch über Design/Navigation etc. nachgedacht werden - z.T. sollte das mit Timo abgesprochen werden.
Ansonsten kann und sollten bspw. häufige Fragen aus dem Forum aufgenommen werden - das macht es auch leichter hier, wenn man nicht alles x-mal erklären muß, sondern auf eine "Hilfeseite" verweisen kann, die gepflegt und erweitert wird.
Auch unsere Update-Historie kann ein Ansatz sein um Sachen die dort nicht ausreichend beschrieben wurden genauer zu erläutern. Die Historie wurde manchmal recht ausführlich, statt ein Dokument dafür zu schreiben - den Text sollte man da raus ziehen.

Wir sind aber durchaus auch für Vorschläge offen - ich denke nur, das es einfacher ist, es sich entwickeln zu lassen, als zu viel vorzuplanen.
webEdition-Kern-Entwickler

mediavantis
Senior Member
Beiträge: 238
Registriert: Do 16. Feb 2012, 12:51

Re: webEdition: Fokus auf die Dokumentation

Beitragvon mediavantis » Di 27. Apr 2021, 10:15

Bleibt noch immer die Frage, ob die Entwicklungspause auch die Beseitigung von Bugs betrifft?

mokraemer
Senior Member
Beiträge: 3619
Registriert: So 8. Aug 2010, 01:23
Wohnort: Mainz

Re: webEdition: Fokus auf die Dokumentation

Beitragvon mokraemer » Di 27. Apr 2021, 10:31

ja, natürlich - sonst wäre es keine Entwicklungspause. Je schneller wir voran kommen, desto schneller arbeiten wir wieder daran.
webEdition-Kern-Entwickler

mediavantis
Senior Member
Beiträge: 238
Registriert: Do 16. Feb 2012, 12:51

Re: webEdition: Fokus auf die Dokumentation

Beitragvon mediavantis » Di 27. Apr 2021, 11:06

Ich muss zugeben, dass ich von dieser Antwort nicht gerade begeistert bin, zumal die Fertigstellung von Projekten u. a. von der Beseitigung des einen oder anderen Bugs abhängt.

Es kann doch nicht sein, dass man sich mit neuen Projekten in die 9er-Version stürzt (u. a. um diese Entwicklung zu unterstützen) und dann in einer zeitlichen Sackgasse hängt, nur weil eine Entwicklungspause ausgerufen wird. Da hätte ich doch lieber gleich die 8.1.5 genommen...

Die Doku muss nebenher laufen!!! So kann es jedenfalls nicht gehen! Zumal man mal eben vor vollendete Tatsachen gestellt wird.

ThomasGoebe

Re: webEdition: Fokus auf die Dokumentation

Beitragvon ThomasGoebe » Di 27. Apr 2021, 12:52

mokraemer hat geschrieben: Di 27. Apr 2021, 09:55 Es geht wie schon beschrieben
a) um das Sichten vorhandener Doku (http://documentation.webedition.org/suche.php) - alles mit dem Präfix "old"
b) die Neuordnung und Ergänzung

Unter https://documentation.webedition.org sind schon die ersten Ansätze zu erkennen. Es muß noch über Design/Navigation etc. nachgedacht werden - z.T. sollte das mit Timo abgesprochen werden.
Ansonsten kann und sollten bspw. häufige Fragen aus dem Forum aufgenommen werden - das macht es auch leichter hier, wenn man nicht alles x-mal erklären muß, sondern auf eine "Hilfeseite" verweisen kann, die gepflegt und erweitert wird.
Auch unsere Update-Historie kann ein Ansatz sein um Sachen die dort nicht ausreichend beschrieben wurden genauer zu erläutern. Die Historie wurde manchmal recht ausführlich, statt ein Dokument dafür zu schreiben - den Text sollte man da raus ziehen.

Wir sind aber durchaus auch für Vorschläge offen - ich denke nur, das es einfacher ist, es sich entwickeln zu lassen, als zu viel vorzuplanen.
Hallo Marc,
ich verstehe tatsächlich den Sinn / das Ziel der Doku so nicht.
Meine Vorüberlegungen:
  • es gibt seit mehr als 10 Jahren keine nennenswerte explizite Dokumentation
  • die Bestandsnutzer von webEdition nutzen hauptsächlich die Tag-Referenz (die relativ aktuell gehalten wird), das Forum, die Release Notes sowie Mantis wenn Sie vor Fragen / Problemen stehen
  • Neue Nutzer sind zumindest mit Blick von außen nicht der Fokus von webEdition
Unter diesen Vorannahmen schlage ich vor: die jetzige Doku totlegen und mehr in die Tag-Referenz investieren. D.h. dort z.B. neue Beispiele einfügen, die ja auch aus der Community kommen können (siehe auch php.net). Die Tag-Referenz wird der Dreh- und Angelpunkt der Dokumentation. Sich wiederholende Fragen müssen (wie früher bei we:devedge) eben als Beispiel einmal zu dem entsprechenden Tag gesetzt werden. [edit] Einzelne Themen aus den Release Notes werden Tags zugewiesen und erscheinen entsprechend auch in der Tag-Referenz. [/edit]
Baut also die Struktur so, dass "die Community" die Tag Referenz um erklärte Beispiele ergänzen kann, macht einen kurzen Einleitungsteil, wie webEdition grundsätzlich funktioniert (zwei oder drei Tutorials, die zum Teil ja auch schon da sind) und dann kann die Entwicklung weitergehen.

Der andere Ansatz einer ausführlichen Dokumentation oder eines Community basierten Wikis wird effektiv doch seit Jahren weder intensiv verfolgt, gepflegt noch wirklich vermisst.

mokraemer
Senior Member
Beiträge: 3619
Registriert: So 8. Aug 2010, 01:23
Wohnort: Mainz

Re: webEdition: Fokus auf die Dokumentation

Beitragvon mokraemer » Di 27. Apr 2021, 13:31

Neue Nutzer sind zumindest mit Blick von außen nicht der Fokus von webEdition
Und genau das ist auch ein Fehler, über den wir seit Jahren diskutieren.

Aber auch den Aktiven fehlt eine Doku - du kannst den Tiny nicht in den Tags erklären. Oder wie ein Cache funktioniert. Wo soll webDav von WE dokumentiert werden?
Wer bekommt denn aktuell mit, warum wir neue Versionen machen und wo die Vorteile liegen??? Die Doku ist eben auch elementar für ein Projekt.

Wir hätten den Schritt deutlich früher machen sollen. Aber besser spät als nie.
webEdition-Kern-Entwickler

Benutzeravatar
Finn
Senior Member
Beiträge: 285
Registriert: Mo 3. Apr 2017, 13:37
Wohnort: Bremen
Kontaktdaten:

Re: webEdition: Fokus auf die Dokumentation

Beitragvon Finn » Mi 28. Apr 2021, 12:08

Ich finde es richtig und gut die Doku mal auf den aktuellen Stand zu bringen! Gerade Entwickler, die neu ins System einsteigen, tun sich bei WE sehr schwer. Die Tag-Referenz ist kein Ersatz für eine solide Dokumentation. Da das Erstellen einer Doku aus der Community in den letzten Jahren immer wieder versandet ist, müssen die Entwicklungen für einen Zeitraum zurückstehen.

Dringende Bugfixes sollten im besten Fall natürlich trotzdem passieren.
Finn Thorwarth
WG Werbeagentur
https://www.wg-werbeagentur.de


Zurück zu „webEdition Installation & Update“

Wer ist online?

Mitglieder in diesem Forum: Google [Bot] und 13 Gäste