Vorschlag: Tipp der Woche & FAQ (Vorschläge erbeten!)

Begonnen von Beta-User, 16 März 2018, 07:39:06

Vorheriges Thema - Nächstes Thema

Beta-User

Hallo zusammen.

(Wie immer bei den Themen zum Wiki: das folgende ist subjektiv!)

Im Wiki existiert derzeit eine Seite mit FAQ, die aber im Moment nicht unbedingt das enthält, was Neueinsteiger davon erwarten würden - es ist eine automatisierte Sammlung mit Seiten, die im Wiki mit der Kategorie FAQ gelabelt wurden. Aktualität der Themen: eher dürftig...

Dann existiert eine Seite Tipp der Woche, die viele häufige Problemlagen (und Fragen) usw. beschreibt bzw. behandelt, von einer "wöchentlichen" Aktualisierung aber weit entfernt ist...

Vorschlag: Seite "Tipp..." auflösen, die darin behandelten Fragen (so noch aktuell) in die FAQ-Seite integrieren.

Weitere Themen für ein neues FAQ:
- Auswahl OS (Debian-Linux als Empfehlung, Hinweise auf Virtualisierungen und Docker (?), siehe Beitrag hier)
- Auswahl Hardware (Perl-fähig, Pi als Referenzplattform mit warnenden Hinweisen zum Thema SD-Karte und GPIO-Nutzung, Stand zum Thema Fritzbox etc.)
- Nutzung des Forums+Suche (Verweise auf entsprechende Threads/Beiträge hier)
- Sicherheitsfragen? (gehört m.E. eher in den Bereich "Planung")

.... (Vorschläge erbeten!)

Meinungen dazu?

Gruß, Beta-User
Server: HP-elitedesk@Debian 12, aktuelles FHEM@ConfigDB | CUL_HM (VCCU) | MQTT2: MiLight@ESP-GW, BT@OpenMQTTGw | MySensors: seriell, v.a. 2.3.1@RS485 | ZWave | ZigBee@deCONZ | SIGNALduino | MapleCUN | RHASSPY
svn: u.a MySensors, Weekday-&RandomTimer, Twilight,  div. attrTemplate-files

krikan

Zitat
Dann existiert eine Seite Tipp der Woche, die viele häufige Problemlagen (und Fragen) usw. beschreibt bzw. behandelt, von einer "wöchentlichen" Aktualisierung aber weit entfernt ist...

Vorschlag: Seite "Tipp..." auflösen, die darin behandelten Fragen (so noch aktuell) in die FAQ-Seite integrieren.
Wir haben dazu bereits im Wiki vor langer Zeit mal diskutiert https://wiki.fhem.de/wiki/Diskussion:Trick_der_Woche ;sind aber zu keinem wirklichen Ergebnis gekommen.
Schwierigkeit, die ich bei einem Auflösen der Seite sehe: Viele der Tricks sind immer noch aktuell/wichtig/gut und von vielen Stellen verlinkt. Gefahr von toten Links und kaum zu pflegenden Linkketten ist groß.
Lösungsansätze sind aber willkommen.

Gruß, Christian


Beta-User

OK, das mit den potentiell toten Links ist ein Thema, und dass (mind.) das meiste echt super ist, steht auch außer Zweifel.
Mich hat vor allem der Titel gestört, der ist irreführend.

Folgende Gedanken dazu:
- Den heutigen Artikel mit einem Eingangshinweis versehen, dass dieser (nur noch) dazu dient, tote Links zu vermeiden.

- Die Inhalte dann jeweils dahin packen, wo es Sinn macht. Ein Teil gehört in die Linkliste "Wie kann ich...", wobei ich mir die Frage stelle, warum das, was auf der Seite steht, nicht den "Kopf" der Kategorie "HOWTOS" sein könnte/sollte. Ergänzend zu dieser Kategorienseite: Dahin sollte man m.E. leichter finden. Im Moment muß man eine Seite geklickt haben, um dann unten über den Kategorienlink endlich dorthin zu finden...  (Die alte Seite kann man dann ja wieder dahin weiterleiten)
Auf der Ursprungsseite darf dann gerne ein Link stehen, wo es jetzt zu finden ist - damit hätten wir einen Überblick, was noch offen ist und neue Links (von woanders her) könnten einfacher gesetzt werden.

