Brainstorming Doku Abschnitt "Willkommen"
-
In diesem Thread möchte ich einmal mit euch diskutieren, ob der aktuelle Bereich "Willkommen" https://www.iobroker.net/#de/documentation/README.md in der Doku noch etwas verbessert werden kann.
Zielsetzung von "Willkommen"
Besucher / Interessierte sollen in kurzer Zeit einen Überblick bekommen was ioBroker ist und welche Möglichkeiten man mit ioBroker hat.Ich werde diesen ersten Post hier nutzen, um die Ideen / Grafiken / Verweise die im Laufe der Diskussion entstehen zentral zu sammeln, so dass man sie später besser umsetzen kann.
Im ersten Schritt würde ich noch nicht unterscheiden, ob alle Themen auf eine "Willkommensseite" kommen oder ob man dies auf 2-3 Unterseiten verteilt. Dies kann man im Nachgang immer noch verschieben.
Themen welche auf die Seite "Willkommen" sollen:
- ioBroker Logo
- Kurze Erklärung was ioBroker ist (Middleware mit einer stark vereinfachten Übersichtsgrafik)
- Unterstützte Adapter mit Verweis auf Adapterliste https://www.iobroker.net/#de/adapters
- Visualisierungsbeispiele von VIS, Lovelace, jarvis, ...
- Individuelle Programme erstellen mit Javascript, Blockly, Rules
- Community Kanäle
** Forum https://forum.iobroker.net
** Discord https://discord.gg/sGWE65zF
** ... - Wer steckt hinter ioBroker (Community + Core + Dev Entwickler und ioBroker GmbH)
- Lizenz unter der ioBroker steht / Teils eigenständige Lizenzen der Adapter mit mögliche Kosten
- Kurzvorstellung der ioBroker Cloud Services
Themenspeicher (Themen die auf eine andere Seite gehören, aber nicht in den Willkommensbereich
- xxx
Aktueller Arbeitsstand
Den aktuellen Arbeitsstand könnt ihr hier einsehen: https://github.com/Feuer-sturm/ioBroker.docs/tree/FS-welcome/docs/de#readme
Feedback / Änderungen sind immer willkommen. Wenn ihr mir den Text bereitstellt kann ich ihn auf Github übernehmen. -
Platzhalter für die Textbausteine zu den Themen, welche dann in den Bereich "Willkommen" (Github https://github.com/ioBroker/ioBroker.docs/edit/master/docs/de/README.md) übernommen werden können
Themen mit
sind bereits in github eingearbeitet
Themen mit
müssen noch in Github eingearbeitet werden ioBroker Beispielkonfiguration
Diese Grafik zeigt wie ioBroker als Middleware vereinfacht funktioniert, um verschiedene Smarthomelösungen oder weitere Dienste (z.B. Kalender) miteinander zu verbinden.
Die in ioBroker zur Verfügung stehenden Adapter können unter anderem mit zentral verwalteten Kalendern oder herstellerspezfischen Smartehomesysteme (welche im LAN oder WLAN angeschlossenen angeschlossen sind) kommunizieren. Auf diese Weise kann die ioBroker Software Statusinformationen lesen oder Daten schreiben, um Aktionen zu triggern.Nehmen wir an, dass ein Anwender in der Wohnung bereits einige Lampen über Philipps Hue steuert sowie seine Rolläden über Homematic IP öffnen und schließen kann.
Mit dem Einsatz der ioBroker Software ist es nun möglich eine Anwesenheitssimulation zu realisieren, in welcher die Hue Lampen ein- und ausgeschaltet und die Rolläden hoch und runter gefahren werden können wenn der Anwender im Urlaub ist.
Über die Logikbausteine (Adapter Logikprogrammierung) kann der Anwender mit wenigen Schritten den folgende Ablauf realisieren:
- Wenn im Kalender der Eintrag "Urlaub" eingetragen ist, werden ab 18 Uhr Abends abwechselnd verschiedene HUE Lampen ein- und ausgeschaltet.
- Um 22:00 Uhr werden alle Rolläden geschlossen und alle Hue Lampen ausgeschaltet.
- Um 08:00 Uhr morgens werden alle Rolläden wieder hochgefahren.
Über den "Adapter User Interface" kann sich ein Anwender individuelle Status und Steuerungsseiten für seine Hue Lampen und Rolläden bauen, auf die mit den mobilen Endgeräten von zu Hause oder aus dem Urlaub (z.B. mittels ioBroker Cloud Services oder VPN) zugegriffen werden kann.
Thema B
-
Ich habe einmal meine ersten Ideen oben in der Themenliste als Vorschag gesammelt, welche natürlich auch noch von der "Willkommen" Seite woanders hin verschoben werden können.
Die beien roten Kästen mit der Warnung, welche einem beim Öffnen der Willkommen Seite in der Doku entgegenspringen würde ich als erstes entfernen, da sie einen Besucher eher abschrecken als ihm helfen. Die Information kann man auch schonender unterbringen.
Aus meiner Sicht muss es das Ziel sein, dass die Willkommensseite so verständlich ist, dass man die Inhalte versteht ohne tiefer in die Doku / ioBroker einsteigen zu müssen.
Hat jemand schon irgendwelche Highlevel Grafiken, welche die Funktionsweise von ioBroker visualisieren?
-
@feuersturm sagte in Brainstorming Doku Abschnitt "Willkommen":
Die beien roten Kästen mit der Warnung, welche einem beim Öffnen der Willkommen Seite in der Doku entgegenspringen würde ich als erstes entfernen, da sie einen Besucher eher abschrecken als ihm helfen.
es gibt im Framework zwei zusätzliche Features, die im md auf Github keine Wirkung haben.
Das sind die roten und blauen Kästen.ich verstehe deinen Absicht, aber wirklich wichtiges, was bei Nichtbeachtung zu Fehlern führt, sollte in roten, zusätzliche "etwas wichtige" Infos in blauen Kästen stehen.
Natürlich sind selbst die roten Kästen leider keine Garantie Dafür, dass sie auch gelesen werden.
Anscheinend werden sie sogar gerne Übersprungen
-
Was haltet ihr davon, wenn man nach dem ersten Einführungstext https://www.iobroker.net/#de/documentation folgende Grafik inkl. des nachfolgenden Textbausteins ergänzt wird. Hilft die Grafik einem Besucher/Anfänger?
=====================
Diese Grafik zeigt wie ioBroker als Middleware vereinfacht funktioniert, um verschiedene Smarthomelösungen oder weitere Dienste (z.B. Kalender) miteinander zu verbinden.
Die in ioBroker zur Verfügung stehenden Adapter können unter anderem mit zentral verwalteten Kalendern oder herstellerspezfischen Smartehomesysteme (welche im LAN oder WLAN angeschlossenen angeschlossen sind) kommunizieren. Auf diese Weise kann die ioBroker Software Statusinformationen lesen oder Daten schreiben, um Aktionen zu triggern.Nehmen wir an, dass ein Anwender in der Wohnung bereits einige Lampen über Philipps Hue steuert sowie seine Rolläden über Homematic IP öffnen und schließen kann.
Mit dem Einsatz der ioBroker Software ist es nun möglich eine Anwesenheitssimulation zu realisieren, in welcher die Hue Lampen ein- und ausgeschaltet und die Rolläden hoch und runter gefahren werden können wenn der Anwender im Urlaub ist.
Über die Logikbausteine (Adapter Logikprogrammierung) kann der Anwender mit wenigen Schritten den folgende Ablauf realisieren:
- Wenn im Kalender der Eintrag "Urlaub" eingetragen ist, werden ab 18 Uhr Abends abwechselnd verschiedene HUE Lampen ein- und ausgeschaltet.
- Um 22:00 Uhr werden alle Rolläden geschlossen und alle Hue Lampen ausgeschaltet.
- Um 08:00 Uhr morgens werden alle Rolläden wieder hochgefahren.
Über den "Adapter User Interface" kann sich ein Anwender individuelle Status und Steuerungsseiten für seine Hue Lampen und Rolläden bauen, auf die mit den mobilen Endgeräten von zu Hause oder aus dem Urlaub (z.B. mittels ioBroker Cloud Services oder VPN) zugegriffen werden kann.
=====================
-
Die Grafik gefällt mir.
EinsteigerfreundlichVielleicht einen kleinen Hinweis, das es sich um eine Beispielkonfiguration handelt.
Und bei Kalender würde ich Google rausnehmen.
Es gibt ja mehrere Möglichkeiten, Kalender in ioBroker einzubinden.Gruß, Karsten
-
@feuersturm sagte in Brainstorming Doku Abschnitt "Willkommen":
Hilft die Grafik einem Besucher/Anfänger?
Einem Besucher allemal - einem Einsteiger oder Interessenten nicht unbedingt.
Ich habe die Befürchtung, dass wir, die wir die Zusammenhänge schon kennen, das gar nicht bewerten können.So fehlt mir -habe aber auch keine Lösung- eine Einbindung der Logikmaschinen
Die Datenpunkte, die durch die Adapter angelegt werden, und auf die die Logikmaschinen zugreifen fehlen in dem Schema.Ob deren Einbindung das Schema überladen wird, ist natürlich möglich.
Aber es kommen immer wieder Einsteiger mit Fragen, die alles wunderbar eingerichtet haben und sich jetzt wundern, dass nichts von selber läuft
-
@homoran sagte in Brainstorming Doku Abschnitt "Willkommen":
Einem Besucher allemal - einem Einsteiger oder Interessenten nicht unbedingt.
Es ist ja auch für Besucher/Erstintetessierte gedacht. In den Kästen passiert auf dem Niveau einfach nur ein Wunder. Tiefere Details würden diese Grafik aus meiner Sicht überladen und gehören dann eher in eine Architektur für Interessierte/Fortgeschrittene.
Die Einsteiger mit ihren Fragen dürfen und sollen ja weiterhin kommen. Dafür ist ioBroker zu mächtig und die Betriebssysteme und Installationen zu vielfältig als das man das in einer Doku abfangen könnte.
-
@feuersturm sagte in Brainstorming Doku Abschnitt "Willkommen":
Tiefere Details würden diese Grafik aus meiner Sicht überladen und gehören dann eher in eine Architektur für Interessierte/Fortgeschrittene.
Alles gut!
Die Grafik ist toll.Nur die Frage wie verschiedene Geräte miteinander interagieren können ist IMHO bei einer Plattform, die genau dafür gedacht ist, kein Thema nur für Interessierte/Fortgeschrittene.
Dass eine vollständige Funktionsbeschreibung diese Grafik überladen wird ist eine Tatsache.
Ich habe eben auch keine Idee wie man diesen gordischen Knoten zu zerschlagen kann.Der darunterliegende Text ist ja dann schon der richtige Ansatz, so wie du es hier in dem Beispiel hast:
@feuersturm sagte in Brainstorming Doku Abschnitt "Willkommen":
Über die Logikbausteine (Adapter Logikprogrammierung) kann der Anwender mit wenigen Schritten den folgende Ablauf realisieren:
Vielleicht sollte man nur noch einen ähnlichen kleinen Satz unter die Grafik setzen.
Wie:Automatisierte Abläufe zwischen den verschiedenen Geräten werden mithilfe eines Logikadapters erstellt
Und dann ggf. ein Link auf die Seite Logik
-
Den aktuellen Arbeitsstand der "Willkommen" Seite für die Doku findet ihr hier: https://github.com/Feuer-sturm/ioBroker.docs/tree/FS-welcome/docs/de#readme
Wer möchte kann ja schon einmal etwas lesen. Wenn ihr Vorschläge für Ergänzungen / Änderungen habt könnt ihr diese auch gerne hier im Forum posten und ich übernehme sie dann auf github.
-
Ich bin wieder ein kleines Stückchen weiter gekommen (https://github.com/Feuer-sturm/ioBroker.docs/blob/FS-welcome/docs/de/README.md)
Als nächstes ist der Abschnitt Visualisieurng dran. Da ich nur VIS im Einsatz habe fehlt mir der Überblick, was es sonst noch so alles gibt.
Frage an euch:
- Welche Visualisierungsadapter gibt es aktuell so
- Postet doch mal hier ein paar schöne Bilder von den verschiedenen Umsetzungen der Visualisierungen wo ihr der Meinung seit, dass diese auf der Einführungsseite von ioBroker einen WOW Effekt beim Leser hinterlassen (auch wenn natürlich jeder seinen eigenen Geschmack hat)
-
@feuersturm sagte in Brainstorming Doku Abschnitt "Willkommen":
für Ergänzungen / Änderungen habt könnt ihr diese
Systemen und Geräten von A wie Alexa bis Z und vielewie zigbee
da haben sich ein paar Rechtschreibfehler eingeschlichen
-
@crunchip Immer her mit den Fehlern oder wenn du möchtest einen PR stellen.
-
Ausgewählte reale Anwendungsbeispiele, die es hier bereits im Forum unter mal zeigen will oder VIS von xxx, etc. gibt
Am besten ist es die Leute zu begeistern, in dem man zeigt, was andere wirklich geschafft haben. Mit Bilder(Raumschemas),Fotos (von Schaltschränken, von Relais zum Gartenteichpumpe steuern, tolle Beispiele bei dem sich jemand getriggert fühlt und sagt: will ich auch haben), Screenshots von Vis-Steuerungszentralen)
-
Der erste Pullrequest ist gestellt: https://github.com/ioBroker/ioBroker.docs/pull/375
Wer möchte darf gerne noch einmal drüber lesen und auch gerne noch Anmerkungen einarbeiten.closed Überarbeitung ioBroker Willkommen Doku Seite #375
-
@feuersturm hab gerade mal gelesen, dabei ist mir aufgefallen, das die Verlinkungen nicht funktionieren
-
Sieht gut aus.
-
