Die Dokumentation ist so gut!

Ich liebe die Contao-Dokumentation!

Sie ist die beste Dokumentation von allen CMS und soviel besser als die von TYPO3 oder Wordpress. Am allerbesten gefällt mir, dass ich jedes mal Suchanfragen multilingual in 2 Sprachen mache und in diesem tollen Forum so lange nach Antworten suche wie der Tag Stunden hat. Das Farbschema ist wesentlich angenehmer, der schön gestaltete Banner beruhigend und man trifft soviele nette Menschen. Bei Stackoverflow bekommt man immer sofort einen grünen Haken und das geht alles viel zu schnell.

Auch das mit den Manages gefällt mir! Man hat sich soviel Mühe dabei gemacht, speziell was die offizielle Dokumentation und Abgrenzung voneinander angeht, das ist sofort auf den ersten Blick ersichtlich und schön verständlich!

- manager-plugin
- manager-bundle
- managed-edition
- contao-manager
- extension-manager

Was mir auch gut gefällt ist die Entwicklerdokumentation, weil man einfach auf die Symfony Docs verweist und sich die Menschen den Rest dann selbst zusammen reimen sollen. Das ist sehr gut! Weil moderne Entwickler_Innen sitzen nämlich alle alleine in einem dunklen kalten Keller und lesen den ganzen Tag Source-Code mit PhpStorm und Ctrl-Click! Diese brauchen keine Fähigkeiten sich miteinander auszutauschen und es geht eh alles über den Code, den kennt man ja auswendig. Generell gehe ich sowieso davon aus, dass jeder Entwickler da draußen in dieser Blase lebt. Alle Menschen arbeiten bereits jeden Tag, ununterbrochen und überhaupt nur mit Contao. Deswegen finde ich es so gut, dass man soviel Wert auf diese Dokumentation legt!

Ach nicht schon wieder so'n mimimi.

Weißt Du wovon Open Source lebt? Davon das sich Leute einbringen und nicht mit ihrem 4. Post eine verbale Meckerkeule schwingen. Wenn Du etwas wissen möchtest; frage, nett und freundlich. Wenn Du etwas weißt: helfe, nett und freundlich. Und das beste: Jeder ist herzlich eingeladen Dokumentationen zu schreiben und/oder sich mit seinem Wissen im Wiki zu verewigen.

Ok, habe jetzt einige Beiträge geschrieben und geholfen wo ich kann. Gehe jetzt schlafen und morgen schau ich mir mein Problem nochmal an. (Meine Extension wird nicht aus /src geladen, obwohl via autoload und contao-manager-plugin angegeben)

Ja, mit dem Theme von dem Forum hier könnte ich auch nicht arbeiten, habe es bei mir mit Greasemonkey verändert.
Vorher
Anhang 19987
Nachher
Anhang 19986

Abgesehen von dem Ärger, der vielleicht einfach mal raus musste, sind etliche Kritikpunkte leider berechtigt. Die Dokumentation – sowohl für Anwender aber insbesondere auch Entwickler – müsste dringend mal ergänzt und aktualisiert werden! Und das Theme des Forums könnte man sicherlich auch hinsichtlich Lesbarkeit optimieren.

Lediglich die Aussage, man träfe im Forum keine netten Menschen, kann ich aus meiner Erfahrung nicht nachvollziehen.

Hier übrigens eine gute Begriffserklärung und Abgrenzung zwischen all dem Managing ^^ http://www.numero2.de/news/contao-4-...l-komfort.html

Hi Glumanda,

Kritik hier im Forum ist eine schwierige Sache. Meist fahren dann Forenschwergewichte (incl. Moderatoren/innen ... von lat.: moderare = mäßigend) die Krallen aus, fühlen sich in die Defensive gedrängt und holen zum Gegenschlag mit der Open-Source-Keule oder dem Mimimi-Prügel aus. Und wenn das Ganze - so wie in Deinem Beitrag - pointiert formuliert passiert, heizt es es die Eskalation proaktiv eher noch an.

Was also tun? Ehrlich gesagt, keine Ahnung. Contao ist ein wirklich tolles CMS. Aber es gibt da so eine unsichtbare Barriere mitten im Konzept, die man als "normaler" Anwender nur ganz schlecht überwinden kann. Entweder man steigt richtig ein (entsprechende Skills vorausgesetzt), investiert richtig viel Zeit und Herzblut und braucht dann keine Dokumentation mehr, oder man bleibt ewig der Anfänger, der nur 20% der Möglichkeiten von Contao nutzt. Mit sehr viel Mitleid seitens der Contao-Kenner, muss man nicht rechnen. Ich würde gerne mal eine Erweiterung schreiben (Ideen wären genügend da), aber ich habe bis heute kein für mich wirklich nutzbares Tutorial gefunden.

Vielleicht liegt es in der Natur der Open-Source-Sache, das sie einfach mit kommerziellen Produkten nicht verglichen werden sollen. So wie vielleicht auch Dir, ist es mir nicht möglich an Konferenzen teilzunehmen und mich (der mangelnden Skills wegen) aktiv einzubringen. Es wurde mir gesagt, wenn ich eine Dokumentation benötige, dann solle ich gefälligst eine schreiben. IMO geht das etwas an dem "root cause" des Problems vorbei, aber das ist die aktuelle Community-Meinung.

PT

Zitat:

---

Zitat von Pan Tau

IMO geht das etwas an dem "root cause" des Problems vorbei, aber das ist die aktuelle Community-Meinung.

---

Wohl eher nicht, wie Du aus meinem obigen Kommentar entnehmen kannst.

