[phpBB Debug] PHP Warning: in file [ROOT]/ext/tas2580/seourls/event/listener.php on line 213: Undefined array key "FORUM_NAME"
[Gemeinschaftsprojekt] Doumentiertes Tutorial - REDAXO Forum
Hallo,

Wir haben in letzter Zeit festgestellt, dass die Kommunikation via Slack viel schneller und zielführender ist als ein Beitrag im Forum. Aufgrund der neuen und besseren Möglichkeiten der Kommunikation haben wir uns entschlossen das Forum nur noch als Archiv zur Verfügung zu stellen. Somit bleibt es weiterhin möglich hier nach Lösungen zu suchen. Neue Beiträge können nicht mehr erstellt werden.

Wir empfehlen, für deine Fragen/Probleme Slack zu nutzen. Dort sind viele kompetente Benutzer aktiv und beantworten jegliche Fragen, gerne auch von REDAXO-Anfängern! Slack wird von uns sehr intensiv und meistens "rund um die Uhr" benutzt :-)
Selbst einladen kannst Du dich hier: https://redaxo.org/slack/
Benutzeravatar
Sascha
Beiträge: 27
Registriert: 3. Jan 2008, 00:06

[Gemeinschaftsprojekt] Doumentiertes Tutorial

28. Jan 2008, 11:14

Idee
  • Ein dokumentiertes Tutorial was von einigen "freiwilligen" Redaxo-Nutzern zusammengestellt wird, was den Einstieg in Redaxo vereinfachen soll. (kann dann z.b. bei Redaxo.de eingepflegt werden)

    Es wird z.b. ein Einstiegs-System (Demo) für Redaxo entworfen. Aber Halt!

    Es geht nicht um die Demo, die Demo ist nur das Grundgerüst worauf sich die Thematik solch eines Projektes aufbaut. Man könnte nämlich es so machen das jeder Entwickler seine Schritte dokumentiert (z.b. im Quelltext kommentare setzt oder im forum was dazu schreibt) und so später ein oder mehrere Artikel entstehen die einen Redaxo-Neuling auf der Reise zu der funktionierenden Demo-Seite begleiten.

    Der Clou dabei wären die Teilnehmer die ihre Arbeiten kommentieren würden und somit ihre Kniffe und Tricks dem Neuling mit auf dem Weg geben würden. Ebenfalls würde schon bei der Entstehung eines Moduls/Aktion dokumentiert was die paar Zeilen Code eigentlich gerade bewirken. Womit


Begründung
  • Redaxo ist (soweit mir bekannt) das flexibelste CMS im deutschsprachigen Raum. Doch auch wenn mit Einfachheit geworben wird, schreckt das CMS auf den ersten Blick ab wenn man nur andere Systeme gewöhnt ist.

    Kommt man nun von CM-Systemen wie Joomla/Wordpress/Contrexx ist man Flexibilität nicht gewöhnt. Doch trotzdem suchen einige Webmaster immer weiter nach besseren CM-Systemen um die Arbeit zu beschleunigen und immer mehr Kontrolle zu erlangen.

    Anfangs sind solche Ansprüche noch gering das Systeme wie phpkit z.b. ausreichen. Doch steigern sich diese über die Jahre hinweg bis man neben Joomla/Contrexx z.b. nach mehr Flexibilität sucht und dann bei Systemen wie Redaxo landet.

    Aber um ehrlich zu sein, muss mann erst nach Dieser suchen um überhaupt darauf zu kommen das Redaxo diese dank Module/Aktionen sehr einfach in die Tat umsetzen kann.

    Um Umsteiger den Einstieg in Redaxo zu erleichtern wäre somit solch ein dokumentiertes Tutorial der beste Einstieg. Gerade weil sie hier gleich lernen wie Redaxo eigentlich aufgebaut ist.

    Zwar haben wir eine Dokumentation, doch nicht jeder versteht diese auf Anhieb (z.b mangels PHP Erfahrung usw.) und muss erst den Hintergrund langsam erforschen ehe ihm die Dokumentation sofort verständlich vorkommt.


Umsetzung
  • 1) Wir planen zusammen was für eine Demo wir entwickeln wollen. Also worum es bei der Demo-Seite geht und was alles zum Einsatz kommt.

    2) Nachdem die Freiwilligen eingeteilt wurden, entwickeln diese in ihrem jeweiligen Fachgebiet die Module, Layouts und Aktionen für das System. Dabei dokumentieren sie aber ihren Quellcode (nur PHP, HTML/CSS sollte ja bekannt Grundwissen sein) so gut es geht, damit ein Leser der eventuell noch nie davon gehört hat versteht was die Variablen und Schleifen eigentlich bedeuten und was sie machen und wie Redaxo mit ihnen umgeht.

    3) Die Demo wird aufgesetzt und getestet, fehlende Punkte werden von wem hinzugefügt und die Seite mit Inhalt gefüllt bis alle zufrieden sind. (weiter dokumentiert)

    4) 1-2 freiwillige versuchen nun die Entwicklung zu rekonstruieren und verfassen einen Artikel o. Wiki-Artikel anhand der dokumentationen, welche später von den bisherigen Entwicklern eventuell noch vervollständigt wird.
