Moin zusammen,
das folgende soll nur meine gedanken reflektieren, ohne Ansprüche oder Forderungen und ohne jegliche Wertung.
Wir alle sind derzeit unzufrieden mit den Dokus, egal ob User oder Dev's, Dies betrifft wohl die gesamte Kette, angefangen von dem Gedanken einen Adapter zu entwickeln bis zum Support des fertigen Adapters.
Auch die Kommunikation wo wann welche Informationen zu finden sind, sind etwas holprig.
Wenn ich mir anschaue, wo überall und auf wie vielen Plattformen diskutiert und Kommuniziert wird, steige ich als User der eigentlich nur ein Funktionierendes System haben möchte direkt aus.
Ich drehe die Lautstärke meiner Gedanken mal hoch:
Jemand erstellt einen neuen Adapter und stellt diesen im Bereich Tester vor.
Meistens existiert nur eine Rudimentäre Anleitung und im laufe der Zeit Ändert sich so viel an de Adapter das die initiale Doku nichts mehr mit dem fertigen Adapter zu tun hat.
Möglicherweise könnte die Community hier mitarbeiten.
Der Entwickler kümmert sich um die Entwicklung und interessierte User erstellen die Doku.
Das muss nicht einer alleine Machen und jeder kann einen kleinen Teil beisteuern.
Der Entwickler könnte dann die entstandene Doku in den Adapter übernehmen.
Im forum (das ist und bleibt für mich die erste Instanz) wäre die Doku damit auch in der Betaphase bereits aktuell.
Ich könnte mir vorstellen das ein Adapter nur in Stable übernommen werden darf, wenn die Doku bereits fertig ist. Dies könnte aber während der Testphase schon durch die User erstellt werden und würde für die Dev's den Aufwand minimieren.
Ich habe mir, in meinem Beruf angewöhnt unsere Entwickler keine Dokus schreiben zu lassen.
Der Entwickler bekommt einen Ansprechpartner, dem er einmal erklärt was wie passiert und ist ab diesem Zeitpunkt erst mal raus aus dem Thema.
Die Doku wird bei uns von nicht Entwicklern geschrieben und darauf lege ich besonderen Wert, von nicht Technikern gelesen. Wenn dann ein richtiges Verständnis dieser Doku rauskommt, ist Sie in Ordnung.
Jemand der nach meinen Vorstellungen eine Doku hier im Forum schreiben würde, müsste sich nicht mit GitHub und dem ganzen drumherum auskennen, einfach nur Runterschreiben, wie man es verstanden hat im Forum teilen und andere User beteiligen sich was wie verbessert werden kann.
Der Entwickler kann dann den Part in GitHub einpflegen, mit den erforderlichen Zwischenschritten.
Ich sehe hier zwei Vorteile:
Der Entwickler muss sich nur noch Organisatorisch um die Doku kümmern.
Es entsteht in der Betaphase bereits eine ausführliche und NICHT veraltete Doku, die weitergepflegt wird.
Ich als User möchte gerne Funktionierende Adapter und wenn es Sinn macht auch neue Funktionen.
Daher habe ich natürlich auch Interesse an einer vernünftigen, aktuellen und vollständigen Dokumentation.
Erstelle ich diese Dokumentation mit, erlerne ich auch die Funktionsweise des Adapters.
Und wenn ich weiß wie ein Adapter Funktioniert, stelle ich weniger Fragen, kann bei Änderungen die Doku leichter anpassen und auch Fragen von anderen Usern beantworten.
Ich nenne hier mal als Beispiel den Zigbee Adapter (nur weil ich den nutze), ich bewundere die Hingabe, die Zeit Investition und die Geduld die die Entwickler für den Support aufbringen.
Manchmal frage ich mich, wann finden die Entwickler Zeit an dem Adapter zu arbeiten.
Ich denke, User die anderen Usern helfen können entlasten die Dev's