Ich bin auch der Meinung die Doku ist stark verbesserungswürdig. Ich bin gemäss Webseite sogar dafür zuständig. Ich kann nur leider nicht gleichzeitig Contao Core, Contao Manager, Association Vorstand UND Doku machen. Wir haben schon mehrfach versucht das Thema Doku anzugehen, aber es scheitert bisher an der Zeit und Einsatzwillen aller beteiligten. Die Entwicklerdoku werden wir auf dem Camp weiter pushen, da gibt's bereits absprachen. Und die Doku wird möglicherweise durch die Association neu aufgelegt, aber da gibt es noch nichts Konkretes.

Das Hauptproblem bei einer Dokumentation ist auch nicht, dass jemand die Sachen niederschriebt. Ich hätte kein Problem damit, Features die ich zum Core beitrage zu dokumentieren. Das Problem ist, dass sich jemand um die Struktur einer Doku kümmern muss und zwar aktiv. Ich denke 10% des Aufwands ist der Dokumentation eines Features zuzuschreiben, 90% sind Dinge wie

• wo gehört der Artikel hin
• wie sturkturiert man den Artikel besser, so dass er sich ähnlich liest, wie alle anderen
• wie findet man den Artikel?
• etc.

Konkretes Beispiel: Letzte Woche wurde mein Pull Request gemergt, der es Entwicklern erlaubt, Module/Inhaltselemente etc. als richtige Symfony Controller zu schreiben. Das ist ein riesiges Feature! Die wichtigsten Infos dazu liessen sich vielleicht in einer Stunde zusammenfassen. Das würde ich sogar tun. Aber dann müsste der Beitrag verbessert und ergänzt werden. Jemand müsste versuchen, ihn zu verstehen und nachfragen/entsprechend ergänzen. Dann an einem sinnvollen Ort in der Dokumentation platzieren, so dass das Handbuch in sich Sinn ergibt. Das kann man nur, wenn man das gesamte Handbuch kennt und es regelmässig aktiv überprüft, Inhaltsverzeichnisse aktualisiert etc. Also gäbe es diesen "jemand", dann würde ich was zusammenschustern und dann à la "hier hast du Futter, mach was Tolles draus" weitergeben.
Open Source lebt eben von den Beiträgen aller und ich persönlich kann nicht mehr Zeit investieren. Es geht schon so viel drauf in die Core-Entwicklung, dass es schlichtweg nicht drin liegt. Schreiben ist ausserdem auch nicht meine Kernkompetenz und ich will meine Energie lieber in den Code investieren. So ist das nun mal. Jeder macht das worauf er am meisten Lust hat.

Die Symfony Dokumentation ist sehr gut. Aber man darf nicht vergessen, dass sie auch an extrem wenig Leuten hängt. Also wer mal nachsieht wer die letzten 2 Jahre aktiv geschrieben hat (https://github.com/symfony/symfony-d...7-10-17&type=c), dann sieht man dass die Hauptarbeit (Struktur etc.) von gerade mal 4 Personen kommt. 4 Personen die man im Symfony-Umfeld entsprechend auch kennt und wertschätzt.
Symfony's wöchentliche Beiträge kommen auch von genau einer Person. Javier, der auch zu den 4 Personen gehört, die aktiv Doku schreiben.

Damit man es sich nochmal vor Augen führen kann: Symfony wird über 48 Millionen Mal pro Monat (!!!) heruntergeladen, hat über 300'000 registrierte Entwickler in der Community (wer weiss wie viele damit arbeiten ohne da registriert zu sein) und von all denen haben gerade mal 1'500 Entwickler jemals was zum Core von Symfony beigetragen und - im Vergleich dazu lächerliche - 4 Personen kümmern sich aktiv um die Doku.
Es wäre ein absoluter Glücksfall für Contao und seinem Bruchteil der Community, wenn wenigstens einer sich um eine Doku kümmern würde.

Jeder hier weiss um die Wichtigkeit von Dokumentation. Jeder hier hätte gerne eine tolle Dokumentation. Aber einer muss anfangen, ein Team um sich herum aufbauen und es wirklich tun wollen und eben auch mal aktiv auf die Leute zugehen und nach Infos fragen, damit sie dokumentiert werden können.

Wenn es diesen "jemand" gibt, dann kriegt er/sie ziemlich sicher viel freie Hand und kann komplett selber bestimmen wie er/sie vorgehen möchte. Und da man beim Dokumentieren lernt, wird er/sie automatisch zu einem/einer der fähigsten Symfony/Contao-Entwickler(innen), soviel ist klar :)

@Toflar - ggf. solten wir dies in einer Session auf dem Contao Camp besprechen

Zitat:

---

Zitat von Glumanda

Hier übrigens eine gute Begriffserklärung und Abgrenzung zwischen all dem Managing ^^ http://www.numero2.de/news/contao-4-...l-komfort.html

---

Ja, wirklich gut. Sowas müsste eigentlich auf contao.org

Ich bekomme ja täglich die Tickets aus https://github.com/contao/docs. Für alle, welche jetzt denke, dass sich da gar nichts tut. Doch, es gibt Freiwillige, welche sich regelmäßig dort beteiligen. Auf jeden Fall vielen Dank schon mal an all diejenigen.

Hallo in die Runde,

ich möchte einen Gedanken beitragen... ich habe dank der Typolight- und Contao-Bücher von Leo Feyer und Peter Müller den perfekten Zugang zu diesem wunderbaren CMS gefunden und bin jeden Tag aufs Neue dankbar, Contao kostenlos nutzen und damit Geld verdienen zu dürfen. Auch ich habe seit Contao 4 viele neue Fragen und finde nicht immer gleich die passenden Antworten.

