<![CDATA[Grundidee der Themenausrichtung der Doku]]>Hi auch von mir,

da ich an der groben Themenstruktur der (leider) teilweise noch eher schlecht gefüllten Seiten nicht unschuldig war hier auch noch ein bissl Kontext von mir.

Die Doku in der Webseite hat die Challenge verschiedene Zielgruppen abzudecken. So richten sich verschiedenen Bereiche der Webseite auch an verschiedene Zielgruppen.

Diese Zielgruppen würde ich mal grob wie folgt einteilen:

  • Interessenten: haben von ioBroker gehört oder kommen per Google und wollen schauen/verstehen was das Ding tut und kann. Da geht es also um "kurz und knackig", bissl "Marketing" darf auch dabei sein und 100% Korrektheit in allen Fakten braucht es vllt nicht immer
  • Einsteiger: Sind die, die wirklich erste Schritte mit ioBroker machen
  • Benutzer: Nutzen es aktiv, also nach den ersten Schritten
  • Fortgeschrittene: Nutzen es länger und fangen an nicht mehr Standarddinge tun zu wollen
  • Power-User: Hier sind wir schon weiter weg vom Standard :-)

Jetzt könnte man fleissig über Details hierzu streiten und wer was ist und was will, aber ich denke als grobe Einstufung reicht es erstmal (und ja die Zielgruppen haben große Überschneidungsbereiche, was aber auch ok so ist).

Bevor jetzt eine Diskussion wegen dem Begriff "Marketing" aufkommt: Am Ende gibt es mehrere (Open Source) Smart-Home-Systeme: Neben ioBroker sind das als Open Source OpenHab, Hass und FHEM und noch einige kleinere und dann viele kommerzielle Alternativen wie Homey, Homee und und und. Damit müssen wir als Open Source Projekt genauso "Marketing" machen warum ioBroker das geilste der Projekte ist und warum ein User sich dafür entscheiden soll :-) Es gehört für das "Gesamtprojekt" "Webseite und Doku", um die es hier geht, meiner Meinung nach eindeutig mit dazu.

Jetzt zu den ersten "Seiten" und der groben Idee dahinter (gern als Diskussionsgrundlage wobei wir mal schauen müssen "wie" wir das am besten diskutieren):

  • Willkommen: Naja wie es sagt willkommen; vor allem aber Interessenten und Einsteiger abholen und "Leiten" (alle anderen klicken da eh nicht mehr hin)
  • Grundlagen: Überblick für Interessenten und generelles Verständnis von "den zentralen Begrifflichkeiten" die man braucht (und nein ist kein Glossar) :-) Aber heir kurz und knackig und gern bissl "Marketing" machen. :-) Wenn man es "genau" erklären will dann bitte die Seite zweistufig machen ... oben "TLDR;" style und gern Details weiter unten und auch klar gekennzeichnet das es hier "genauer" wird (oder vllt direkt auf einer Unterseite), sonst vergrault man Interessenten weil es so komplex wird :-) Da müssen wir noch eine "sinnvolle Form finden"
  • Installation: How to install, Für Interessenten mit "ist ja ganz easy"-Message und für Einsteiger halt als "How to".
  • Admin-Oberfläche: Dieser Bereich soll nicht eine Admin-Doku ersetzen! Sie soll für Interessenten und Einsteiger zeigen wie das ganze aussieht und quasi bei den ersten Schritten helfen um nen Überblick zu bekommen. Für mehr dann zur Admin Doku (die auch noch todo ist) verlinken
  • Tutorials: Ja wie der Name sagt für Einsteiger und Benutzer, ggf auch Interessenten zum überfliegen
  • Visualisierungen: Hauptseite bzw die "typen der visus"-Unterseiten ist wieder für Interessenten damit sie sehen was geht, und je tiefer umso spezifischer und ggf für die anderen Zielgruppen ... Zu DOku der Visus verlinken
  • Logik und Automatisierung: ebenso: beginn mit Überblick was geht für Interessenten und Einsteiger, "je tiefer" umso spezifischer für die anderen
  • Cloud Services & Apps: das gleiche
  • Erweiterte Konfiguration: Jetzt startet es mit dem was ggf nicht alle tun oder brauchen, also geht es mit "Benutzern" als Ziegruppe los ... und am Ende alle
  • Fehlerbehebung: Ab Benutzer, am Ende die Standard Troubleshooting Themen
  • FAQ: Ab Benutzer am Ende des Tages, idealerweise dort schauen bevor man Issues öffnet oder im Forum postet :-)
  • Unterstützung: Wie kann man als User das Projekt unterstützen
  • Adapterentwicklung: verschwindet als Content und ist später nur noch ein Link zur Dev-Doku
  • Systemintegratoren: Da geht es Richtung kommerzieller Nutzung ... würde ich hier auch mal ausklammern.

