Autor Thema: Link zur Bedienungsanleitung eines Moduls  (Gelesen 1024 mal)

Offline TomLee

  • Tester
  • Hero Member
  • ****
  • Beiträge: 4634
  • ... wer sät, der erntet ...
Link zur Bedienungsanleitung eines Moduls
« am: 22 Oktober 2022, 22:35:06 »
Darf ich mal fragen warum der "Standort" des Link zur commandref grundsätzlich so gewählt wurde das er in FHEMWEB, in der Geräteansicht, an letzter Stelle (ganz unten rechts) angezeigt wird ?

Die commandref ist doch das erste wo man nachzulesen hat, der Link sollte eigentlich an erster Stelle ganz oben links noch über DeviceOverview, Change wizard und über was weiß ich was es noch alles gibt/übersehe stehen/seinen Platz haben -> und so mMn. manche Frage erübrigen.

Und wenn da je nach gewählter Sprache in global statt in EN Device specific help, bei DE "Bedienungsanleitung" oder ähnlich stehen würde, stirbt doch auch keiner daran.
« Letzte Änderung: 22 Oktober 2022, 22:37:34 von TomLee »

Offline KölnSolar

  • Developer
  • Hero Member
  • ****
  • Beiträge: 5787
Antw:Link zur Bedienungsanleitung eines Moduls
« Antwort #1 am: 23 Oktober 2022, 09:50:08 »
Zitat
Die commandref ist doch das erste wo man nachzulesen hat, der Link sollte eigentlich an erster Stelle ganz oben links
Nur für den "Entwickler". Und der sollte wissen wo der Link ist. Der gewöhnliche User sollte noch nicht einmal wissen, dass es eine commandref gibt.  ;)
RPi3/2 buster/stretch-SamsungAV_E/N-RFXTRX-IT-RSL-NC5462-Oregon-CUL433-GT-TMBBQ-01e-CUL868-FS20-EMGZ-1W(GPIO)-DS18B20-CO2-USBRS232-USBRS422-Betty_Boop-EchoDot-OBIS(Easymeter-Q3/EMH-KW8)-PCA301(S'duino)-Deebot(mqtt2)-zigbee2mqtt

Offline TomLee

  • Tester
  • Hero Member
  • ****
  • Beiträge: 4634
  • ... wer sät, der erntet ...
Antw:Link zur Bedienungsanleitung eines Moduls
« Antwort #2 am: 23 Oktober 2022, 11:04:25 »
Zitat
Der gewöhnliche User sollte noch nicht einmal wissen, dass es eine commandref gibt.

Achso, cool. Ging an mir vorbei die letzten Jahre. Der einfachste Weg um etwas in FHEM zu automatisieren erscheint mir dann über eine Spracherkennung einfach meine Automatisierungwünsche zu äussern und die werden dann wie von Zauberhand definiert.

Ich schau mal im Wiki wie ich Alexa installiert bekomme um ihr meine einfache Beispielwunschautomation mitzuteilen ->

Voraussetzung ist eine TelegramBot-Definition dazu, das teil ich ihr einfach mal mit, sie soll das für mich machen, danach hätte ich gerne in Zukunft jeden Anrufername per Telegram-Nachricht, aber nicht zw. bli und bla Uhr.

Wenn das nicht klappt welchen Rat hast du für mich Newbie ?

Offline rudolfkoenig

  • Administrator
  • Hero Member
  • *****
  • Beiträge: 26059
Antw:Link zur Bedienungsanleitung eines Moduls
« Antwort #3 am: 23 Oktober 2022, 12:00:38 »
Zitat
Darf ich mal fragen warum der "Standort" des Link zur commandref grundsätzlich so gewählt wurde das er in FHEMWEB, in der Geräteansicht, an letzter Stelle (ganz unten rechts) angezeigt wird ?
Ich glaube fuer eine Frage wurde hier noch keiner exkommuniziert, insofern ja, Du darfst fragen.

Der Link auf die Hilfe ist unten, weil da eine Reihe von Links gibt, diese Reihe hat mW mit "Select icon" angefangen.
Ob es klug ist, diese unten zu platzieren, ist fragwuerdig, genauso ist eine Position oben.

Zitat
Und wenn da je nach gewählter Sprache in global statt in EN Device specific help, bei DE "Bedienungsanleitung" oder ähnlich stehen würde, stirbt doch auch keiner daran.
Womoeglich doch, und ich waere vorne dabei.

FHEM ist (aus heutiger Sicht leider) nicht mehrsprachig gestartet, sowas nachtraeglich einzubauen ist aufwendig.
Einzelne Begriffe auf deutsch wuerden mich daran erinnern, dass es Pfusch ist, und ich bin z.Zt. noch nicht entschlossen, die Mehrsprachigkeit komplett zu implementieren.
Es kommt dazu, dass bei einem Konstrukt wie FHEM, wo die Programmierung im Vordergrund steht, eine Grenze zu ziehen schwierig ist, ich erinnere nur an Excel mit deutschen Funktionsnamen.

Offline TomLee

  • Tester
  • Hero Member
  • ****
  • Beiträge: 4634
  • ... wer sät, der erntet ...
Antw:Link zur Bedienungsanleitung eines Moduls
« Antwort #4 am: 23 Oktober 2022, 15:55:31 »
Verstehe ...



Dann anders, bzgl.:

Zitat
Ob es klug ist, diese unten zu platzieren, ist fragwuerdig, genauso ist eine Position oben.

Wenn man den letzten Bereich (den mit den Links) weiter oben positionieren würde (vlt. auch mit dem Pin versehen), über den Readings, den settern, ganz oben oder sonstwo (darüber kann man ja reden), irgendwo an einer präsenteren Position halt wie "ganz unten" und den Link zur Dokumentation umbenannt von Device specific help zu Documentation (Modulname.pm) links statt rechts positionieren, wären das Punkte über die man diskutieren kann ?

Ich frag ja nicht ohne Grund, wenn man hier so mitliest, stell ich für mich halt fest das es (jahrelange) User (mich selbst nehme ich davon gar nicht aus, da hat es auch lange gedauert) gibt, die man nach so langer Zeit immer noch erstmal auf die Hilfe hinweisen muss, meiner Meinung nach liegt die Ursache halt daran das der Link zur Doku einfach "zu weit vom User entfernt" positioniert ist, der sollte einen anschreien wenn man in der Detailansicht ist und wie gesagt einfach nur Documentation (Modulname.pm) statt Device specific help (auch wenn das völlig korrekt ist) fänd ich für einen Newbie einfach "greifbarer".

Offline rudolfkoenig

  • Administrator
  • Hero Member
  • *****
  • Beiträge: 26059
Antw:Link zur Bedienungsanleitung eines Moduls
« Antwort #5 am: 24 Oktober 2022, 16:43:28 »
Diese Zeile nach oben zu schieben ist problematisch, unter anderem weil die Hilfe/Raw definition direkt darunter angezeigt wird.
Den Link nach links zu schieben: habe kein Problem damit.
"Device specific help" in "Documentation for <modulname>" umbenennen: damit habe ich auch kein Problem, obwohl es laenger ist, und 5 Module auf "Device specific help" referenzieren.

Ich kann die beiden letzten Aenderungen durchfuehren, falls mindestens zwei weitere Personen sich dafuer aussprechen.

Ich glaube nicht daran, dass Leute eher Doku lesen, wenn man die Doku aufdraengt.
Entweder will man Doku lesen, und dann findet man sie, oder man ist ungeduldig, probiert rum, und will hoechstens die Antwort auf die aktuelle Frage lesen.
Zustimmung Zustimmung x 1 Liste anzeigen

Offline betateilchen

  • Developer
  • Hero Member
  • ****
  • Beiträge: 18888
Antw:Link zur Bedienungsanleitung eines Moduls
« Antwort #6 am: 26 Oktober 2022, 17:44:25 »
noch jemand ohne Popcorn?
-----------------------
Mach es möglichst simpel und mach es richtig,
dann wird es auch funktionieren.
-----------------------
Lesen gefährdet die Unwissenheit!
Gefällt mir Gefällt mir x 1 Liste anzeigen

Offline betateilchen

  • Developer
  • Hero Member
  • ****
  • Beiträge: 18888
Antw:Link zur Bedienungsanleitung eines Moduls
« Antwort #7 am: 26 Oktober 2022, 17:45:48 »
Ich kann die beiden letzten Aenderungen durchfuehren, falls mindestens zwei weitere Personen sich dafuer aussprechen.

Dagegen.
-----------------------
Mach es möglichst simpel und mach es richtig,
dann wird es auch funktionieren.
-----------------------
Lesen gefährdet die Unwissenheit!

Offline TomLee

  • Tester
  • Hero Member
  • ****
  • Beiträge: 4634
  • ... wer sät, der erntet ...
Antw:Link zur Bedienungsanleitung eines Moduls
« Antwort #8 am: 26 Oktober 2022, 18:09:15 »
Bin dafür das sich jeder soviel Popcorn nimmt wie er meint zu brauchen, wenn hier weiterhin zusammen so diskutiert wird wie die letzten Tage, was viel zu selten (öffentlich noch nie ?) bisher vorkam,  hab ich mehr erreicht wie ich eigentlich wollte.

Offline TomLee

  • Tester
  • Hero Member
  • ****
  • Beiträge: 4634
  • ... wer sät, der erntet ...
Antw:Link zur Bedienungsanleitung eines Moduls
« Antwort #9 am: 26 Oktober 2022, 18:37:46 »
Hab noch was vergessen, es muss sich auch keiner zurückhalten mit dem Popcorn, mit Betateilchen im Hintergrund wird der Maisvorrat dazu, in FHEM, vmtl. nie ausgehen.