Vielleicht liegt das Problem der Dokumentation an der seltsamen Erwartungshaltung, dass diese ebenfalls ehrenamtlich zusammengetragen und kostenlos bereitgestellt wird. Warum eigentlich? Ein gutes Buch, selbst wenn es 200 Euro kosten würde, hätte sich mit dem ersten Contao-Projekt vielfach bezahlt gemacht. Eine Online-Doku könnte sich über einen kostenpflichtigen Zugang (Jahresbeitrag) amortisieren. Ferner gibt es Education-Portale wie udemy.com wo man Video-Tutorials gegen Entgelt zugänglich machen kann.

Vielleicht motiviert dieser Gedanke jemanden dazu die Ärmel hochzukrempeln und die Contao-Doku als Geschäftsmodell zu entwickeln. Dann würde es damit auch schneller vorangehen. Ich glaube, es wäre trotz Kosten ein großer Gewinn für alle.


Gruß Karl

Vielen Dank, Toflar. Ich stimme dir vollständig zu mit deiner Einschätzung der notwendigen Arbeiten - sofern man eine professionelle Dokumentation anstrebt (s.u.).

Zitat:

---

Zitat von Toflar

... Die wichtigsten Infos dazu liessen sich vielleicht in einer Stunde zusammenfassen. Das würde ich sogar tun. ...

---

Ich fände es besser als nichts, wenn du diese Infos tatsächlich aufschreibst und z.B. im Wiki ablegst. Von dort könnte der von dir beschriebene und notwendige Prozess losgehen und vielleicht (hoffentlich) irgendwann im Handbuch oder einer anderen Doku landen.
Es scheint mir ein typischer Deadlock zu sein: wer Doku sucht kann sie mangels Wissen nicht selbst schreiben, wer Wissen hat, weiß nicht wo er es in Rohfassung hinterlegen kann - und falls es diesen 'jemand' geben sollte, der alles zusammen führt und strukturiert, der wüsste nicht, welche Infos es überhaupt gibt.

So sehr ich die Leistung der genannten 4 Symphony-Leute bewundere, es kann eigentlich nicht das Ziel sein, eine Person zu finden, die diese riesige Arbeit in 200% ihrer Arbeitszeit (unbezahlt) stemmt. Insofern wäre mir eine uneinheitliche und möglicherweise ungeschickt strukturierte Doku - so wie der alte Ansatz im Contao-Wiki es war - lieber als keine Doku mangels Struktur und Pflege.

Ein dezentral entwickeltes Open Source Projekt sollte sich auch dezentral dokumentieren lassen :D - Ja, ich sehe auch, dass das nicht funktioniert. Die Frage lautet also, wie man das besser anregen könnte?Glücklicherweise haben wir das Wissen in den Köpfen der wandelnden Contao-Lexika hier im Forum!

Ich vermute, dass die meisten Fragestellungen, wegen denen man in eine Dokumentation schauen würde, sich in ein paar Kategorien unterteilen lassen (kein Anspruch auf Vollständigkeit):

• Installation (da mit C4 die Konfiguration des Servers einen viel größeren Einfluss hat, ist dieses Thema nun sehr komplex geworden)
• Standard Usecases und Best Practices für häufige Anwendungsfälle
• Doku für Redakteure (sofern das nicht durch bestehende Bücher abgedeckt ist)
• Erweiterungs-Entwicklung, wichtigste Techniken, Tipps und Tricks... (Beispiele)
• API Dokus, Models etc.

Es gab hier im Forum mal Beiträge der Art "Tagebuch einer Extension-Entwicklung". Sicher keine Dokumentation, aber eine Möglichkeit auch für 'Halbwissende', sich an einer Wissenssammlung zu beteiligen.

Gruß, folkfreund

Fragt nicht was Contao für euch tun kann, fragt was ihr für Contao tun könnt!!!

Zitat:

---

Zitat von Glumanda

Fragt nicht was Contao für euch tun kann, fragt was ihr für Contao tun könnt!!!

---

Denkst Du wirklich, dümmlicher Sarkasmus ist dass Stilmittel der Wahl um eine zielführende Diskussion an zustoßen?

Hallo Stefko,

es hilft mir einen besseren Ton zu wahren, sonst sind meine Beiträge immer so hasserfüllt.

Zitat:

---

Zitat von Glumanda

es hilft mir einen besseren Ton zu wahren, sonst sind meine Beiträge immer so hasserfüllt.

---

Dann lass es doch einfach. Niemand zwingt dich.

Zitat:

---

...Beiträge immer so hasserfüllt

---

Wenn es nichts mehr zu sagen gibt, setzt der Weise dem eigenen Sarkasmus dort die Grenze.

Zitat:

---

Ich fände es besser als nichts, wenn du diese Infos tatsächlich aufschreibst und z.B. im Wiki ablegst. Von dort könnte der von dir beschriebene und notwendige Prozess losgehen und vielleicht (hoffentlich) irgendwann im Handbuch oder einer anderen Doku landen.

---

Das würde ich sehr, und nochmal sehr, begrüssen!
Den auch wenn ich als reiner DAU-Coder nicht alles verstehen würde, hätte ich vielleicht doch einen kleinen Einblick und zudem die Möglichkeit konkretere Fragen zu stellen/googln.

Das gilt übrigens für viele Extensions die nicht immer so selbsterklärend sind wie der/die Entwickler das glauben, und ein kleiner Eintrag in das Wiki könnte das Try&Error etwas reduzieren.

Gruß dtptiger

Zitat:

---

Zitat von dtptiger

Das gilt übrigens für viele Extensions die nicht immer so selbsterklärend sind wie der/die Entwickler das glauben, und ein kleiner Eintrag in das Wiki könnte das Try&Error etwas reduzieren.

---

Für mich als Extension-Entwickler - dessen Dokus leider oft auch sehr mickrig ausfallen - wäre es eine großartige Hilfe, wenn jemand sein Try&Error dokumentieren würde und bei mir einreichen. Wie du schon sagst, als Entwickler kennt man seine Erweiterung und sieht daher einige Stolpersteine. Ein Blick von außen wäre hilfreich.

