Grundidee der Themenausrichtung der Doku

[hydrotec]

@Jey-Cee
@Andreas-5
@apollon77
@OstfrieseUnterwegs

Danke erst einmal zu euren Gedanken.

Der Grundgedanke, MQTT in die offizielle Doku mit aufzunehmen, war,
dem Interessenten/Einsteiger in einer groben Ausführung, zu dem Thema eine kleine Hilfestellung zu geben.

• kurze Beschreibung was MQTT überhaupt ist, mit Links zu themenbasierten Webseiten.
  (z.B. mqtt.org, Wikipedia, usw.)
• Vorstellung welche Adapter zur Verfügung stehen,
  und welchen man am Besten zu einer bestimmten Konstellation nehmen könnte.
  ioBroker kann ja auch als MQTT-Broker verwendet werden, und damit externe Broker wie z.B. mosquitto ablösen.
  Zusätzlich Links zu den jeweiligen Adaptern
• kleiner Hinweis, was Topics sind, und wie das Zusammenspiel mit ioBroker funktioniert.
• Eventuell noch eine kleine Sammlung zu Tutorials, welche sich mit diesem Thema beschäftigen.

Also wirklich nur kurz umschrieben.
Die ausführliche Dokumentation zu einem Adapter gehört auch dort hin.
Da bin ich voll bei euch.
Mir ist eben aufgefallen, das zum Thema MQTT doch immer wieder Fragen im Forum auftauchen,
und die Lösungswege sich meistens wiederholen.

Vielleicht gibt es noch einen anderen Weg, nicht unbedingt in der Doku,
das ein Interessierter/Einsteiger einen ersten Anlaufpunkt bekommt.

Gruß, Karsten

[apollon77]

@ostfrieseunterwegs sagte in Grundidee der Themenausrichtung der Doku:

@apollon77 Genau, herstellerübergreifende Standards und Protokolle: mqtt, zigbee, z-wave, knx, ... und wie diese sich integrieren kurz beschreiben und dann die Details bei den einzelnen Adaptern.

So eine Seite haben wir noch nicht...müsste man mal überlegen wo man das in die Struktur einsortiert, aber ja könnte für Interessenten vor allem interessant sein ...

[Homoran]

@apollon77
Da muss man aber genau das Thema wie weit wir als ioBroker in diese Materie einsteigen sollten, überdenken. Ich erinnere mich noch an die Zeit als in dem Forum sehr viele Fragen zu node-red kamen, die ich nicht einordnen konnte. Da stellte sich dann immer heraus, das es gar keine ioBroker-User waren, sondern node-red standalone.

In dem Bereich unterstütze ich dann die Idee zur Verlinkung externer Seiten.
Was für ioBroker interne Dinge ein noGo ist, sollte für tiefergehende Grundlagen eines externen "Systems" durchaus legitim sein, da wir nur die Integration "zu verantworten" haben.

Es sollten also nur kurze Worte zum Funktionsprinzip und ein Link zu einer tieferen Beschreibung in der Einleitung der Doku stehen.
So hatte ich es bei node.red damals gemacht: https://www.iobroker.net/docu/index-280.htm?page_id=4284&lang=de Man möge mir diesen Uralt-Link verzeihen!

Und dann gehört so etwas der Rest in die Adapterreferenz.

Überspitzt gesagt:
Wenn wir die ioBroker-Doku zu einem SmartHome-oder gar IT-Wiki anheben wollen, müssen wir uns das sehr gut überlegen.
Dann brauchen wir u.a. wesentlich mehr aktive Dokumentatoren, die sich auf Einsteigerniveau einstellen können und trotzdem das notwendige Fachwissen beherrschen.
Von Struktur und Platz mal ganz abgesehen

[hydrotec]

@muchul sagte in Grundidee der Themenausrichtung der Doku:

Ich habe beispielsweise erst durch versuche rausgefunden das Datenpunkte erst angelegt werden wenn ich sie anderweitig publiziere.

Hallo Muchul,

ich lade dich herzlichst ein, in diesem Thread deine Erfahrungen mitzuteilen.
Je mehr Informationen in dem Thread enstehen, desto zielgerechter kann ich die Doku zu MQTT aufbauen.

Danke
Gruß, Karsten

[apollon77]

@homoran Nee das will ich ja gar nicht ... Bin voll bei dir ... wenn dann maximal die "Buzzwords" (und ein Satz das der Kontext klar ist)) und links an die richtigen stellen ... Wenn man sowas will.

Am Ende ist die "Logik und Automatisierung"-Startseite genau so ein Bereich. Hier sollten Abschnitte sein über "Scenes", "JavaScript" mit den Regelformen Rules, Blockly, Skripte und am Ende auch Node-Red. Ggf jeweils ein Screenshot und ein Kurzer Absatz was zeigt was da geht und "wie einfach das ist" und dann idealerweise Links zu mehr und spezifischem Kontext.