So etwas müssten wir nicht von heute auf morgen machen oder schaffen. Aber über die Monate hinweg könnte man sicherlich so Schritt für Schritt eine weitere interessante Einstiegshilfe entwickeln welche nicht nur den Einstieg verbessern, sondern zugleich interessierten und Besuchern klar machen wie flexibel Redaxo eigentlich ist.

Sorry für den Text, war eine Idee und da ich grundsätzlich Ideen vergesse muss ich sie aufschreiben.

Benutzeravatar
Markus.Staab
Entwickler
Beiträge: 9634
Registriert: 29. Jan 2005, 15:50
Wohnort: Aschaffenburg/Germany
Kontaktdaten: ICQ Website

28. Jan 2008, 11:46

Hi Sascha,

ich fände das ganze prinzipiell gut. Das ganze könnte man dann so gestalten wie den askeet kalender. Hier sollte also auch die Beschreibung und Begründungen der versch. Vorgehensweisen erläutert werden.

Sowas wäre sicherlich dann auch interessant ums auf redaxo.de zu veröffentlichen. Hier liegt das ganze natürlich an der community sich zu organisieren und einen federführenden User bräuchte man dann sicher auch..

Gruß,
Markus

Benutzeravatar
jdlx
Beiträge: 2615
Registriert: 29. Sep 2005, 10:50
Wohnort: Hamburg
Kontaktdaten: Website

28. Apr 2008, 17:17

Hallo Sascha,
Sascha hat geschrieben:Idee

Ein dokumentiertes Tutorial was von einigen "freiwilligen" Redaxo-Nutzern zusammengestellt wird, was den Einstieg in Redaxo vereinfachen soll.
Ich habe so ne Art "beginner's guide" schon ein paarmal begonnen, aber der Aufwand ist nicht zu unterschätzen. Akutell habe ich für meine Kunden ein paar Basics versucht so zusammenzuschreiben, daß auch wirklich unbedarfte irgendwie klarkommen, und ich nicht bei jedem neuen Projekt alles haarklein von vorne erzählen muß: http://quickstart.f-stop.de (Bereich Basics, der Bereich Erweitert ist von ner alten Version rübergezogen, und as is eigentlich veraltet und unbrauchbar.. gleichwohl kommt er dem was du für Addon/Modul/.. -Entwicklung ansprichts evtl. ein Stück weit nah)

Schon diese wenigen Seiten des Basics Bereichs waren nicht gerade mal so dahingeschrieben - ich hab da ziemlich lang gefeilt an Formulierungen und Strukturierung, hab unbeleckte querlesen lassen um zu sehn obs "ankommt" - dann noch screenshots einfügen usw.. das zieht sich derbe. Und so wies jetzt dasteht ist es auch schon stellenweise veraltet, denn zusammengestellt hatte ich das um die Zeit des 3.2.x -> 4.x Übergangs, d.h. diverse Aussagen und die screenshots sind einfach schon wieder veraltet.

Jedes Modul/Addon/.. sauber zu dokumentieren, auf einer eigenen Demo-Seite in Anwendung zu zeigen (so wie ich das ein Stück weit im Bereich "Erweitert" versucht hab), und dann in so ein Demo/Tutorial dingens einzupflegen wäre natürlich ne feine Sache, erfordert aber von allen Beteiligten echten Willen und nicht unerhebliche Arbeit.

Bei der Gelgenheit müßte man am besten auch gleich guidelines für coding und Dokumentation einführen.. evtl. einen "Entwickler-Status" für Leute deren Werke eine gewisse Gestaltungshöhe erreichen bzw. Signifikanz für Redaxo als Gesamtsystem, usw.. Auch den code dann ab dieser Schwelle im CVS abzulegen wäre sehr hilfreich für alle Beteiligten.

Neben dem Wert als "endlich" mal handfeste Anlaufstelle für Neulinge auf der einen Seite, und zentrale Stelle für coding Fragen, würde ich mir eine Entlastung des Forums versprechen.. Es ist schön das Redaxo immer mehr Zuspruch findet, aber das bildet sich im Forum leider so ab, daß imho inzwischen deutlich mehr noise entsteht..

Kurz: Ja, fände ich gut, aber es Bedarf imho schon im Vorfeld einiges an Vorarbeit um überhaupt ein sinnvolles und flexibles framework dafür zu erstellen. Der status quo, wo sich Informationen disparat auf Doku, Wiki und Forum verteilen ist wirklich nicht optimal.. imho sollten die Infos aus Doku, Wiki, Modul/Addon-Beschreibung dann in so ein know-how-framework mirgiriert bzw. abgebildet werden, und das Forum wirklich nur noch für Fragen herhalten müssen die dort nicht abgedeckt werden.

Das is n dicker Fisch, und ohne Mithilfe von Jan/Markus/.. beim Aufsetzen einer Lösung eh nicht zu wuppen, zumindest nicht sinnvoll - und ehrlich gesagt gehe ich davon aus das die einfach kaum Kapazitäten haben werden.

my2¢, aber gern bereit mich zu engagieren wenn es Hand und Fuß zu haben verspricht..

lg,
Jan

Zurück zu „Allgemeines [R4]“