Weil ich selber davon noch kaum Plan habe, habe ich mal ne Seite im Wiki erstellt, welche ich mir wünsche. Wäre schön, wenn diejenigen mit Kenntnissen dort in kurzen klaren Worten dokumentieren könnten. http://de.contaowiki.org/Ordner_und_Dateien_in_Contao_4

Hallo Andreas,


sowas sollte eigentlich in die allgemeine Contao Doku eingebaut werden und nicht ins Wiki (meiner Meinung nach). Ich halte grundsätzlich nichts davon, alles über mehrere Quellen zu verteilen, sondern alles zentral zu halten. Auch aus dem Grund, alles unter *.contao.org abzulegen und den Benutzer nicht mit verschiedenen Domains zu verwirren (--> offizielle Contao Quellen). Oder man bindet das Wiki generell mal unter einer Subdomain wie z.B. wiki.contao.org ein...

@Andreas

I had already written a cookbook on this subject.

The structure is certainly no longer up to date with the 4.4 ...

I agree with jscholtysik; Even if the wiki is a great project, it would be nice to gather as much information as possible on the official website docs.contao.org

Zitat:

---

Zitat von Andreas

Weil ich selber davon noch kaum Plan habe, habe ich mal ne Seite im Wiki erstellt, welche ich mir wünsche. Wäre schön, wenn diejenigen mit Kenntnissen dort in kurzen klaren Worten dokumentieren könnten. http://de.contaowiki.org/Ordner_und_Dateien_in_Contao_4

---

Erledigt, macht was draus. :)

Zitat:

---

Zitat von jscholtysik

sowas sollte eigentlich in die allgemeine Contao Doku eingebaut werden und nicht ins Wiki

---

Aus Sicht des Lesers und Ratsuchenden sicherlich!
Nur kann dann leider die Community nicht daran mitarbeiten.

Ich schlage eine zweischienige Vorgehensweise vor: jeder Willige/Kundige ergänzt im Wiki und "irgendjemand" überträgt das in die offizielle Doku. Der erste Schritt scheint mir viel erfolgversprechender als der zweite - leider. Das ist keine Anschuldigung an die, denen das möglich wäre, sondern schlicht der Tatsache geschuldet, dass diese Leute schon sowieso viel tun. Damit sind wir dann wieder bei den oben erwähnten 4 Personen...

Zitat:

---

Zitat von folkfreund

Nur kann dann leider die Community nicht daran mitarbeiten.

---

Doch. Die Community kann auch an der offiziellen Contao-Dokumentation mitarbeiten, zumal diese öffentlich in einem GitHub-Repository gepflegt wird. Genauso wie im Contao Wiki hat man hier also die Möglichkeit, neue Beiträge zur Dokumentation einzureichen oder bereits bestehende Artikel zu verbessern.

Wieder was gelernt :-)

Zitat:

---

Zitat von lionel

@Andreas

I had already written a cookbook on this subject.

The structure is certainly no longer up to date with the 4.4 ...

---

Ah, thank you. I searched for "contao 4 ordner und dateien" but didn't find anything.

Zitat:

---

Zitat von xtra

Erledigt, macht was draus. :)

---

Ja, hab gesehen. Ich dachte mir gleich, dass du das warst, wegen ü = ue ;). Vielen, vielen Dank.

Zitat:

---

Zitat von jscholtysik

Ich halte grundsätzlich nichts davon, alles über mehrere Quellen zu verteilen, sondern alles zentral zu halten.

---

Stimme voll und ganz zu.

Zitat:

---

Zitat von jscholtysik

sowas sollte eigentlich in die allgemeine Contao Doku eingebaut werden

---

Ja, du kannst die Infos von dort gerne in die Doku übertragen.

Ich bleibe erstmal im Wiki, dort ist das einfacher und die Einträge müssen nicht erst von jemandem Kontroll gelesen werden. Außerdem kann ich dort in einer Sprache schreiben, die auch Nicht-Entwickler verstehen. Ich werde bei @xtra teilweise noch nachfragen und es dann "übersetzen" ;). Z.B. verstehe ich schon nicht, was "Konfigurationsparameter der Anwendung" bedeutet, mir ist nich klar, welche Anwendung damit gemeint ist, Composer, Symfony oder Contao.

Zitat:

---

Zitat von Andreas

Z.B. verstehe ich schon nicht, was "Konfigurationsparameter der Anwendung" bedeutet, mir ist nich klar, welche Anwendung damit gemeint ist, Composer, Symfony oder Contao.

---

Mit "Anwendung" ist die Symfony Anwendung gemeint, welche somit gleichzusetzen mit Contao ist (denn Contao ist ja eine Symfony Anwendung).
Man koennte auch "Installation" schreiben, jedoch ist dies im deutschen leider auch das Wort fyr die Taetigkeit, weshalb ich mich fyr Anwendung entschied.

Zitat:

---

Zitat von Andreas

Ja, du kannst die Infos von dort gerne in die Doku übertragen.

Ich bleibe erstmal im Wiki, dort ist das einfacher und die Einträge müssen nicht erst von jemandem Kontroll gelesen werden. Außerdem kann ich dort in einer Sprache schreiben, die auch Nicht-Entwickler verstehen. Ich werde bei @xtra teilweise noch nachfragen und es dann "übersetzen" ;). Z.B. verstehe ich schon nicht, was "Konfigurationsparameter der Anwendung" bedeutet, mir ist nich klar, welche Anwendung damit gemeint ist, Composer, Symfony oder Contao.

---

Da muss ich doch mal die Firma Ricola zitieren: Wer hat's erfunden?