Für andere Dinge müsste an noch eine Seite erstellen wo man andere "relevante iot Themen" auf ebenso eine Art dann ggf ohne bilder) darstellt und Links setzt

[Homoran]

@apollon77 sagte in Grundidee der Themenausrichtung der Doku:

Am Ende ist die "Logik und Automatisierung"-Startseite genau so ein Bereich. Hier sollten Abschnitte sein über "Scenes", "JavaScript" mit den Regelformen Rules, Blockly, Skripte und am Ende auch Node-Red.

Genau - da passt dann z.B. node-red hinein.

Aber diese Diskussion hatten wir bei Zigbee und jetzt bei MQTT - also Protokolle
Ich muss mir nochmal die "Struktur hinter der Doku" ansehen, ob da nicht auch schon was geplant war, oder ob das nur eine Kategorie bei den Adaptern geworden ist

[Chaot]

@apollon77
Mir ist übrigens gerade beim lesen der derzeitigen Dokumentation etwas aufgefallen was gerade für Anfänger essentiell ist.
Die mit Abstand wichtigste Information steht im letzten Absatz.
Wie gesagt hatte ich das Problem bei meinem Einstieg in den iobroker auch so.
Die Webseite ist sehr professionell gemacht und wirkt auf den ersten Blick kommerziell. Das ist ja schön, aber da drängt sich (zumindest für mich) zunächst die Frage auf was der iobroker denn kostet.

Das hat jetzt nichts mit der Fragestellung der Struktur der Dokumentation zu tun, aber ich denke mal das das schon deutlicher zu erkennen sein darf das der iobroker für einen Privatanwender nichts kostet.

[Homoran]

@chaot sagte in Grundidee der Themenausrichtung der Doku:

Mir ist übrigens gerade beim lesen der derzeitigen Dokumentation etwas aufgefallen was gerade für Anfänger essentiell ist.
Die mit Abstand wichtigste Information steht im letzten Absatz.

Welche Seite?

[paul53]

@homoran sagte: Welche Seite?

Willkommen

[Homoran]

@paul53 sagte:

Willkommen

Danke!

@Chaot Diese muss auch noch überarbeitet werden.
Danke für den Input

[Andreios]

@homoran sagte in Grundidee der Themenausrichtung der Doku:

@andreas-5 sagte in Grundidee der Themenausrichtung der Doku:

Diese ganzen Unterpunkte "Tutorial" mit dem Inhalt "Das ist ein Platzhalter" sollten sofort verschwinden!

Was soll jetzt diese plakative Aussage?

Das soll aussagen, das ich es unsinnig finde, wenn es 9 Menüpunkte gibt, von denen nur einer Inhalt enthält!

@andreas-5 sagte in Grundidee der Themenausrichtung der Doku:

Dadurch sieht das Menü zwar schön groß aus, aber der Informationsgehalt ist gering und frustriert den Leser.

Dann hast du wahrscheinlich dieses hier nicht gelesen https://forum.iobroker.net/topic/51731/grundlagen-der-struktur-hinter-der-doku und auch noch nie davon gehört, dass aus technischen Gründen das Menü im Vorfeld errichtet werden musste

Das habe ich gelesen, allerdings nicht sehr intensiv!
Eine Struktur, die 2018 aus dem Grund der Mehrsprachigkeit erstellt, aber bis 2022 noch nicht mit Inhalt gefüllt worden ist, kann man doch einmal hinterfragen, oder?
Deswegen sitzen wir ja hier dran!

Entschuldigung, aber ich wollte Dir nicht zu Nahe treten!

[apollon77]

@homoran "IoT Technologien und Protokolle" :-))

[Homoran]

@andreas-5 sagte in Grundidee der Themenausrichtung der Doku:

Eine Struktur, die 2018 aus dem Grund der Mehrsprachigkeit erstellt, aber bis 2022 noch nicht mit Inhalt gefüllt worden ist,

auch wenn 2022 noch seeehr lange dauern wird, hast du leider Recht.

Aber die Struktur ist nicht zu hinterfragen, nur die fehlenden Inhalte.

JeyCee hat ja klar gemacht, dass ihn eine kurze Seite schon Stunden gekostet hat, da kann man sich ja mal ausrechnen, was mich hunderte Seiten bisher gekostet haben.

Erschwerend kam hinzu, dass die Userzahl dermaßen gestiegen ist, dass ich mich entscheiden musste im Forum zu helfen, oder die Doku weiterzuschreiben, was ich auch aus Gründen, wie sie @crunchip gerade in einem anderen Thread beschrieben hat erst einmal zurückgestellt hatte. Auch hatte ich die damals eigentlich noch berechtigte Hoffnung, im Forum die Knackpunkte herauszuarbeiten, die ich dann in der Doku behandeln wollte.