Macht das Sinn?

]]>https://forum.iobroker.net/topic/51794/grundidee-der-themenausrichtung-der-dokuRSS for NodeTue, 18 Aug 2026 20:03:30 GMTTue, 25 Jan 2022 13:30:23 GMT60<![CDATA[Reply to Grundidee der Themenausrichtung der Doku on Wed, 26 Jan 2022 18:31:35 GMT]]>@paul53 sagte:

@homoran sagte: Ist alles gemerged

content.md noch nicht?

Doch! 😂

Danke für den Tritt!
Hatte es irgendwie verschlafen.
Github hatte sich immer wieder aufgehängt ("Checking for automerge" oder so), da muss ich es übersprungen haben

]]>https://forum.iobroker.net/post/749723https://forum.iobroker.net/post/749723Wed, 26 Jan 2022 18:31:35 GMT<![CDATA[Reply to Grundidee der Themenausrichtung der Doku on Wed, 26 Jan 2022 18:27:25 GMT]]>@homoran sagte: Ist alles gemerged

content.md noch nicht?

]]>https://forum.iobroker.net/post/749720https://forum.iobroker.net/post/749720Wed, 26 Jan 2022 18:27:25 GMT<![CDATA[Reply to Grundidee der Themenausrichtung der Doku on Wed, 26 Jan 2022 18:20:21 GMT]]>@deralff sagte in Grundidee der Themenausrichtung der Doku:

@muchul Findet die implementierte Suchfunktion dann auch nichts?
Ich denke schon. Daher die Frage, kann man auf Webseiten den Tastendruck "Strg+F" abfangen und die Suchfunktion aktivieren?

Kann ich leider nicht sagen:
https://github.com/ioBroker/ioBroker.docs/tree/master/docs/de/tutorial
hat keine integrierte Suchfunktion, glaube ich.

In der Firma benutzen wir confluence, das klappt auch Bereiche zu, wenn es eingestellt wurde und dort findet die integrierte Suche das eben nicht. Da flucht der komplette Support immer, weil wichtige Informationen eingeklappt werden.

]]>https://forum.iobroker.net/post/749716https://forum.iobroker.net/post/749716Wed, 26 Jan 2022 18:20:21 GMT<![CDATA[Reply to Grundidee der Themenausrichtung der Doku on Wed, 26 Jan 2022 18:16:36 GMT]]>@homoran sagte: Die Accent grave vor und hinter den Text

Genau das hatte ich vergessen. Danke!

]]>https://forum.iobroker.net/post/749713https://forum.iobroker.net/post/749713Wed, 26 Jan 2022 18:16:36 GMT<![CDATA[Reply to Grundidee der Themenausrichtung der Doku on Wed, 26 Jan 2022 18:14:57 GMT]]>@paul53 sagte:

@homoran sagte: in normalem Text geschrieben.

Wie muss man es schreiben, damit es nicht als Link dargestellt wird?

Ich habe es als inline Code dargestellt = ` Text `
Die Accent grave vor und hinter den Text

]]>https://forum.iobroker.net/post/749711https://forum.iobroker.net/post/749711Wed, 26 Jan 2022 18:14:57 GMT<![CDATA[Reply to Grundidee der Themenausrichtung der Doku on Wed, 26 Jan 2022 18:12:08 GMT]]>@homoran sagte: in normalem Text geschrieben.

Wie muss man es schreiben, damit es nicht als Link dargestellt wird?

]]>https://forum.iobroker.net/post/749708https://forum.iobroker.net/post/749708Wed, 26 Jan 2022 18:12:08 GMT<![CDATA[Reply to Grundidee der Themenausrichtung der Doku on Wed, 26 Jan 2022 18:10:59 GMT]]>@paul53 sagte:

Wie macht man das? Habe vergessen wie es geht.

was bitte?

du hattest, genau wie jetzt contend.md in normalem Text geschrieben. Das war dann tatsächlich ein Internetlink

]]>https://forum.iobroker.net/post/749707https://forum.iobroker.net/post/749707Wed, 26 Jan 2022 18:10:59 GMT<![CDATA[Reply to Grundidee der Themenausrichtung der Doku on Wed, 26 Jan 2022 18:10:19 GMT]]>@Homoran sagte: MOD-EDIT: Irreführenden Link entfernt

