Dokumentation mal übersichtlich

Hallo Oxid,

Im Vergleich zu den riesigen Bugs hier mal ein Kleinprojektvorschlag für die Version 5.0 ;). Wenn gewünscht, trage ich das auch in den Bugtracker ein.

Könnte man die ganzen alten Tutorials / Howtos mal aktualisieren? Das wäre doch mehr als anständig und obendrein eine ehrenamtliche Förderung der Oxid-Kultur.

Es scheint, als existierte kein verbindlicher Plan, in welcher Version ein Modul seine Einstellungen wo speichert und wie das wann in welcher übeschriebenen Klassen durch wen festgelegt werden muss. Diesen Krimskrams aus den Foren zusammensuchen zu müssen ist echt unschön.

</Ende Petition>

“Kleinprojektvorschlag” ist aber kaum untertrieben :smiley:
Kannst es gerne im Bugtracker eintragen, haben die Entwickler was zum lachen

mal abgesehen davon ist es ein Wiki und kann von jedem erweitert und ergänzt werden

Oh ein Wiki, dann wäre es toll, wenn die Programmierer das pflegen, die wissen dann sogar was sie schreiben können.

Nebenbei: Stört keinen, dass ich im englischen Forum schreibe, oder? Wenn doch, kann man das sicher verschieben.

[QUOTE=oxidusr324;115606]…wenn die Programmierer das pflegen…[/QUOTE]

Ja, wem sagst Du das - aber das sind halt Programmierer und keine Schriftsteller, leider :smiley:

[QUOTE=oxidusr324;115606]…Stört keinen, dass ich im englischen Forum schreibe, oder? [/QUOTE]
klar - hab ich bereits weitergereicht (hab keine Modrechte hier im internationalen Foren-Teil)

Geh doch mit einem guten Beispiel voran… Dann hätten die Entwickler eher Zeit die angeblich RIESIGEN Bug zu beheben.

Schnucki, wenn ich wüsste was ich schreiben soll, würd’ ich das doch vorher nicht nachlesen wollen, oder?

touché :smiley:

[QUOTE=oxidusr324;115610]Schnucki, wenn ich wüsste was ich schreiben soll, würd’ ich das doch vorher nicht nachlesen wollen, oder?[/QUOTE]

Damit du dich wohlfühlst… Mein Allerliebster, jeder kann eigendlich etwas im Wiki beitragen. Und sei es mit einem Text für die Anfänger der Anfänger. Nur mit fordern ist es leider nicht getan.

Stimmt, ich hätte das auch nicht für ein Kleinprojekt gehalten, aber so stiefmütterlich wie die Dokumentation behandelt wird, muss es offensichtlichlich eine Kleinigkeit sein. Große, wichtige Dinge werden immer priorisiert erledigt.

Außerdem sagen alle bekannten Standardwerke der Programmiererpsychologie dass sich Entwickler viel wohler fühlen, wenn man Ihnen keinen großen Berg Arbeit vorsetzt.

Hi,

von welcher Doku ist hier die Rede?

Gruß

Wiki, Tutorials etc.

Gesucht wird ein strukturierter Oxid-Leitfaden für Erweiterer und Anpasser. Angefangen mit Kapitel 1 - “Was Sie an Oxid erweitern können” bis ca. Kapitel 25 - “Die Datenbanktabellen und ihre Funktion”. Gerne auch als Wiki und mit der Voraussetzung dass jemand PHP kennt aber eben nicht Oxid.

Bildlich gesprochen das technische Handbuch im Unterschied zum Sack voller Post-it’s.

ohne so hilfreiche Dokus wie
/* sets Time */
public function setTime() {…}

und nicht aus 2010.

im 2013 wäre es dann:


/* set time */
public function setsTime() 

:smiley:

Sorry, aber jeder Fachinformatiker-Azubi im ersten Lehrjahr findet spätestens nach 30 Minuten den Weg zu dem Tutorial-Archiv, wo ihm “MVC” ins Auge springt, da weiß er wie es geht und wie es funktioniert. + 1 Tag drauf, um sich mit Smarty bekannt zu machen + die Beispiel-Anleitung abarbeiten + ein Paar Module auf GitHub / im eXchange anschauen und das wars schon. Der Einstieg dauert ca 1 Woche, maximal 2 bis alle Variablen und Namen halbwegs im Gedächtnis sitzen. (Eigene Erfahrung! War bei mir nicht anders: “das ist OXID, schaus dir an, morgen baust du ein Template dafür”)
Und Jemanden ohne minimaler Programmier-Kenntnisse zu erklären, wie er das Framework benutzen muss, ist genau so sinnvoll, wie einem Passagier zu erklären, wie er das Flugzeug landet. Es ist, beim besten Willen, auch nicht die Aufgabe der Programmierer.
Für die Entwickler gibts neben dem Forum auch eine Dev-Mailingliste.

Was man allerdings dem Shopbetreiber näherbringen könnte, ist die Frontend Anpassung. In dem Bereich bin ich Deiner Meinung und würde eine Tutorial-Reihe für nicht-Programmierer á la “OXID Template fur Dummies” begrüßen und sogar mithelfen.
Wollen wir das mal unter der “Community-Driven”-Motto an die große Glocke hängen? Ich bin mir sicher, da finden sich noch mehr Leute, die ihr Wissen für andere zugänglichen machen würden.

Vielleicht kann Hebsaker ja auch für etwas Vorgeschmack ein Paar Informationen zu Confluence durchsickern lassen :wink:

Confluence ist suuuper! :slight_smile:

Aber mal ernsthaft, das soll kommen und würde das bisherige MediaWiki ablösen. Zeitplan kann ich aber noch nicht sagen.

Na klar kann man alles alleine lernen. Aber das ist doch nicht der Sinn eines Produkts. Eine Doku soll einen Einstieg bieten, Orientierung geben - nicht Programmieren unterrichten.

Es gibt so viele Frameworks da draußen jedes mit seiner Philosophie. Warum soll man sich die (meistens Unterschiede) selbst erarbeiten? Wenn Oxid möchte dass andere deren Framework nutzen, können sie doch Starthilfe geben.

Auch ein Azubi spart Tage, Fehler und Trial&Error wenn er es aktiv erklärt bekommt, und freut sich dann ein Loch in den Bauch.

Um den Fokus mal auf Post #1 zurückzulenken geht es auch primär darum, dass es zwar einiges gibt, aber leider überhaupt nicht aktuell oder gebündelt.

Hi,

Es gibt jeweils aktuelle Sourcecode- sowie Datenbankdoku (wird noch erweitert). Es gibt Tutorials auf der OXIDforge, wo jeder mitschreiben kann. Es gibt ein Handbuch, das derzeit aktualisiert wird. Es gibt ein Archiv für das Handbuch für ältere Versionen. Es gibt ein Anwenderhandbuch, es wird ein Entwickler-Kochbuch geben. Wo möchtest Du gern mitschreiben?

P.S.: confluence ist noch nicht in trockenen Tüchern, ergo noch nicht spruchreif.

Gruß

Danke für das kurze Statement.

Du formulierst das Problem sehr treffend. Wenn ich richtig gezählt habe: 3x “wird noch” und 1x “ist nicht mehr aktuell”.

Ich würde gerne an den Erweiterungen mitschreiben, bin aber auf eine aktuelle Doku angewiesen. Übrigens genau wie bei PHP und MySQL - die ich ja auch nicht erst selbst dokumentieren muss.

Hi,

falsch gezählt :wink:
Sourcecode- und DB-Doku sind immer aktuell. Ein Buch ist fertig, ein anderes wird momentan geschrieben. Das Handbuch befindet sich in ständiger Änderung.

Ich mache einen Kontakt mit unserer Dokumentation, dann schauen wir weiter :wink:

Gruß

Danke fürs Aufgreifen und Weiterleiten. Ich sehe das bei Community-Versionen als Erfolg.

Kleine Bitte: Verschieb doch den Thread in den deutschen Zweig.