- "Tipp der Woche" dann von der Hauptseite runter, sobald das einigermaßen durch ist.
Server: HP-elitedesk@Debian 12, aktuelles FHEM@ConfigDB | CUL_HM (VCCU) | MQTT2: MiLight@ESP-GW, BT@OpenMQTTGw | MySensors: seriell, v.a. 2.3.1@RS485 | ZWave | ZigBee@deCONZ | SIGNALduino | MapleCUN | RHASSPY
svn: u.a MySensors, Weekday-&RandomTimer, Twilight,  div. attrTemplate-files

drhirn

Naja, wenn man die Seite nicht löscht, sondern einfach umleitet gibt's ja keine toten Links.

Morgennebel

Zitat von: Beta-User am 16 März 2018, 07:39:06
Im Wiki existiert derzeit eine Seite mit FAQ, die aber im Moment nicht unbedingt das enthält, was Neueinsteiger davon erwarten würden - es ist eine automatisierte Sammlung mit Seiten, die im Wiki mit der Kategorie FAQ gelabelt wurden. Aktualität der Themen: eher dürftig...
Dann existiert eine Seite Tipp der Woche, die viele häufige Problemlagen (und Fragen) usw. beschreibt bzw. behandelt, von einer "wöchentlichen" Aktualisierung aber weit entfernt ist...

Ich würde gerne die Diskussion nutzen, und eine generelle Neustrukturierung des Einsteigerbereiches im Wiki vorzuschlagen. Wir haben:


  • Wie fange ich an
  • Ideen und Lösungen
  • FAQ
  • Tip der Woche
  • Wie kann ich....?
  • usw.

Mir fehlt bei all diesen Kategorien eine klare Struktur, was in welcher Reihenfolge zu lesen, zu beachten und zu machen ist. Manches wendet sich an Einsteiger, manches an Fortgeschrittene, manches eher als Kurzreferenz als Profis.
Die Profis, die hier im Forum die Hauptantwort der Antworten machen, können sich kaum noch in die Probleme der Anfänger eindenken (kein Vorwurf, wenn man etwas nur mehrere Jahre gemacht hat, erscheint es irgendwann als selbstverständlich).

Ich würde daher drei Bereiche vorschlagen:


  • Das Was
  • Das Wie
  • Die Wie genau

WAS ist der Marketing-Pitch, die Idee, der Überblick über die Möglichkeiten, Erfolge, die Verlockung des Paradises und beantwortet die Frage, was mit FHEM gemacht werden kann. Ein Überblick, welche Hardware-Plattform (Homematic, zWave, ZigBee usw.) für welchen Einsatzzweck sinnvoll ist.

WIE ist eine strukturierter schrittweise Kategorie (wie das TCP-4-Schichtenmodel), beginnend mit a) Rechnerinstallation, b) FHEM-Installation und Updates, c) Konfiguration der ausgewählten IOs und d) erste einfache Anwendungen

WIE GENAU wäre der Platz für FAQs, für Kurzanwendungen, für Erweiterungen, für Commandref-Hinweise, Code-Schnipsel, Tip des Tages usw.

Natürlich braucht es passende Titel für die Bereiche und Unterbereiche... Artikel zu verschieben, wäre aber recht einfach...

Ciao, -MN
Einziger Spender an FHEM e.V. mit Dauerauftrag seit >= 24 Monaten

FHEM: MacMini/ESXi, 2-3 FHEM Instanzen produktiv
In-Use: STELLMOTOR, VALVES, PWM-PWMR, Xiaomi, Allergy, Proplanta, UWZ, MQTT,  Homematic, Luftsensor.info, ESP8266, ESERA

Beta-User