Wäre schön, wenn Du das dann machst, denn Du hast diese Teil-Doku ja auch angefangen. Warum also noch eine weitere Person "beauftragen"?

Ich finde schon, dass auch ein Wiki kontrollgelesen werden sollte, denn dann habe ich kein Problem mit falschen oder veralteten Informationen. Und genau das wird ja auch in der Doku "verhindert", denn ich kann hier nicht einfach irgendwelche Informationen reinschreiben und gleich freigeben, sondern erst nach Freigabe durch eine andere Person. Quasi auch ein Pull-Request wie beim Core auch.

Das mit der Doku ist ein grundsätzliches Problem, das vielleicht mal auf dem Camp besprochen werden sollte, wie es denn generell mit der Doku weitergehen soll. Andreas Schempp hat ja schon einen Slot angeregt, auf der zumindest mal die technische Dokumentation "besprochen" und erweitert werden soll.

Zitat:

---

Zitat von folkfreund

Ich schlage eine zweischienige Vorgehensweise vor: jeder Willige/Kundige ergänzt im Wiki und "irgendjemand" überträgt das in die offizielle Doku. Der erste Schritt scheint mir viel erfolgversprechender als der zweite - leider. Das ist keine Anschuldigung an die, denen das möglich wäre, sondern schlicht der Tatsache geschuldet, dass diese Leute schon sowieso viel tun. Damit sind wir dann wieder bei den oben erwähnten 4 Personen...

---

Das ist einfach doppelte Arbeit, die unnötig ist... Gleich ins richtige System eintragen und gut ist es.

Zitat:

---

Zitat von jscholtysik

Wäre schön, wenn Du das dann machst, denn Du hast diese Teil-Doku ja auch angefangen. Warum also noch eine weitere Person "beauftragen"?

---

Ich habe nur die Struktur dort geschaffen, die Erklärungen kommen momentan von @xtra (und die ganz einfachen Sachen auch von mir) und sollten von Leuten kommen, welche wirklich Symfony kennen und die Entwicklung von Contao 4 begleitet haben.

Um eine ähnliche Struktur mit den github docs zu schaffen, müsste ich mich erst zu tief einlesen um zu sehen, was dort damit möglich ist. Dazu habe ich gerade keinen Nerv und keine Zeit. Du kannst in den github docs gerne diese Struktur schaffen. Ich werde dann auch die eine oder andere Erklärung beisteuern.

Zitat:

---

und sollten von Leuten kommen, welche wirklich Symfony kennen und die Entwicklung von Contao 4 begleitet haben.

---

Genau das ist eben nicht der Fall! Genau das ist das Problem. Derjenige der es kennt und die Entwicklung eines Features vorangetrieben hat, wird es nicht dokumentieren. Er kennt ja bereits alles. Wozu soll er es dokumentieren, er hat ja nichts davon? Er ist zudem selten in der Lage es so zu dokumentieren, dass es jemand anderes versteht, weil die Sicht eines Unwissenden fehlt.

Was wir brauchen ist ein Team von Leuten die gerne dokumentieren, sich aktiv die nötigen Infos einholen und das aufschreiben. Deswegen meinte ich, dass so jemand automatisch zu einem der fähigsten Contao-Entwickler wird, weil er von allem Wind kriegt und alles versteht.

Zitat:

---

Zitat von Toflar

Er ist zudem selten in der Lage es so zu dokumentieren, dass es jemand anderes versteht, weil die Sicht eines Unwissenden fehlt.

Was wir brauchen ist ein Team von Leuten die gerne dokumentieren, sich aktiv die nötigen Infos einholen und das aufschreiben. Deswegen meinte ich, dass so jemand automatisch zu einem der fähigsten Contao-Entwickler wird, weil er von allem Wind kriegt und alles versteht.

---

Genauso ist es. Ich weiß wovon ich Rede. Ich habe technische Dokumentation mal ein paar Jahre beruflich gemacht.

Und da beißt sich gelegentlich die Katze sogar in den Schwanz, denn sobald man das nötige Wissen hat, fehlt möglicherweise schon wieder der Blick des Unwissenden.

Zitat:

---

Zitat von mlweb

Und da beißt sich gelegentlich die Katze sogar in den Schwanz, denn sobald man das nötige Wissen hat, fehlt möglicherweise schon wieder der Blick des Unwissenden.

---

Zitat:

---

Zitat von Toflar

Deswegen meinte ich, dass so jemand automatisch zu einem der fähigsten Contao-Entwickler wird, weil er von allem Wind kriegt und alles versteht.

---

und dann wird sie/er wohl irgendwann auch lieber entwickeln als dokumentieren :-o

Es gibt also leider so einige Deadlocks.

Zitat:

---

Zitat von Andreas

[…] müsste ich mich erst zu tief einlesen […]. Dazu habe ich gerade keinen Nerv und keine Zeit. […]

---

