Forum zu Wiki -> Synchronisierung der Infos

cartzilla · 02 Oktober 2017, 15:33:33

Hallo,
seit längerer Zeit benutze ich FHEM und lese hier viel im Forum mit. Es steckt auch immens viel gesammelte Information in den einzelnen Threads. Ich habe nun aber schon öfters die Erfahrung gemacht (insbesondere bei Suche nach Infos zu den FHEM-Modulen), daß ein Thread zu einem speziellen Modul im Laufe der Zeit auf immense Länge anwächst und in diesem Textwust die gesamte Dokumentation zu dem betroffenen Modul steckt. Eine Dokumentationsseite im FHEM-Wiki gibt es zwar meist auch, aber die ist fast immer hoffnungslos veraltet oder schlichtweg ganz verwaist. Das ist sehr schade. Als "Neuzugang" findet man sich da wirklich sehr schwer in ein Modul ein. Man muss die ganze Entwicklungsgeschichte des Moduls in Form des Threads notgezwungen nochmals selber durchackern, um auf den Stand der Dinge zu kommen.
Ich möchte deshalb vorschlagen, das FHEM-Wiki besser mit dem Forum zu verknüpfen und die Modulentwickler mit Nachdruck anzuhalten die Dokumentation auch ernst zu nehmen. Für die Verbreitung von FHEM wäre dies von entscheidendem Vorteil.

Gruß, Sascha

Amenophis86 · 02 Oktober 2017, 15:43:36

Der Modulautor ist nur an die CommandRef gebunden, wo alles stehen sollte. Das Forum ist als Support bei Fragen gedacht und das Wiki als ausführliche Beschreibung.

Jedem steht es frei sich für das Wiki freischalten zu lassen und somit FHEM bei der Entwicklung zu helfen. Dem Modulautor auch noch das Wiki aufdrücken ist meiner Meinung nach zu viel.

Bezüglich der riesen Threads gibt es immer mal wieder Diskussionen, was besser ist. Manche sagen viele kleine, andere ein großer, weil sie so alles mitbekommen. Das ist "leider" Geschmackssache und lässt sich aktuell nicht anders lösen.

Ich verstehe die Intention des Beitrags und habe mich auch schon geärgert, aber es bleibt aktuell nichts anderes, als sich mit den Gegebenheiten zufrieden zu geben bzw. was man ändern kann auch selbst zu ändern. Das heißt die User sind gefordert das Wiki zu pflegen und der Modul Autor die CommandRef und das Forum bezüglich Änderungen auf dem Laufenden zu halten.

marvin78 · 02 Oktober 2017, 15:44:14

Die Dokumentation zu FHEM ist die commandref, nicht das Wiki. Dort findest du in der Regel alles, was du benötigst, um ein Modul zu verwenden. Das Wiki ist eine Möglichkeit um das Modul und seine Möglichkeiten durch Beispiele und andere Zusätze zu ergänzen. Jedem steht es frei, im Wiki Änderungen an Artikeln vor zu nehmen, viele der Artikel kommen nicht vom Modulautor (und das ist in der Regel auch gut so). Die Dokumentation wird sehr ernst genommen (und das obwohl das hier alle nur als Hobby betreiben), das Wiki ist aber eben nur ein Wiki, nichts weiter.

cartzilla · 02 Oktober 2017, 15:56:18

Danke für die schnellen Antworten.
Die commandref ist natürlich als Dokumentation die Grundlage, aber eben auch nur diese. Oft ist einfach mehr als nur die Mindestbeschreibung notwendig und da wäre das Wiki die richtige Adresse. Ich denke schon, daß man die Pflege auch den Modulautoren mit "aufdrücken" sollte. Mir ist ja klar, dass die das alles freiwillig und ehrenamtlich machen, aber eine gute Doku ist für das langfristige Bestehen eines Softwareprojektes einfach unabdinglich! Und wer kennt das eigene Modul besser als der Autor?
Dokumentieren macht zwar weniger Spass als Programmieren und im Forum fachsimpeln, gehört aber verdammt nochmal auch dazu...

marvin78 · 02 Oktober 2017, 15:59:59

Und deswegen wird es in der commandref (im Übrigen in sicher 99% der Module völlig ausreichend) gemacht. Alles weitere ist Bonus, nichts weiter. Wenn du mit der Doku nicht zurecht kommst, ist FHEM nichts für dich. Hart aber wahr.

Du kannst gerne die Wiki-Artikel übernehmen. Es hindert dich niemand daran.

cartzilla · 02 Oktober 2017, 16:14:19

Zitat von: marvin78 am 02 Oktober 2017, 15:59:59
Und deswegen wird es in der commandref (im Übrigen in sicher 99% der Module völlig ausreichend) gemacht. Alles weitere ist Bonus, nichts weiter. Wenn du mit der Doku nicht zurecht kommst, ist FHEM nichts für dich. Hart aber wahr.

Wenn die Dokumention in der commandref wirklich ausreichend wäre, dann gäbe es sicher 50% (um bei frei geschätzten Prozentangaben zu bleiben) weniger Forenbeiträge mit entsprechenden hilfesuchenden Fragen

Scheint also nicht nur mir so zu gehen...

marvin78 · 02 Oktober 2017, 16:20:46

Das habe ich nicht gesagt. Fragen im Forum haben nichts mit dem Wiki zu tun. Deshalb heißt es Forum. Ich habe ohnehin die Meinung, dass man nicht jeden mitnehmen muss. FHEM ist kein System für jeden und das ist gut so. Ich sehe keinen Grund, Entwickler zu verpflichten, mehr als eine gute Doku zu pflegen (denn das ist genau das Problem, die Pflege). Es ist besser, wenn User gehen, als wenn Entwickler das Weite suchen, weil die Anforderungen zu hoch und lächerlich werden.

cartzilla · 02 Oktober 2017, 16:34:39

Das die Entwickler das Weite suchen möchte wohl keiner.
Jetzige Situation ist aber, das ein Großteil der (über die commandref hinausgehenden) Dokumentation in Form aufgeblähter Threads vorliegt. Und das ist einfach ineffizient, sowohl für die Entwickler als auch die Nutzer!
Wenn die Doku übersichtlicher wäre, würde dies die Anzahl an entsprechenden hilfesuchenden Forenbeiträgen deutlich reduzieren. Dies würde wiederum die Entwickler entlasten.

rudolfkoenig · 02 Oktober 2017, 16:41:53

@marvin78: Amen

Weiterhin spricht ein Entwickler haeufig nicht die Sprache der Endbenutzer, egal wie sehr er versucht es zu erklaeren. Deswegen braucht man einen Dolmetscher.

@cartzilla: bitte nicht die Entwickler entlasten, indem man ihnen noch mehr Pflichtaufgaben aufbuerdet, sondern lieber selber helfen.