Wie macht man das? Habe vergessen wie es geht.

]]>https://forum.iobroker.net/post/749706https://forum.iobroker.net/post/749706Wed, 26 Jan 2022 18:10:19 GMT<![CDATA[Reply to Grundidee der Themenausrichtung der Doku on Wed, 26 Jan 2022 18:07:31 GMT]]>@paul53 Hab's gesehen - Danke
Ist alles gemerged - Habe zu spät gesehen, dass da bereits ein alter PR existierte.
Hoffe es ist jetzt alles sauber.

Werden wir sehen wenn der nächste Build läuft

]]>https://forum.iobroker.net/post/749705https://forum.iobroker.net/post/749705Wed, 26 Jan 2022 18:07:31 GMT<![CDATA[Reply to Grundidee der Themenausrichtung der Doku on Wed, 26 Jan 2022 18:15:48 GMT]]>@homoran
Habe die content.md angepasst. Schaden wird es sicherlich nicht.

]]>https://forum.iobroker.net/post/749703https://forum.iobroker.net/post/749703Wed, 26 Jan 2022 18:15:48 GMT<![CDATA[Reply to Grundidee der Themenausrichtung der Doku on Wed, 26 Jan 2022 14:23:29 GMT]]>@paul53 Bin gerade dabei deinen alias.md zu mergen.
Habe zu spät gesehen, dass die keine Inhalte haben.

Weisst du was im Header stehen muss, damit die ganzen Automatiken funktionieren?
Wir hatten damals die ganzen "Platzhalter" angelegt, damit diese Infos überall drin standen

]]>https://forum.iobroker.net/post/749596https://forum.iobroker.net/post/749596Wed, 26 Jan 2022 14:23:29 GMT<![CDATA[Reply to Grundidee der Themenausrichtung der Doku on Wed, 26 Jan 2022 14:21:28 GMT]]>@homoran sagte: Da gibt es keine .md

Es gibt auch eine content.md. Ob die angepasst werden muss, werden wir feststellen.

MOD-EDIT: Irreführenden Link entfernt

]]>https://forum.iobroker.net/post/749593https://forum.iobroker.net/post/749593Wed, 26 Jan 2022 14:21:28 GMT<![CDATA[Reply to Grundidee der Themenausrichtung der Doku on Wed, 26 Jan 2022 14:14:08 GMT]]>@paul53 sagte:

@homoran sagte: nein, die existiert
Ja, muss aber vielleicht angepasst werden?

Sorry! Ich schreibe Blödsinn. das ist ja nur eine .json. Da gibt es keine .md

]]>https://forum.iobroker.net/post/749591https://forum.iobroker.net/post/749591Wed, 26 Jan 2022 14:14:08 GMT<![CDATA[Reply to Grundidee der Themenausrichtung der Doku on Wed, 26 Jan 2022 14:23:50 GMT]]>@homoran sagte: nein, die existiert

Ja, muss aber vielleicht angepasst werden?

@homoran sagte in Grundidee der Themenausrichtung der Doku:

eine docs/de/alias.md oder wie immer der richtige Pfad wäre in allen Sprachen

Ich habe die Datei alias.md unter allen 4 Sprachpfaden erstellt (deshalb 5 PRs).

]]>https://forum.iobroker.net/post/749585https://forum.iobroker.net/post/749585Wed, 26 Jan 2022 14:23:50 GMT<![CDATA[Reply to Grundidee der Themenausrichtung der Doku on Wed, 26 Jan 2022 14:08:03 GMT]]>@paul53 sagte:

Meinst Du die docs/content.md?

nein, die existiert, aber eine docs/de/alias.md oder wie immer der richtige Pfad wäre in allen Sprachen, wenn ein neuer Menüpunkt Alias angelegt wird

]]>https://forum.iobroker.net/post/749584https://forum.iobroker.net/post/749584Wed, 26 Jan 2022 14:08:03 GMT<![CDATA[Reply to Grundidee der Themenausrichtung der Doku on Wed, 26 Jan 2022 14:06:32 GMT]]>@homoran sagte: Was genau aber sind dann Funktionen?

In HomeMatic: Gewerke

]]>https://forum.iobroker.net/post/749583https://forum.iobroker.net/post/749583Wed, 26 Jan 2022 14:06:32 GMT<![CDATA[Reply to Grundidee der Themenausrichtung der Doku on Wed, 26 Jan 2022 14:06:30 GMT]]>@muchul Findet die implementierte Suchfunktion dann auch nichts?
Ich denke schon. Daher die Frage, kann man auf Webseiten den Tastendruck "Strg+F" abfangen und die Suchfunktion aktivieren?

]]>https://forum.iobroker.net/post/749582https://forum.iobroker.net/post/749582Wed, 26 Jan 2022 14:06:30 GMT<![CDATA[Reply to Grundidee der Themenausrichtung der Doku on Wed, 26 Jan 2022 14:05:50 GMT]]>@homoran sagte: ich weiß nicht mehr ob dann die md-Datei dazu auch in der Struktur angelegt werden muss.