...man sollte einen Workshop dazu veranstalten, aber bekommen wir alle für 2 Wochen frei :o ...
Vermutlich besteht Einigkeit in der Feststellung, dass es eigentlich zu viele Punkt auf der Einstiegsseite gibt und die Nutzerführung mind. teilweise irreführend.
Jedenfalls sind die Punkte
im Abschnitt "wie fange ich an" Links zu Themen und Bereichen, die schnell vertieftes Wissen und Verständnis voraussetzen. Andererseits handelt es sich bei diesen drei Seiten um automatisch erstellte. Eine Neustrukturierung würde also erfordern, dass man die dorthin zeigenden Artikel anfaßt - das wäre m.E. ein Kampf gegen Windmühlen.
(Ohne die Wiki-Funktionalität vollständig durschaut zu haben:) Es müßte aber möglich sein, den automatisiert erstellten Teil und den Kopfbereich gedanklich zu trennen.
Am Beispiel Glossar: in einen "Einführungsteil" mit einer Auswahl von zentralen FHEM-Begrifflichkeiten (z.B. Attribut, Device, Ereignis usw.) und einen mit dem Einleitungssatz versehenen vollständigen (soweit man das behaupten kann...).
Dann fehlt m.E. noch ein "zentraler" Artikel über die Funktion von fhem.pl im Allgemeinen. Wir hatten in letzter Zeit einige Neueinsteiger, die der Ansicht waren, sie müßten für ihre Devices eigene Schleifen basteln, in denen dann zyklisch alle möglichen Bedingungen zu checken wären.

Das könnte auf die Schnelle in die Richtung gehen: "fhem.pl stellt einen zentralen Programmablauf zur Verfügung, um Ereignisse aus der Außenwelt <link zu Event> auszuwerten. Weiter überwacht fhem.pl Timer, die vom Nutzer oder den von ihm verwendeten Module gesetzt werden und führt die damit festgelegten Aufgaben aus.
FHEM ist als Single-Threaded-Programm ausgelegt, alle Aufgaben werden also der Reihe nach _ohne_ Parallelverarbeitung ausgeführt. (=> blockierende Anweisungen vermeiden, keine Echtzeiterwartung vom Anwender). ..."
Evtl. was zu Modulen - insbesondere dass durch deren Verwendung in der Regel die Event-Verarbeitung festgelegt wird bzw. was überhaupt als "Event" gemeldet wird und dass diese häufig intern Timer definieren.
Server: HP-elitedesk@Debian 12, aktuelles FHEM@ConfigDB | CUL_HM (VCCU) | MQTT2: MiLight@ESP-GW, BT@OpenMQTTGw | MySensors: seriell, v.a. 2.3.1@RS485 | ZWave | ZigBee@deCONZ | SIGNALduino | MapleCUN | RHASSPY
svn: u.a MySensors, Weekday-&RandomTimer, Twilight,  div. attrTemplate-files

Morgennebel

Zitat von: Beta-User am 18 Juni 2018, 11:22:54
Andererseits handelt es sich bei diesen drei Seiten um automatisch erstellte. Eine Neustrukturierung würde also erfordern, dass man die dorthin zeigenden Artikel anfaßt - das wäre m.E. ein Kampf gegen Windmühlen. (Ohne die Wiki-Funktionalität vollständig durschaut zu haben:)

Das ist recht einfach. Die ganze Strukturierung wird nur über Kategorien erledigt:


  • Code_Snippets
  • HOWTOS
  • FHEM
  • Examples

Bringen wir Ordnung in die Kategorieren (wie vorgeschlagen), bringen wir Ordnung und Struktur in die Artikel. Es ist eine Fleißarbeit, alle Artikel manuell neu zu kategoriesieren....

Die Kategorien lassen sich dann in der URL mit Kategorie: verlinken, z.B. https://wiki.fhem.de/wiki/Kategorie:Examples

Ich plädiere erstmal eine Struktur zu vereinbaren, bevor wir Details ändern. Sonst müssen wir die Details evtl. mehrfach ändern...

Ciao, -MN
Einziger Spender an FHEM e.V. mit Dauerauftrag seit >= 24 Monaten

FHEM: MacMini/ESXi, 2-3 FHEM Instanzen produktiv
In-Use: STELLMOTOR, VALVES, PWM-PWMR, Xiaomi, Allergy, Proplanta, UWZ, MQTT,  Homematic, Luftsensor.info, ESP8266, ESERA