Leider kamen auch noch andere Dinge dazwischen und irgendwann reichten 24 Stunden einfach nicht mehr aus.
Deswegen machen wir hier ja den nächsten Anlauf, diesmal mit größerem Trara.

@andreas-5 sagte in Grundidee der Themenausrichtung der Doku:

Das habe ich gelesen, allerdings nicht sehr intensiv!

dann mach das, vielleicht verstehst du dann, warum an der Struktur (eigentlich) nichts zu rütteln ist

[paul53]

@homoran
Was war für "Funktionen" unter "Grundlagen" angedacht?
Die Rubrik "Adapter und Controller" sollte wohl besser "Adapter und Instanzen" lauten?

[Homoran]

@paul53 sagte:

Was war für "Funktionen" unter "Grundlagen" angedacht?

Als ich letzte Woche die Menütitel überarbeitet hatte, habe ich mich das auch gefragt.
Habe gerade nochmal reingesehen, ob anhand der anderen Übersetzungen da was hilfreiches drinsteht

        "Functions": {
          "title": {
            "en": "Functions",
            "de": "Funktionen",
            "ru": "Функции",
            "zh-cn": "职能"
          },

leider Fehlanzeige

Aus dem Zusammenhang, dass der Menüpunkt davor Datenpunkte und Objekte heisst, nehme ich an, dass da die "Gewerke" usw, also die enums hinsollten

EDIT:

@paul53 sagte in Grundidee der Themenausrichtung der Doku:

Die Rubrik "Adapter und Controller" sollte wohl besser "Adapter und Instanzen" lauten?

Auch das ging mir durch den Kopf, dann musste ich an den Befehl iobroker update denken, da stehen die Adapter und der Controller drin

Vielleicht sollten dort Controller, Adapter und Instanzen behandelt werden um die gesamte zusammenhängende Organisationsstruktur des modularen Aufbaus verständlich zu machen.
Allerings müsste der Menütitel kürzer sein

[Andreios]

@homoran sagte in Grundidee der Themenausrichtung der Doku:

@andreas-5 sagte in Grundidee der Themenausrichtung der Doku:

Aber die Struktur ist nicht zu hinterfragen, nur die fehlenden Inhalte.

Ich hinterfrage grundsätzlich alles, was mir nicht sinnvoll erscheint! Und in der heutigen Zeit und bei einem tollen System, das so flexibel ist, wie ioBroker, kann man sich ja schon 'mal fragen, ob eine so Starre Struktur der Doku sinnvoll ist.

JeyCee hat ja klar gemacht, dass ihn eine kurze Seite schon Stunden gekostet hat, da kann man sich ja mal ausrechnen, was mich hunderte Seiten bisher gekostet haben.

Wenn es am System liegt, dass es Stunden gekostet hat, dann sollte man das System doch erst Recht überdenken, oder?

dann mach das, vielleicht verstehst du dann, warum an der Struktur (eigentlich) nichts zu rütteln ist

Manchmal muss man alte Stricke abschneiden!

[apollon77]

@homoran sagte in Grundidee der Themenausrichtung der Doku:

an, dass da die "Gewerke" usw, also die enums hinsollten

würde ich auch tippen

[paul53]

@homoran sagte: die enums hinsollten

Dann sollte man die Rubrik auch so bezeichnen (en: enums, de: Aufzählungen). Und davor noch Alias als Datenpunkte mit speziellen Eigenschaften einfügen.

[Jey Cee]

@andreas-5 sagte in Grundidee der Themenausrichtung der Doku:

Wenn es am System liegt, dass es Stunden gekostet hat, dann sollte man das System doch erst Recht überdenken, oder?

Hat es nicht, zumindest nicht maßgeblich. Aber man muss sich Gedanken zum Aufbau machen und dann noch zum Inhalt. Am Ende muss dann auch noch die Formulierung passen.

Das sind einfach Dinge um die man nicht herum kommt. Jemand der sich leichter tut mit schreiben ist sicher deutlich schneller als ich. Trotzdem ist das nicht mal so in ein paar Minuten erledigt.

[Homoran]

@andreas-5 sagte in Grundidee der Themenausrichtung der Doku:

Wenn es am System liegt, dass es Stunden gekostet hat, dann sollte man das System doch erst Recht überdenken, oder?

richtig, aber er hat ja nur in seinem eigenen Repo getippt.
und da sind noch nicht einmal beschriftete Screenshots drin
Also ist die Struktur unschuldig.

Die kommt erst richtig zur Geltung, wenn anschließend alles automatisch generiert wird. Wie im Link beschrieben.

@andreas-5 sagte in Grundidee der Themenausrichtung der Doku:

Manchmal muss man alte Stricke abschneiden!

s.o.
Dann darfst du ein neues Framework für das gesamte ioBroker-System programmieren.
(siehe Link)