Tja, so geht es uns allen, und genau deshalb passiert nichts :(

Zitat:

---

Zitat von fiedsch

und dann wird sie/er wohl irgendwann auch lieber entwickeln als dokumentieren :-o

---

Ja, ich sage nicht, dass der Entwickler eines Features grundsätzlich nichts dokumentieren soll. Natürlich ist das wünschenswert. Aber eben, was du schreibst wird erst richtig wertvoll, wenn jemand es versucht zu verstehen, Unklarheiten direkt beim Entwickler klärt und den Artikel dann so ergänzt, dass er diese Infos enthält. Dann noch formatieren, evtl. Illustrieren mit Bildern (Flussdiagramme oder so), am richtigen Ort in der Doku unterbringen etc.: Und genau das sind meiner Meinung nach 90% des Aufwands.

Danke, Andreas. Es herrscht eine Fragekultur, keine Antwortkultur.

Aus dem Nähkästchen: Ich habe ja eigentlich immer gerne und viel von den Dingen dokumentiert und übersetzt, von denen ich auf den ersten Blick nichts verstanden habe (MetaModels, Avisota, und ein paar andere Erweiterungen). Das ist IMHO eigentlich genau der Weg, um zu verstehen, was eine Sache macht, wie sie funktioniert und wie man sie einsetzen kann, ohne komplett zu stranden. ich habe das persönlich eigentlich immer als Weiterbildungszeit gebucht (genauso wie ein paar hundert Stunden im Wiki oder sicher mehr als tausend seit 2007 hier im Forum).

Diese Arbeit liegt auf relativ wenigen Schultern, denn nicht alle, die sich eine Lösung erarbeitet haben, schreiben die dann auch auf. Eigentlich war das damals der Sinn des Wikis, eine einfache, mit niedriger Einstiegshürde versehene Dokumentationsmöglichkeit zu schaffen. Letztlich ist es auch dabei vollkommen egal, ob ein Artikel erst einmal nur rudimentär ist - er bietet, genauso wie jetzt in der Contao-Dokumentation, einen Startpunkt, an dem andere sich beteiligen können, sollten, müssten.

Dabei ist Dokumentation als Wissensquelle (auch für eigenes Wissen) nicht zu unterschätzen. Leider wird es unterschätzt, was ich u.a. an Feedback und Fragen, die dann bei mir in der Firma aufschlagen, ganz gut nachvollziehen kann. Es ist eher so auf dem Level: "Du hast darüber geschrieben, also kannst Du mir jetzt auch meine Frage beantworten. Und bitte genau so kostenfrei wie die online stehende Dokumentation von Dir."

Alles, was ich persönlich über Contao gelernt habe, habe ich anhand von Dokumentation und Übersetzungen gelernt (naja, fast alles ...). Ich kann nur ermutigen, zu dokumentieren, aufzuschreiben, zu übersetzen und Best Practices zu erstellen. Ich kann dazu ermutigen, keine Fragen zu formulieren sondern Antworten zu suchen und sie öffentlich zu teilen.

Nachsatz: Ich teile die Ansicht, dass Dokumentation besser werden kann. Ich teile aber auch die Ansicht, dass Dokumentation richtig viel Arbeit ist, die im Regelfall nicht wertgeschätzt wird.

Leute ihr habt mich jetzt so richtig schön neugierig gemacht :D

Ich gehöre einerseits zu jeder Kategorie, die sich gerne übersichtliche und leicht verständliche Dokus, Infos, Beschreibungen reinzieht und andererseits dann auch in Notizform noch eigene Vermerke notiert - wo auch immer. Meistens ist es dann so, dass das eine da und das andere dort steht und irgendwie notiere ich mir mein Wissen, wenn ich's dann wieder mal brauche doch wieder auf's neue wiederum irgendwo auf ...
Ja, genauso verwirrend wie sich das liest, versuche ich an Wissen und Infos zu kommen - da ja der Einwand einer nur bedingt verfügbaren Doku schon berechtigt ist.

So, ich habe mir nun mal - ausgehend von der #21 das Wiki doch mal genauer angesehen. Ich kannte es zwar, aber doch irgendwie nur durch die Suche, wo man dann ab und an mal via Verlinkung hinkommt. Ebenso mit der #21 ...
ABER: bei genauerer Betrachtung musste ich feststellen, dass ich ohne den vorhandenen Link, genau diesen einen Wiki-Eintrag gar nicht finde.
Liegt es daran, dass ich das Wiki nicht verstanden habe?
Liegt es daran, dass ich nur an der falschen Stelle gesucht habe, was wiederum die obige Frage rechtfertigen würde?
Oder liegt es daran, dass es hier keine Übersicht/Struktur gibt, die mir diesen Link in einem Art Verzeichnis aufzeigen würde.
... genauso erging's mir aber auch mit anderen Themengebieten, wenn man nicht gerade die links angeordneten Kategorien hernimmt.

So, nun komm' ich mal auf den Punkt:
Gibt's ein Wiki, wo das Wiki erklärt wird? ;)
Ja, ich würde gerne das Wiki näher "kennenlernen" und dann auch, wenn's die Zeit denn zulässt dran mitarbeiten - mit all den Dingen die hier schon diskutiert wurden. Aus der Sicht des Unwissenden, so wie ich einer bin. Aber auch aus der Sicht des Kenners, weil er sich gerade im Selbststudium das eine oder andere Modul, die eine oder andere Erweiterung hatte sich zusammenfrummeln müssen ...

Vieles liest man rasch mal aus einem eindeutigen thread im Forum raus - vieles braucht schon viele Anläufe um zum Ziel zum kommen - vieles braucht externe Seiten - aber ich bin bei euch, wenn jemand dann sagt:"... und warum hast du dein gesammeltes Wissen nicht dem Allgemeingut hinzugefügt ...? "

Also, wo ist das Wiki für das Wiki? Nicht wie ich's bediene, das finde ich hoffentlich dann schon selbst raus ... falls doch nicht, werd ich nachfragen :D
Ich meine, wie finde ich heraus, ob's einen Beitrag schon gibt, oder nicht - und dann ob dieser aktuell ist oder nicht (OK, das sehe ich dann, wenn ich ihn gefunden habe)

Geht's in diesem Wiki nur um Contao im core? Oder soll/darf das auch mit externen Erweiterungen befüllt werden?
Ist z.B. die Installation von cto4.4 über den Contao-Manager schon zu finden? ... das z.B. hätte ich nicht gefunden.


Ja, Leute ihr seht, ich bin ein Nichtwissender, dem wohl einfach nur der Anstoss fehlt/gefehlt hat - so gesehen: danke für den thread!

Zitat:

---

Zitat von derRenner

So, nun komm' ich mal auf den Punkt:
Gibt's ein Wiki, wo das Wiki erklärt wird? ;)

---

In der Fußzeile des Wikis steht (verlinkt) "Powered by MediaWiki", also www.mediawiki.org/ und dort dann Supprt -> User help

@fiedsch: darum geht es doch gar nicht. Ich habe derRenner so verstanden, dass ihm nicht die Bedienung sondern das Verzeichnis existierender Inhalte fehlt. Das lisgt aber in der Natur eines Wiki, da nicht nur die Inhalte, sondern auch die Struktur und die Navigation dynamisch wachsen.
Bei MediaWiki gibt es zum Glück 'Spezialseiten', mit denen sich eventuell etwas aufspüren lässt. Idealerweise werden (wieder-)gefundenen Inhalte dann gleich an zentraler Stelle verlinkt.

Edit: interessant ist z.B. der folgende Link: http://de.contaowiki.org/Spezial:Verwaiste_Seiten

Zitat:

---

Zitat von folkfreund

@fiedsch: darum geht es doch gar nicht.

---

Dann habe ich das falsch verstanden, sorry.

Der Menüpunkt "Letzte Änderungen" unter NAVIGATION führt auf jeden Fall zu den letzten Aktivitäten.
Solange das Thema aktuell bearbeitet wird, hat man hier sogar die Übersicht, wer da was ergänzt oder geändert hat.

Natürlich kann man auch auf der Startseite oder den Übersichtsseiten diesen Link nachtragen.

Ich finde auch die Erarbeitung der einzelnen Themen hier im Wiki eine gute Idee, denn hier kann jeder direkt eingreifen. In Github läuft das sicherlich über Pull-Requests und beschäftigt damit noch weitere Leute bevor dann alles in (vorläufig) endgültiger Fassung vorliegt. Ist ein Thema soweit fertig könnte man die Inhalte ins Handbuch übertragen und im Wiki den Inhalt durch einen Link aufs Handbuch ersetzen.

Meiner Meinung nach ist die Hürde vom Wiki kleiner als Pull-Requests in Guthub zu erstellen. Damit haben wir mehr Chancen, dass möglichst viele User sich beteiligen. Jeder hat seine Spezialgebiete, in denen man schon viel ausprobiert hat und einiges beschreiben könnte. Und sollten da Fehler drin sein, ist es jedem freigestellt auch in fremden Einträgen Korrekturen vorzunehmen, oder Sachverhalte auszudiskutieren.

P.S.:
Wem die Syntax (noch) nicht so liegt, der kann die Texte einfach in LibreOffice schreiben. Unter [Datei | Exportieren ...] kann man sich Dokumente auch im MediaWiki-Format speichern und dann ins Wiki kopieren :)

