[Aufruf] Glossar alle zusammen schreiben!

[Bluefox]

Hallo Community!

Da wir erhebliche Probleme mit der Erstellung von Dokumentation haben (Homoran ist überlastet), will ich euch trotzdem dazu motivieren ein paar Worte für Doku zu schreiben.

Aktuell steht auf der ToDo-Liste die Erstellung von Glossar.

Welche Begriffe müssen beschrieben werden? Ich habe folgende zusammen gefasst.

js-controller
Adapter
Instanz

Objekt
Zustand oder State
Kanal
Gerät

Redis

Host
Aufzählung
Admin

Szene
Skript

vis
Widget

Cloud

CCU
Homematic

Raspberry PI
Odroid
Cubietrack

Was fehlt noch?

Hier kann man ein Entwurf finden:

https://github.com/ioBroker/ioBroker.do … LOSSARY.md

[Homoran]

@Bluefox:

(Homoran ist überlastet), `
:mrgreen:

Naja, bevor ich mich ransetze, hast du ja schon alles gemacht

Aber wenn es dann in die Tiefe geht brauchen wir spätestens wenn es um Doku zu (Adaptern oder Howto) zu Hardware, die ich nicht habe viel Unterstützung.

Im Glossar hätte ich mich wahrscheinlich nur auf IoT spezifische Begriffe die mit ioBroker verwendet werden beschränkt.

Die Erklärung z.B. der Einplatinen-Rechner könnte das Ganze evtl. zu stark aufblähen.

Was ist eire Meinung?

Gruß

Rainer

[eric2905]

@Homoran:

Im Glossar hätte ich mich wahrscheinlich nur auf IoT spezifische Begriffe die mit ioBroker verwendet werden beschränkt.

Die Erklärung z.B. der Einplatinen-Rechner könnte das Ganze evtl. zu stark aufblähen.

Was ist eire Meinung? `
Ich denke, die Erklärungen für "einfache Dinge", wie eben Einplatinen-Computer, sollten wir einfach zu Wikipedia verlinken.

Nur das wirklich IoT oder ioBroker-Spezifische sollte in unserem Glossar beschrieben werden.

Das wird ansonsten zu viel.

Gruß,

Eric

[frankjoke]

Ich weiß dass es vielleicht nicht zu der Frage passt aber eine umgekehrte Liste wäre fast noch wünschenswerter, z.B. auf der Homepage weden viele Ausdrücke und Adapter gelistet aber nirgends in die allgemeinen Begriffe (nach denen ich googlen würde) eingeteilt!

Beispiele:

ioBroker Hausautomatisierung ermöglicht:

Rolladensteuerung:

• XS1, Homematic,

Kommunikation:

• Sayit, mail, Telegram, …

Programmierung, Scripte:

• Node-Red, Javascript, Blocky, ...

Heizungssteuerung:

• Homematic, XS1, KM200, ....

Hardware-IO:

• RPI2, *

Visualisierung und Webserver:

• Web, Vis, Flot, ...

Datenspeicherung:

• SQL, ...

Cloud & IoT:

• cloud, MQTT, ...

Anwesenheitserkennung:

• radar, ...

und viele andere die ich selbst noch nicht kenne!

[kmxak]

es gibt auf seiten im internet so ein mouseover wenn man bestimmte begriffe benutzt die dann in einem kleinen popup erklärt werden. vielleicht wäre das auch was.

Ihr schreibt z.b in den Logs schauen.. das wäre logs das wort wo kurz drin steht wo die zu finden sind… als Beispiel.

Am meisten probleme habe ich aktuell mit VIS begriffen (div, boolean....) sowie im blockly o.ä. Ist alles quasi wie vokabeln lernen.

Z-Wave

Zigbee

Homematic

...

RF-Link

RFID

...

git

git hub

npm

...

[Homoran]

@fsjoke:

eine umgekehrte Liste wäre fast noch wünschenswerter, z.B. auf der Homepage weden viele Ausdrücke und Adapter gelistet aber nirgends in die allgemeinen Begriffe (nach denen ich googlen würde) eingeteilt!

Beispiele:

ioBroker Hausautomatisierung ermöglicht: `
Eine sehr gute Idee für das Intro!

Passt jetzt nicht ganz hierher, aber ich hoffe es nicht zu vergessen, wenn ich die Startseiten bauen will.

Gruß

Rainer

[Bluefox]

Ok. Da die Resonanz sehr überschaubar war, nehme ich an, dass es nicht so wichtig ist.

Und dass die Doku in der Form auch ausreichend ist.

[Homoran]

Das Glossar ist schon wichtig!

Als Betriebsblinder war ich ja erschrocken als ein Nicht HM User verzweifelt fragte was eine CCU sei. Da denken wir eingefleischte HM User gar nicht mehr drüber nach.

Das wird dann aber mit der Doku wachsen!

Gruß

Rainer

[arteck]

ich würde sagen so bestimme Abkürzung wie CCU die man nicheben mal so findet sollten rein aber..

Raspberry … oder Homematic oder Admin.... Cloud...

na ich weiss nicht.. braucht man das..

[Homoran]

Ja, bitte versucht mal im Sinne derer zu denken, die gerade dieses Gerät/Protokoll oder wasauchimmer NICHT kennen mit diesem Begriff anfangen können!

Dies Begriffe sollten alle im Glossar enthalten sein.

Die Idee mit einem (zusätzlichen) Link zu einer ausführlicheren Erklärung ist auch nicht schlecht.

Gruß

Rainer

[Jey Cee]

@bluefox es sind zwar nur wenige stimmen, aber es ist eindeutig das ein Glossar gewünscht ist.

Ich bin dafür alles auf zu nehmen was relevant ist.

Der Vorschlag von kmxak ist super so wäre das am Effektivsten genutzt.

[dna909]

Ich hab einfach mal ein bissel angefangen.

[paul53]

@dna909:

Ich hab einfach mal ein bissel angefangen. `
… und ich etwas weiter gemacht:

js-controller

Objekt

Datenpunkt oder State

[dna909]

Ich versuche das irgendwie so zu beschreiben, das es auch ein Laie evtl. ein wenig versteht. Das ist garnicht so einfach.

Nun bräuchte ich aber noch mehr Stichworte. Die Frage ist ja auch, wie detailliert das Ganze werden soll?

[Homoran]

Danke,

habe schon gesehen, dass ihr was committed hat, aber noch nicht was.

@dna909:

Ich versuche das irgendwie so zu beschreiben, das es auch ein Laie evtl. ein wenig versteht. Das ist garnicht so einfach. `
Willkommen im Club :lol:

@dna909:

Nun bräuchte ich aber noch mehr Stichworte. Die Frage ist ja auch, wie detailliert das Ganze werden soll? `
Wie gesagt, dass muss wachsen.

Soweit wie es irgendgeht und später ergänzen.

Gruß

Rainer

[Mifo]

Könnte man nicht, unter Einhaltung der Urheberrecht-Bestimmungen Wikipedia-Texte für bestimmte Begriffe nehmen so z.B für Admin

Wikipedia beschreibt einen Admin als Benutzer, welcher über zusätzliche Werkzeuge verfügen (oft scherzhaft als „Die Knöppe“ bezeichnet), mit denen bestimmte Verwaltungsaufgaben vorgenommen werden können. Dazu gehören zum Beispiel das Löschen von Seiten oder das Sperren von Benutzern.

oder so

könnte allenfalls ja auch mit der spezifischen Quellenangabe gemacht werden (Quelle:https://de.wikipedia.org/wiki/Wikipedia:Administratoren )

Grüsse

Mike

Mod Edit von Jey Cee: Du kannst deinen Beitrag Editieren wenn du auf das Stift-symbol oben rechts in deinem Beitrag Klickst.

[Bluefox]

Ok. Start war sehr gut. 3 Leute haben die Texte hinzugefügt.

Ich war zu langsam und konnte nicht rechtzeitig mergen, deswegen an einigen Stellen sind Doppeltexte entstanden.

Mir gefehlt das Wort Zustand nicht. Auf English ist das State und klingt gut.

Vielleicht taufen wir Zustände nach Werte?

Objekte und Werte?

Und bitte noch mal diesen Punkt anschauen, was konnte da verbessert werden:

https://github.com/ioBroker/ioBroker.do … d-zustände

Und VIELEN DANK!

[Homoran]

Hallo Bluefox,

Zustand ist besser als Werte!

von mir aus bleiben wir auch beim State.

Ein Zustand kann verschiedene Werte annehmen, das bringt IMHO Verwirrung.

wie wäre es mit einer alphabetischen sortierung?

duckundwech

Gruß

Rainer

der vor 15 Minuten gepullt hat und der Fix hat geklappt!

[paul53]

@Bluefox:

Vielleicht taufen wir Zustände nach Werte?

Objekte und Werte? `
Der Wert ist nur ein Bestandteil von Zuständen (States). Habe neuen pull request erzeugt.

[Homoran]

Erst einmal vielen Dank allen die bisher geholfen haben.

Ich habe eben das Glossar alphabetisch sortiert, ein wenig aufgeräumt und etwas ergänzt.

Natürlich gibt es da noch viel zu tun. Mit jeder Erläuterung kommen "eigentlich" weitere erklärungsbedürftige Begriffe dazu

Nachdem ich als Noob die alte Website erstellt hatte war ich jetzt langsam in HTML drin. Jetzt muss ich alter Sack mich noch mit Markdown beschäftigen. Meine Idee war es (zumindest wenn hier und da ein :siehe xy drinsteht) einen Link dorthin zu setzen.

Leider weiß ich (noch) nicht wie man das macht. (Habe ich zwar schonmal gehabt muss ich mit meinem Alzheimer aber wieder raussuchen)

Das weitere Problem ist, dass dieses Glossar für die neue Website entwickelt wird und in dieser die Doku noch nicht die endgültige Form und Struktur hat. Ein Verlinken zur Doku das jetzt funktioniert läuft ggf. später ins leere

Bitte macht hier weiter (und natürlich andere zusätzlich) fleissig mit, dann wird das bald.

Gruß

Rainer