Meinst Du die docs/content.md? Das kann ich nachholen, wenn erforderlich.

]]>https://forum.iobroker.net/post/749580https://forum.iobroker.net/post/749580Wed, 26 Jan 2022 14:05:50 GMT<![CDATA[Reply to Grundidee der Themenausrichtung der Doku on Wed, 26 Jan 2022 14:05:33 GMT]]>@paul53 sagte:

Aufzählungen als Oberbegriff enthält auch noch Räume und ggf. Favoriten, ...

Ja das stimmt, Räume (deutsche Übersetzung 'Zimmer') hat ja eine eigene Spalte.

Was genau aber sind dann Funktionen?
enums_objects.png

Ich denke die Bezeichnunug des Menüpunkts bezieht sich auf diesen Spaltennamen

]]>https://forum.iobroker.net/post/749579https://forum.iobroker.net/post/749579Wed, 26 Jan 2022 14:05:33 GMT<![CDATA[Reply to Grundidee der Themenausrichtung der Doku on Wed, 26 Jan 2022 14:02:04 GMT]]>@paul53 sagte:

Bitte mergen

Sorry, betrifft jetzt nicht dich, aber ich musste gerade lachen.
Habe vor ein paar Stunden die deutschen Namen der Menüpunkte zum zweiten Mal geändert, nachdem ein Merge eines 7 Tage alten PullRequests meine damaligen Änderungen wieder überschrieben hatte 😂

Danke für die PRs, ich sehe mir die an.

@paul53 sagte in Grundidee der Themenausrichtung der Doku:

Und davor noch Alias als Datenpunkte mit speziellen Eigenschaften einfügen.

ich weiß nicht mehr ob dann die md-Datei dazu auch in der Struktur angelegt werden muss.
Ich glaube das war der Grund, warum da überall Platzhalter-Seiten stehen

]]>https://forum.iobroker.net/post/749575https://forum.iobroker.net/post/749575Wed, 26 Jan 2022 14:02:04 GMT<![CDATA[Reply to Grundidee der Themenausrichtung der Doku on Wed, 26 Jan 2022 13:56:30 GMT]]>@homoran sagte: in den Objekten unter der Spalte Funktionen nach den Aufzählungen filtern kann.

Nur nach den Funktionen. Aufzählungen als Oberbegriff enthält auch noch Räume und ggf. Favoriten, ...

]]>https://forum.iobroker.net/post/749571https://forum.iobroker.net/post/749571Wed, 26 Jan 2022 13:56:30 GMT<![CDATA[Reply to Grundidee der Themenausrichtung der Doku on Wed, 26 Jan 2022 13:58:16 GMT]]>@homoran sagte: mit JSON-Strukturen auskennt

Habe 5 PRs erstellt inkl. content.json. Die russische und chinesische Übersetzung für "enums" muss noch korrigiert werden. Bitte mergen. Ich hoffe, dass es so funktioniert.

]]>https://forum.iobroker.net/post/749570https://forum.iobroker.net/post/749570Wed, 26 Jan 2022 13:58:16 GMT<![CDATA[Reply to Grundidee der Themenausrichtung der Doku on Wed, 26 Jan 2022 13:54:05 GMT]]>@paul53 sagte:

Dann sollte man die Rubrik auch so bezeichnen (en: enums, de: Aufzählungen)

Korrigiere mich bitte wenn ich falsch liege.
Ich dachte immer, dass man in den Objekten unter der Spalte Funktionen nach den Aufzählungen filtern kann.

Wenn das stimmt sollte IMHO auch diese Spalte in den Objekten umbenannt werden

]]>https://forum.iobroker.net/post/749569https://forum.iobroker.net/post/749569Wed, 26 Jan 2022 13:54:05 GMT<![CDATA[Reply to Grundidee der Themenausrichtung der Doku on Wed, 26 Jan 2022 13:45:12 GMT]]>@chaot sagte in Grundidee der Themenausrichtung der Doku:

Das Problem ist, das ich nicht über die Forenstruktur einsteige sondern die Themen in der "Aktuell" Ansicht angezeigt bekomme. Da bemerke ich die Unterstruktur nur dann wenn ich explizit darauf achte.

das geht mir genau so

@chaot sagte in Grundidee der Themenausrichtung der Doku:

das du nichts falsch gemacht hast.

puuuuh 😰

]]>https://forum.iobroker.net/post/749563https://forum.iobroker.net/post/749563Wed, 26 Jan 2022 13:45:12 GMT