Doku optimieren - Input gesucht!
-
Hallo alle zusammen.
Die ioBroker Gemeinde wächst und gedeiht.
In der Zwischenzeit habe ich es wenigstens geschafft die Doku für die wichtigsten Adapter auf Vordermann zu bringen:
-
Admin
-
hm-rpc
-
hm-rega
-
vis
-
History
-
influxDB
-
SQL
-
flot
-
web
-
Alexa <size size="85">(wurde von Eric2905 erstellt)</size>
Damit konnte ich dann endlich auch die Einsteigertutorials wieder erstellen, aber…
ioBroker ist wesentlich mehr als ccu.io v2.0
Bisher kamen die meisten aus der Homematic-Ecke (so wie ich) und ich habe weitestgehend alles für diese User optimiert.
Inzwischen gibt es aber auch etliche User, die mit Homematic nichts anfangen können und von ganz anderen Systemen zu ioBroker kommen, was wir ja auch immer haben wollten.
Und genau von diesen Usern benötige ich jetzt Input!
-
Was wäre ein Thema für ein "nicht-HM"-Tutorial?
-
welche Adapter benötigen am wichtigsten eine Doku?
-
wo gibt es Einstiegsschwierigkeite?
-
–sonstige Fragen
Für die ersten Punkte wird es mir dann gehen, wie es euch jetzt mit den HM-Komponenten geht
ich werde (wenn bezahlbar) mir diese Hardware zulegen und gemäß eurer Wünsche testen und anschließend beschreiben.
Ich bitte um rege Antworten.
Rainer
PS …und wenn wir schon dabei sind, bitte auch Feedback zu dem jetzigen "Zustand" der Website: Inhalt, Qualität, Finden, Verständnis.....
-
-
Moin,
ich bin seit einigen Tagen erst angemeldet und seit 2 Tagen aktiv am bauen.
Mir haben die Dokos SEHR geholfen! Einen großen Dank hierfür!
Bislang war alles sehr verständlich und gut erklärt. Ich suche mir das passende meist per google auch hier passt die verlinkung wen man was sucht.
Ich bin aktuell der User der kein HM benutzt. Ich wollte erstmal das ganze System verstehen und testen bevor ich mir HM Komponenten zulege. Ich bin dank des Forums und der Dokus nun soweit das ich mich an die HM Komponenten rantraue und werde mal schaun womit ich starte.
Was mich Interessiert ist die wifilight steuerung allerdings scheint da der adapter probleme zu haben mit den ld382a Komponenten. Nutze daher die Steuerung der Lichter über FHEM.
Macht weiter so!
Nochmal danke für eure tolle Arbeit
Alex
-
Ich suche mir das passende meist per google `
Danke (für das Lob und den Ar…tritt )Ich habe die Suche auf der Seite endlich mal eben auf die Schnelle in den Kopf verschoben. Im Seitenfuß hat sie niemand gefunden.
@Bluefox: sollte das besser woanders sein??? ist wirklich nur mal eben verschoben.
Gruß
rainer
-
Ich muss diesen Thread mal wieder nach oben holen.
Wir sind im Moment mit der Website an einem Punkt angelangt wo mehr Info eher nicht unbedingt mehr Auffindbarkeit und erst recht keine Übersichtlichkeit mit sich bringt.
Wir müssen und werden dringend etwas umbauen.
Da dies jetzt die drite Komplettrevision der Website wird wäre es wirklich schön, wenn wir hier einiges mehr an Info bekämen, damit wir es diesmal "wirklich richtig" machen!
Gruß
Rainer
-
Hier meine Meinung/Vorschläge:
Die Adapter liste sollte dringend von der Startseite weg, genau so der Text der etwas über ioBroker erzählt.
Und bei den News sollte man darüber Nachdenken ob man sie entweder mehr pflegt oder ganz weg lässt.
Das hinterlässt so den Eindruck das kaum etwas passiert.
Den Spenden Button könnte man wie im Forum in den Kopf verschieben, an der jetzigen Stelle wirkt er deplatziert.
Die Links zu den Demos sind gut auf der Startseite, könnten aber schöner aussehen.
Statt dem großen Blauen Banner könnte man eine Slideshow einbauen auf der man schon mal einen Eindruck bekommt wie ioBroker aussieht. Dort kann man dann auch gleich so Stichpunktartig auf Zählen was ioBroker kann. Hier verweise ich mal auf http://www.openhab.org.
Ich stelle mir vor das ein Screenshot vom Admin Bereich auftaucht und dazu der Button Demo.
Außerdem wäre es super wenn schon auf der Startseite klar wird das es sich um ein offenes Projekt handelt. Ein Slogan wie "Offen für Alle und Alles dank Open Source" fände ich gut.
Insgesamt wäre es gut die Startseite so zu gestalten das kein Scrollen Notwendig ist, das wirkt einfach Sauberer.
Dann ist mir aufgefallen, es gibt jetzt einen Shop?! Es ist ja in Ordnung das es einen gibt, aber bitte nicht an zweiter stelle im Menü. Das vermittelt den Eindruck das ioBroker eine Firma oder ein Käufliches Produkt ist. Das schreckt interessierte ab. Wenn der Spenden Button oben im Kopf ist und dort in der Nähe ist dann der Shop dämpft das den Eindruck.
Was noch fehlt ist der Punkt "Über das Projekt".
Die Menüpunkte Einleitung und Installation/Start könnte man Zusammen führen. Den Unterpunkt "für alle" kann man in der Zukunft auflösen.
Eine neue Gliederung von Installation/Start könnte "der Rote Faden" werden den viele Neulinge vermissen.
Mal ein Vorschlag für die Gliederung:
1. Voraussetzungen
2. Installation
a) Linux (alle Hardware Plattformen)
b) Windows
c) Mac OS
d) Images, VMs und Docker
e) Andere (NAS, VU+ Duo, …)
3. Erstkontakt mit ioBroker Admin
4. Adapter
5. Logik (Programmierung)
a) "Hallo Welt" - Beispiel
b) Einführung Programmierung mit JavaScript
c) Einführung Programmierung mit Blockly
d) Einführung Programmierung mit Node-Red
6. Cloud und Alexa
7. Update von ioBroker
8. Multihost Modus
Zu 3: Hier sollte der erste Aufruf der Webseite zu finden sein, eine Erklärung welche Einstellungen und Möglichkeiten (Autodiscovery) man hat/machen muss/kann. Dann eine Kurze Erklärung wo was zu finden ist (Bedienelemente etc.).
Zu 5a: Dieses Beispiel sollte für jeden Nachvollziehbar sein, das heisst unabhängig von Hardware. Außerdem sollte es mit JavaScript, Blockly, Szenen und Node-Red gezeigt werden. So hat man auch gleich eine Übersicht welche Möglichkeiten der Programmierung man in ioBroker hat.
Wichtig ist gleich hier den Zusammenhang zwischen der Logik und Vis zu zeigen.
Als Beispiel Vorschlag: Ein Widget (Taster/Schalter) das bei Betätigung ein zweites Widget Sichtbar werden lässt und nach 30 Sekunden wieder verschwindet.
Allgemein sollte für die Installation am ende eines jeden Abschnitts ein Link "Weiter zum nächsten Schritt" zu finden sein.
-
Ich hatte es schon mal woanders geschrieben. Ich denke für die meisten ist die Möglichkeit der Visualisierung der Einstieg in iobroker.
Ist die erste Hürde, nämlich die Installation der Plattform (Raspi, Banana, Windows…) genommen. Freut man sich und will "was schalten"
Aber wie??? Gefühlte tausend widget-Pakete mit mehr oder weniger sprechenden Namen. :shock: Ich fände ein widget-starter-Paket nicht schlecht, das auch ausführlich dokumentiert ist. Wenn man da erstmal durchgestiegen ist, hat man ja schon ein paar Erfahrungen mit states, events und was weiß ich. Die folgenden Widgets müßten m.M. dann nur noch bezüglich ihrer Besonderheiten beschrieben werden. Da muß man (homoran ) nicht beim Urschleim beginnen.Zudem sollte noch deutlicher hervorgehoben werden, was welcher Adapter kann. Meine Erleuchtung war der TR-064-Adapter. Ein cooles Teil mit vielen Möglichkeiten. Aber irgendwie "dümpelte" er zuvor ungesehen in der Adapterliste. Genauso der RM3-Adapter für die Broadlink Geräte. Bestimmt auch ein cooles Teil, wenn man das passende (kostengünstige) RM3-Pro hat. Das man damit IR und RF schalten kann und damit auch die billig Steckdosen ist doch ein gewichtiges Argument für iobroker.
Ich werde mir mal die neuen Dokus aus Sicht eines Neulings anschauen und berichten.
Grüße Andreas
Edit: Die neue Einsteiger Doku ist wirklich sehr gelungen!!! Mit DER Doku würde ich mich sofort trauen.
Tolle Arbeit, Rainer! (Daumenhochsmilie) -
Danke ihr beiden!
Mal ganz kurz:
@jeycee:
Block 1 ok, nur was sind News? In der alten Version der Website hatte ich alle News wenn ich eine Adapterdoku neu oder überarbeitet hatte oder wenn ein Adapter neu oder in neuer Version auftauchte. Das wurde irgendwann zuviel - irgendwelche Ideen?
Titelseite ohne scrollen: bin ich voll bei dir; Landingpage mit etwas Text und ein paar Buttons.
Aber für welche Auflösung? Bei responsiven Designs passt es wahrscheinlich nur bei eiber Auflösung optimal.
Shop :shock: :shock:
Gerade zum ersten mal gesehen. Zumindest im Moment nur links zu Amazon.
Die Gliederung liegt mir am meisten am Herzen! Hier hätte ich nur sehr gerne Feedback von Einsteigern!
@Jey Cee:am ende eines jeden Abschnitts ein Link "Weiter zum nächsten Schritt" zu finden sein. `
Dies "geführte Lesen" szeht bei mir ganz oben auf der ToDo.Meinen Plan verrate ich noch nicht, aber eure Infos passen da sehr gut rein.
Urschleim hin oder her irgendwo sollte auch das letzte Komma beschrieben werden. Die neueren Adapter habe ich noch gar nicht angefasst
@weimaraner:Ich werde mir mal die neuen Dokus aus Sicht eines Neulings anschauen und berichten `
Ich bitte drum!Die neue Einsteiger Doku ist wirklich sehr gelungen!!! `
Danke!Hat aber viel zu lange gedauert die wiederzubeleben. Außerdem ist sie auf HM abgestimmt.
So etwas muss ich noch für alle nicht HM User machen.
Gruß
Rainer
-
Block 1 ok, nur was sind News? In der alten Version der Website hatte ich alle News wenn ich eine Adapterdoku neu oder überarbeitet hatte oder wenn ein Adapter neu oder in neuer Version auftauchte. Das wurde irgendwann zuviel - irgendwelche Ideen? `
Wie wäre es wenn man sich vor nimmt 1 bis max. 4 News pro Monat zu Veröffentlichen. Damit wäre es überschaubar und man macht nicht wegen jeder Kleinigkeit eine News, sondern sammelt es und haut es geballt raus.Als News sehe ich Neue Adapter respektive neu eingebundene Hardware, größere/wichtige Neuerungen am Grundsystem und zum Beispiel wenn es Vorträge auf Messen/Usertreffen oder der gleichen gibt.
Aber für welche Auflösung? `
Das ist eine gute Frage, dazu müsste man jetzt wissen welche Auflösung am häufigsten verwendet wird um die Seite auf zu rufen.Ohne jetzt irgendeine Zahl zu kennen würde ich zu 1920x1080 Tendieren, das sollte zumindest im PC/Laptop Bereich zu 80% passen.
-
In den News sollten auf jeden fall die neuen Adapter stehen. Kurze Beschreibung wofür der Adapter ist und/oder welche Hardware er anspricht. Änderungen an den Adaptern nur, wenn sie von grundsätzlicher Bedeutung sind. Ältere News sollten entfernt werden. Ich finde nichts schlimmer, als eine ein Jahr alte "Neuigkeit" angekündigt zu bekommen.
Die Sache mit dem Scrollen sehe ich nicht so kritisch. Eine gute Menueführung ist allemal wichtiger, als der "Ein-Seiten-Zwang". Wobei das eine das andere natürlich in gewisser Weise beeinflußt.
Grüße Andreas
-
Aber für welche Auflösung? `
Nutzt ihr Google Analytics? Da ist ein Feature integriert, das quasi eine Karte anzeigt, wie viel % der User welchen Bereich sehen. War ehemals ein externes Tool namens BrowserSize, das man sich auch mit etwas Aufwand nachbilden kann: http://www.searchenginepeople.com/blog/ … ative.html -
Gerade durch den Kopf geschossen. Weiß nicht ob es das schon gibt.
Gleich auf einer der ersten Seiten könnte man eine Übersicht erstellen was mit ioBroker aktuell geht!
Eine Auflistung oder Logos der Firmen die Unterstützt werden damit man auch gleich sieht… geil das funzt dann ist das das richtige für mich.
Ich musste oder habe mich erst schwierig durch das Forum gelesen ob meine Hardware auch damit zu bedienen ist.