Zitat:

---

Zitat von do_while

P.S.:
Wem die Syntax (noch) nicht so liegt, der kann die Texte einfach in LibreOffice schreiben. Unter [Datei | Exportieren ...] kann man sich Dokumente auch im MediaWiki-Format speichern und dann ins Wiki kopieren :)

---

Danke für den Tipp :D

Zitat:

---

Zitat von do_while

Ich finde auch die Erarbeitung der einzelnen Themen hier im Wiki eine gute Idee, denn hier kann jeder direkt eingreifen. In Github läuft das sicherlich über Pull-Requests und beschäftigt damit noch weitere Leute bevor dann alles in (vorläufig) endgültiger Fassung vorliegt. Ist ein Thema soweit fertig könnte man die Inhalte ins Handbuch übertragen und im Wiki den Inhalt durch einen Link aufs Handbuch ersetzen.

Meiner Meinung nach ist die Hürde vom Wiki kleiner als Pull-Requests in Guthub zu erstellen. Damit haben wir mehr Chancen, dass möglichst viele User sich beteiligen. Jeder hat seine Spezialgebiete, in denen man schon viel ausprobiert hat und einiges beschreiben könnte. Und sollten da Fehler drin sein, ist es jedem freigestellt auch in fremden Einträgen Korrekturen vorzunehmen, oder Sachverhalte auszudiskutieren.

---

Wikis sind tot. Niemand will Wikis pflegen. Sich die Arbeit in zig verschiedene Systeme aufzuteilen macht wenig Sinn, damit tun wir uns allen keinen Gefallen. Viele Projekte verwenden mittlerweile Sphinx und Read The Docs. siehe https://docs.typo3.org/ Das macht es wesentlich angenehmer sich da durchzulesen, weil sich Sachverhalte oft ineinander schachteln und man ungern die Übersicht verlieren will. Mit dem "Edit me on GitHub" Button gibt es auch keine Hürde mehr.

Zitat:

---

Zitat von Glumanda

Wikis sind tot.

---

Das sehe ich nicht ganz so.
Warum verteilen sich denn unsere Informationen über so viele Systeme und Webadressen? Weil immer nur die neuesten Tools Verwendung finden, keiner aber die Zeit und Arbeit auf sich nehmen möchte, ältere aber noch gültige Informationen zu portieren. Ich persönlich halte nichts davon, dass man sich alle halbe Jahre in neue Tools einarbeiten soll. Das müßte dann schon ein Super-Überflieger-Werkzeugkasten sein.

Zitat:

---

Zitat von folkfreund

Bei MediaWiki gibt es zum Glück 'Spezialseiten'

---

Das Suchfeld oben links funktioniert auch sehr gut.

Zitat:

---

Zitat von do_while

Wem die Syntax (noch) nicht so liegt, der kann die Texte einfach in LibreOffice schreiben. Unter [Datei | Exportieren ...] kann man sich Dokumente auch im MediaWiki-Format speichern und dann ins Wiki kopieren :)

