Was fehlt um das ioBroker Grundprinzip zu verstehen?
-
Das die Doku überarbeitungwürdig ist, das ist jedem hier klar.
Es arbeiten ja auch schon Personen daran, doch auf die Schnelle ist da eben nichts getan.
Wenn man die aktuelle Doku ansieht, ist sie, meiner Meinung, schon recht gut aufgestellt.
(Struktur und die bis jetzt vorhandenen aktuellen Inhalte)
Das größte Problem einer Dokumentation ist eben, was stellt man rein, und wer hält es aktuell.
Ich gehe jetzt einfach mal davon aus, das du auch schon Dokumentationen erstellt hast,
und dann weißt du ja was das für ein Aufwand ist.
Bin mir nicht sicher wieviele Personen aktuell an der Doku arbeiten, doch ich würde einmal schätzen,
das zu diesem jetzigen Zeitpunkt 5 Personen nicht ausreichen würden um sie zu pflegen und neue Inhalte einzustellen.
Und nicht nebenbei, sondern 40 Stundenwoche.Was auch noch zu beachten ist, wer entscheidet was in die Doku eingepflegt wird.
Ist auch nicht immer ganz einfach.
Da sollte wenigstens ein Offizieller mit anwesend sein.
z.B. meiner Ansicht nach gehören detaillierte Adapterbeschreibungen nicht in die Doku,
sondern so wie es aktuell ist, direkt am Adapter mit angeheftet.
Verlinkungen zu einem externen Dokument sind nicht immer zielführend.
(wer kümmert sich um die verlinkten Seiten)Wiederkehrende Fragestellungen zu einem gewissen Thema könnte ich mir auch gut in der Doku vorstellen.
Wenn ich sehe, wie oft beschrieben wird, wie man ein nicht rund laufendes System wieder in die Gänge bekommt,
dann gehört das hinterlegt. Meine Meinung
(bei dem ein oder anderen sind diestrg,cundvTasten bestimmt schon bis zum Schalter abgenutzt )Wenn ich den Threadverlauf so allgemein ansehe, sind wir eigentlich alle nicht so weit von einander entfernt,
was dieses Thema angeht. Es sind Nuancen die sich bestimmt auch noch aufeinander abstimmen lassen.Angenehmen Abend noch miteinander
-
@hydrotec sagte in Das ioBroker Grundprinzip verstehen:
wäre es nicht sinnvoller diesen Thread einfach umzubenennen?
Du bist der Profi, meinst du, das dieser Thread wirklich gesplittet werden soll, ohne das die Bezüge verloren gehen.
z.B. ist ja der Bezug, woraus dieser Thread eigentlich entstanden ist, auch nicht mehr wirklich vorhanden.
Geschweige denn zu den VorvorthreadIch glaube , dass sich die wenigsten alles durchlesen werden. Und dann gehts hier auch immer wieder um andere Dinge (was könnte es einfacher machen; was kann der ioBroker/wofür ist er gedacht ; … ) . Dieser Thread ist nicht so zielführend.
Ich fände einen Thread mit „Wünschenswerte Änderungen, die den Umgang mit dem ioBroker erleichtern „ gut.
Die Vorschläge dann vllt kurz und bündig fassen und sammeln. Dann kann man eine Auswahl an Änderungen treffen und diese zur Diskussion stellen? Sonst endet der Thread in einem Durcheinander mit 1000en Wünschen. -
@hydrotec sagte in Das ioBroker Grundprinzip verstehen:
Das die Doku überarbeitungwürdig ist, das ist jedem hier klar.
Eben und da fängt es eben schon an.
Wie du selbst schreibst und auch ich oben gemeint habe, die wiederholten Fragen und Probleme im Forum... überwiegend zur falschen Installation.@hydrotec sagte in Das ioBroker Grundprinzip verstehen:
Ich gehe jetzt einfach mal davon aus, das du auch schon Dokumentationen erstellt hast,
Habe vor einiger Zeit damit begonnen hier beizutragen. Da jeder User die Möglichkeit hat und ja, ich weiß da es eine Menge Arbeit ist.
ABER
Iobroker ist nicht mehr so klein und niedlich wie früher, er hat enorm an Potential zugenommen, vieles hat sich verändert, aber leider ist die Dokumentation dabei teils stark auf der Strecke geblieben. Vielmehr wurde von a nach b verlinkt, teils laufen diese ins Leere oder sind Asbach Uralt.
Beispiel
Was nützt mir der beste Adapter, wenn der User mit der Einrichtung oder Bedienung nicht zurecht kommt, mangels Dokumentation.
Jeder weiss selber, je länger das aufgeschoben wird, ordentlich und "einheitlich" zu dokumentieren, wird feststellen dass das nie ein Ende nimmtund je komplexer iobroker wird, desto schwieriger wird es da hinterher zu kommen.@hydrotec sagte in Das ioBroker Grundprinzip verstehen:
z.B. meiner Ansicht nach gehören detaillierte Adapterbeschreibungen nicht in die Doku,
sondern so wie es aktuell ist, direkt am Adapter mit angeheftet.Deshalb schrieb ich, direkte Verlinkung zum jeweiligen Adapter. Denn nur der Entwickler kann seinen Adapter am besten beschreiben.
@hydrotec sagte in Das ioBroker Grundprinzip verstehen:
Wenn man die aktuelle Doku ansieht, ist sie, meiner Meinung, schon recht gut aufgestellt.
(Struktur und die bis jetzt vorhandenen aktuellen Inhalte)Mit etlichen Platzhaltern, die zum Teil raus sollten, veralteten Einträgen. Dinge in der "falschen" Kategorie stehen und man so auf Anhieb gar nicht findet, oder viele offene Punkte, wo ich ehrlich gesagt nicht mal Ansatzweise wüsste, was da stehen sollte/könnte.
-
@crunchip sagte in Das ioBroker Grundprinzip verstehen:
Denn nur der Entwickler kann seinen Adapter am besten beschreiben.
Dann passiert das was gerade passiert: Es werden technische Dokus mit denen ein Einsteiger nichts anfangen kann!
Von rühmlichen Ausnahmen mal abgesehen
-
@homoran ich zähle mich mal nicht mehr zu den Einsteigern, jedoch habe ich bei manchen Adaptern so meine Schwierigkeiten, was der oder jene Eintrag in der Instanz bewirkt und ne Dokumentation bezüglich habe ich auch nicht gefunden.
Und das meinte ich damit. -
@crunchip sagte in Das ioBroker Grundprinzip verstehen:
edoch habe ich bei manchen Adaptern so meine Schwierigkeiten, was der oder jene Eintrag in der Instanz bewirkt und ne Dokumentation bezüglich habe ich auch nicht gefunden.
Das meine ich doch.
Die Doku, die ich damals gemacht habe, hatten zu jeder Einstellung eine Erklärung. (vielleicht kennst du diese noch - tauchen immer mal wieder hier als uralter Link im Forum auf)
Hier ein "aktuelles" Beispiel: https://www.iobroker.net/#de/adapters/adapterref/iobroker.admin/README.mdDas war eine Heidenarbeit, alleine mit allen Screenshots dazu.
Ich bin nachher nicht mehr mit "auf dem Stand halten" nachgekommen. bei 20-50 Adaptern ging es noch, aber bei 400+ no chance!
Und so werden die technischen Infos aus den Adapter repos jetzt als Doku genutzt
-
@homoran sagte in Das ioBroker Grundprinzip verstehen:
vielleicht kennst du diese noch
Natürlich und ist auch logisch das man da nicht hinterher kommt.
@homoran sagte in Das ioBroker Grundprinzip verstehen:
Ich bin nachher nicht mehr mit "auf dem Stand halten" nachgekommen
Ist und sollte auch nicht die Aufgabe eines einzelnen sein.
@homoran sagte in Das ioBroker Grundprinzip verstehen:
Und so werden die technischen Infos aus den Adapter repos jetzt als Doku genutzt
Und da liegen auch Welten dazwischen, die einen ausführlichst und andere wiederum eher dürftig.
Wenn ich mich bei den Adaptern durch klicke, verläuft das bei vielen ins leere und hilft nur Seite neu laden.
https://www.iobroker.net/#de/adapters -
@crunchip sagte in Das ioBroker Grundprinzip verstehen:
Wenn ich mich bei den Adaptern durch klicke
da greift jetzt langsam die Idee, des "neuen" Frameworks.
Die dort hinterlegten Infos sollten die selben sein, die du über das Fragezeichen in der Adapterkachel erhältst.
Die (wirklich gute) Idee dahinter ist, dass nur noch die Doku im Adapterrepo gepfelgt werden muss, und alles andere daraus gespeist wird.
Dann kann jeder einen pullrequest mit Änderungen beim Adapter erstellen und "sofort" ist die Doku aktuellIm Prinzip das immer wieder geforderte WIKI
Leider ist die notwendige Struktur (mehrsprachig) noch lange nicht bei allen Adaptern implementiert.
-
Ja Doku ist eine Großbaustelle und leider arbeitet da gerade keiner aktiv dran. Woran gerade gearbeitet wird ist es die Development Doku rauszulösen weil wir hier andere Strukturen brauchen. Das Grundkonzeption der restlichen Doku und der Aufbau ist denke immer noch sinnvoll und kann ich bei Interesse gern nochmal zum besten geben in nem geeigneten Rahmen. Was fehlt ist der Content der das mit leben füllt.
Auch hier gern wieder der Aufruf: wer an Doku mitmachen will bitte melden!! ;-))
-
@apollon77 sagte in Das ioBroker Grundprinzip verstehen:
Ja Doku ist eine Großbaustelle und leider arbeitet da gerade keiner aktiv dran. Woran gerade gearbeitet wird ist es die Development Doku rauszulösen weil wir hier andere Strukturen brauchen. Das Grundkonzeption der restlichen Doku und der Aufbau ist denke immer noch sinnvoll und kann ich bei Interesse gern nochmal zum besten geben in nem geeigneten Rahmen. Was fehlt ist der Content der das mit leben füllt.
Auch hier gern wieder der Aufruf: wer an Doku mitmachen will bitte melden!! ;-))Wenn das erstellen der Doku rein auf content fokusiert, werden sicher viele mitmachen und ihr Wissen, was hier im Forum zum besten gegeben wird, auch in einer Doku mit ergänzen.
apropos: kann man in der adapter doku mit einem Kennzeichen rechnen, welche die nicht zu übersetzende Teile markiert?
In meiner Doku werden Anteile (Schlüsselbezeichnungen) übersetzt die nicht sinnvoll sind zu übersetzen. -
@oliverio sagte in Das ioBroker Grundprinzip verstehen:
kann man in der adapter doku mit einem Kennzeichen rechnen, welche die nicht zu übersetzende Teile markiert?
Wenn sich da nichts geändert hat reicht es diese Begriffe in einfache Anführungszeichen zu setzen.
aber die echten so wie 'hier', nicht diese -
@apollon77 sagte in Das ioBroker Grundprinzip verstehen:
Was fehlt ist der Content der das mit leben füllt.
ich fürchte das ist nicht alles
ich bin mir nicht sicher ob ich schon zu jedem Thema schon Menüpunkte angelegt und mit entsprechenden leeren Seiten verknüpft habe. -
(mein erster Post hier, bin etwas traurig wenn ich mir diesen Thread so anschaue!)
Ich bin hier gelandet weil ich mir etwas Verständnis über die Grundstruktur von IoB erhofft habe.
Ich versuche seit ca. 3 Wochen mir eine Strategie für den Einsatz des IoB zurechtzulegen und habe Stunden mit dem zusammensuchen von Grundlageninfo verbracht.
Was ich gefunden habe war meist veraltet (spricht für die Dynamik des System durch hyperaktive Adapterwentwickler die leider meist die Zeit nicht finden mit einem Zehnzeiler im Header in GitHub den Sinn und die Funktion des Adapters zu erklären, möglichst ohne Abkürzungen die dem Anfänger meistens nicht geläufig sind).
Die Struktur der Doku sieht eigentlich gut aus, aber leider lande ich meistens bei leeren oder nicht mehr gültigen Seiten.
Ich würde ja gerne bei der Doku mithelfen aber dazu müsste ich die Grundprinzipien verstehen. Dies klappt aus Doku und verfledderten Forumsbeiträgen mit Anfeindungen und 0 Gehalt zum Threadtitel (damit meine ich nicht appollon77 !!) nicht in der zur Verfügung stehenden Zeit.
Aus meiner Sicht würde es Sinn machen wenn jemand ziemlich oben in der Dokumentenstruktur auf 2 Seiten das Funktionsprinzip von IoB grafisch mit Klötzchen und Pfeilen (Informationsfluss) darstellen können. Auch Middleware folgt einem Eingabe Verarbeitungs Ausgabe Prinzip welches sich mit Klötzen und Pfeilen für einen Anfänger viel verständliche darstellen lässt.
Die meisten Adapter stellen I, O oder Kombination von IO für ein bestimmtes Gerät/IoT Objekt dar.
Dann gibt es aber noch Adapter mit einer zentralen Funktion dazwischen und diese sind für den Anfänger nicht zu finden oder zu verstehen weil er noch gar nicht versteht was es gibt und was er braucht. Diese Erkenntnis scheint den meisten fortgeschrittenen hier ziemlich abzugehen wenn ich die arroganten Anfeindungen bei gewissen Anfängerfragen so lese (scheint in deutschsprachigen Foren spätestens seit Corona leider standard zu sein).
Statt Haarspaltereien von Details in Forumsbeiträgen würden hier einige Ihre Zeit besser in für Anfänger verständliche Dok investieren.
just my 5 cents -
@heiri56 sagte in Das ioBroker Grundprinzip verstehen:
Ich würde ja gerne bei der Doku mithelfen aber dazu müsste ich die Grundprinzipien verstehen. Dies klappt aus Doku und verfledderten Forumsbeiträgen mit Anfeindungen und 0 Gehalt zum Threadtitel
Diese Formulierung ist aber auch nicht unbedingt geeignet etwas zu verbessern.
Aber gut, dass du vorbeisiehst.
Wir sind gerade dabei einen neuen Anlauf zu machen.
Dieser Thread sollte schon seit ein paar Tagen aufgeräumt werden, da das Bild wirklich nicht gut ist, aber die Zeit eines Neben"beruflichen" Dokumentators /Forenadmin/Moderators und Notnagel für Hilfesuchende ist ebenfalls sehr begrenzt.@heiri56 sagte in Das ioBroker Grundprinzip verstehen:
Aus meiner Sicht würde es Sinn machen wenn jemand ziemlich oben in der Dokumentenstruktur auf 2 Seiten das Funktionsprinzip von IoB grafisch mit Klötzchen und Pfeilen (Informationsfluss) darstellen können.
Damit habe ich so meine Probleme.
Ich behaupte mal - so geht das nämlich gar nicht, da dann die Pfeile zu 400 Klötzchen "etwas" unübersichtlich werden.
Spätestens wenn Alexa, Google Home, oder nur Drittanbieter Apps noch funktional "dazwischenfunken".Jetzt muss ich mir deinen Beitrag noch mindestens 5mal durchlesen, bis ich (betriebsblind wie ich bin
) nachvollziehen kann was du erwartest.Bitte nicht falsch verstehen - wir brauchen genau dieses Feedback!!
Dafür habe ich ja gestern das neue Unterforum für Einsteiger - und darin das Subforum Anregungen - Verbesserungsvorschläge eingerichtet.
https://forum.iobroker.net/topic/51543/neues-unterforum-nur-für-einsteigerfragen
Da habe ich schon einiges von deinem Post vorweggenommenLeider bin ich nicht mehr dazu gekommen diesen Thread hier sinnvoll zu zerlegen, dorthin zu verfrachten und dabei von o-Aussagen zu säubern
-
@heiri56 sagte in Das ioBroker Grundprinzip verstehen:
Aus meiner Sicht würde es Sinn machen wenn jemand ziemlich oben in der Dokumentenstruktur auf 2 Seiten das Funktionsprinzip von IoB grafisch mit Klötzchen und Pfeilen (Informationsfluss) darstellen können
https://github.com/ioBroker/ioBroker/raw/master/img/architecture.png
ansonsten steht doch erstmal auf der Willkommen und Grundlagen erste Informationen, desweiteren ist der Aufbau unter Admin Oberfläche beschrieben.
@heiri56 sagte in Das ioBroker Grundprinzip verstehen:
Ich versuche seit ca. 3 Wochen mir eine Strategie für den Einsatz des IoB zurechtzulegen und habe Stunden mit dem zusammensuchen von Grundlageninfo verbracht.
oder einfach direkt fragen, geht meist schneller
-
Danke für Deine Antwort.
Das neue Unterforum habe ich gesehen, war aber als ich vorbeikam mit 1 Beitrag ziemlich leer, wird ja vielleicht mal.
Ich persönlich würde das in der Dokstruktur besser finden.
Die Problematik so was in einem Forum zu lösen wird genau in diesem Thread leider sehr offensichtlich.
Den Zeitaufwand die für Aufräumarbeiten von Admins für die Ergüsse gelangweilter Forumsteilnehmer finde ich zum ko....
Deine sicher wertvolle Zeit und Wissen könnte hier sicher besser eingebracht werden als mit aufräumen verschletzt zu werden. -
@crunchip sagte in Das ioBroker Grundprinzip verstehen:
https://github.com/ioBroker/ioBroker/raw/master/img/architecture.png
ich glaube nicht, dass es das ist, was @heiri56 meint.
eher so:
(mal eben schnell hingepinselt - nur als Diskussionsgrundlage)Nehme ich an!!
-
@heiri56 sagte in Das ioBroker Grundprinzip verstehen:
war aber als ich vorbeikam mit 1 Beitrag ziemlich leer, wird ja vielleicht mal.
wenn du da nichts reinschreibst wird es nie mehr
Den Rest muss ich dir leider widersprechen:
@heiri56 sagte in Das ioBroker Grundprinzip verstehen:
Den Zeitaufwand die für Aufräumarbeiten von Admins für die Ergüsse gelangweilter Forumsteilnehmer finde ich zum ko....
das ist hier ein gaaaanz seltener Extremfall
Aufräumen habe ich in den letzten 8 Jahren vielleicht dreimal müssenaber:
anstelle an der Struktur der Doku zu arbeiten ist ein direkter Kontakt zu den Usern aus verschiedenen Gründen sinnvoll(er):
mit individueller Hilfe ist ein User schneller zufriedengestellt
(ja, es gibt auch Fallstricke)
Durch den direkten Kontakt und Rückfragen kann men erkennen wo noch Defizite sind.Und genau deswegen habe ich diesen "Meckerthread" nicht aufgeräumt, weil wir hier Infos sammeln möchten
Aber ja, die Zeit ist endlich
-
@homoran Ja aber genau DAS ist ja bei jedem anders
-
@apollon77 sagte in Das ioBroker Grundprinzip verstehen:
@homoran Ja aber genau DAS ist ja bei jedem anders
Könntest du das DAS bitte spezifizieren.
DAS versteht nämlich auch jeder anders