---

Muss ich mal ausprobieren. Ansonsten sollte man parallel einen Tab offen haben mit dem Link oben links auf die Hilfe http://de.contaowiki.org/Hilfe:Inhaltsverzeichnis. Dort findet man alles, was eine neue Seite benötigt und die wesentlichen Formatierungen.

Zitat:

---

Zitat von Glumanda

Viele Projekte verwenden mittlerweile Sphinx und Read The Docs. siehe https://docs.typo3.org/

---

Interessant, aber wo ist der Unterschied zu einem Wiki (abgesehen von verschiedenen möglichen Exportformaten)? Was ich so auf die Schnelle sehen konnte sieht dem doch verdammt ähnlich, aber vielleicht hab ich ja was übersehen.

Zitat:

---

Zitat von Glumanda

Das macht es wesentlich angenehmer sich da durchzulesen, weil sich Sachverhalte oft ineinander schachteln und man ungern die Übersicht verlieren will.

---

Das Lesen mag ja angenehmer sein, aber die Struktur ergibt sich eben auch nicht 'von alleine'...

Zitat:

---

Zitat von folkfreund

Das Lesen mag ja angenehmer sein

---

Ja, das Wiki sieht furchtbar aus. Ich benutze das Theme "modern" mit zusätzlichem CSS per Stylish um die Breite zu begrenzen. Damit geht es einigermaßen.

PHP-Code:

---

@namespace url(http://www.w3.org/1999/xhtml);

@-moz-document domain("contaowiki.org") {

  body {
    margin: 0 auto !important;
    max-width: 1200px !important;
  }
  #mw_contentwrapper {
    width: 960px !important;
    margin: 0 !important;
  }
  #mw_content {
    margin-left: auto !important;
    margin-right: auto !important;
    width: 960px !important;
  }
  #mw_contentholder pre span {
    background: white !important;
  }
  #mw_portlets {
    background-color: #F8F8F8 !important;
  }
} 


---

Zitat:

---

Zitat von folkfreund

... Ich habe derRenner so verstanden, dass ihm nicht die Bedienung sondern das Verzeichnis existierender Inhalte fehlt. Das lisgt aber in der Natur eines Wiki, da nicht nur die Inhalte, sondern auch die Struktur und die Navigation dynamisch wachsen. ...

---

ja, korrekt - das "Verzeichnis", die Übersicht fehlt(e) mir. Wie man das Wiki selbst bedient, schrieb ich auch oben, kann ich mir erlernen bzw. entsprechendes Wissen raussuchen.
Die Frage ging dahingehend, dass man ja so gar nicht erkennt, was denn schon vorhanden ist, oder was nicht.

Ich habe aber jetzt vor diesem Eintrag nochmals etwas genauer geguckt, da ja oberhalb der eine oder andere sehr gute Hinweis aufgetaucht ist und konnte schon mal mehr erkennen.
Also, ich werde mir die Tage das dann nochmals genauer reinziehen und ich denke, dass ich da schon mal bereit bin, mein Wissen entsprechend mit einzutragen.

Der Tipp mit 'Libre Office' gefällt mir ... wieder mal ein Grund mehr, sich das Teil auf die Festplatte zu bannen :D

Letztlich haben wir mit gitbook bereits eine ähnliche Lösung. Ich finde auch, dass das Wiki ausgedient hat. Modul Dokus gehören in die Readme des Moduls und der Rest in das Contao Cookbook. Zu dem habe ich eine Awesome List angelegt (wie alle guten Systeme) und würde die gerne noch nach Awesome List Norm anlegen damit sie auch in die Awsome List aufgenommen wird. Das gehört dann m.E. Auch ins gitbook.

Viele erfolgreiche Systeme zeigen den Weg. Es ist m.E. Zeit sich von alten Strukturen zu lösen die das Contao Projekt isolieren und seit Jahren in seiner Entwicklung behindern.

Bzgl. Doku war ich sehr angetan vom webpack ziklus. Ich denke es sollte Geld aus der Association Kasse in die Hand genommen werden oder ,wenn das warum auch immer nicht möglich ist, ähnlich wie bei Vuejs Patreon für die Finanzierung des Cores/ Doku und Open Collective für Community Finanzierung verwendet werden.

Zitat:

---

Zitat von mlweb

Genauso ist es. Ich weiß wovon ich Rede. Ich habe technische Dokumentation mal ein paar Jahre beruflich gemacht.

Und da beißt sich gelegentlich die Katze sogar in den Schwanz, denn sobald man das nötige Wissen hat, fehlt möglicherweise schon wieder der Blick des Unwissenden.

---

Ich würde gerne etwas beitragen. Grundsätzlich gefällt mir die Vorgangsweise, bei denen nachzufragen zu dürfen, die sich auskennen, und die Informationen dann auf ganz kleine Häppchen herunterzubrechen und für sich und andere nachvollziehbar zu machen.

Mir ist sehr wohl bewusst, dass Dokumentationen ordentlich viel Zeit verschlingen (ich versuche ja auch immer, für mich Vorgangsweisen zu dokumentieren), aber wenn ich mir vorstelle, wieviel Zeit ich damit verbringe, nach Informationen zu suchen, weil ich mich hinten und vorne nicht auskenne, dann denke ich, dass man diese Zeit ja sinnvoller investieren könnte und dann gleich den Nutzen hat, sich selbst viel besser auszukennen.

Aber meine großes Fragezeichen im Kopf dazu ist: Wie unwissend darf man denn sein, um sich für so eine Aufgabe anzubieten? :rolleyes::)

Edit:
Oha, ich habe gerade gesehen, dass es hier ja um Entwickler-Fragen geht. :D Meine Frage war natürlich eher auf allgemeine Contao-Themen bezogen.