Autor Thema: 99 myUtils anlegen  (Gelesen 8880 mal)

Offline Beta-User

  • Developer
  • Hero Member
  • ****
  • Beiträge: 16372
Antw:99 myUtils anlegen
« Antwort #30 am: 23 Mai 2019, 13:02:41 »
Im Nachgang zu dem hier hätte ich jetzt folgenden Vorschlag für einen Abschnitt im QuickStart (dort nach den "Modulen für die erste Zeit"):

Zitat
FHEM ist ein Perl Server...

Die meisten FHEM-Nutzer werden früher oder später daran erinnert, dass FHEM in Perl programmiert ist. Auch wenn es in vielen Fällen nicht zwingend erforderlich ist, diese Programmiersprache zu erlernen, ist es für ein vertieftes Verständnis der Funktionsweise Ihrer Hausautomatisierung hilfreich, wenn Sie sich auch mit den Grundlagen zu Perl sowie der häufig vorkommenden [[Regulärer Ausdruck|regex-Ausdrücken]] vertraut machen. Manche Problemstellungen lassen sich nach wie vor am effektivsten unmittelbar mit diesen Werkzeugen lösen.
Einen ersten Einblick in diese Themen finden Sie in den (cref-link=>) FHEM Befehls-Typen, (cref-link=>) PERL Besonderheiten und dem Artikel zu [[99 myUtils anlegen]]. [[Kategorie:Development|In diesen Artikeln]] sind weitere Informationen für  Fortgeschrittene und Experten zu finden.

Damit soll es dann von meiner Seite her erst mal sein Bewenden haben, wenn es genügend positive Rückmeldung dazu gibt. bau ich es ein, ansonsten eben nicht :P . (Entsprechendes gilt für Verbesserungsvorschläge)
Server: HP-T620@Debian 10, 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:MySensors, Weekday-&RandomTimer, Twilight,  AttrTemplate {u.a. mqtt2, mysensors, zwave}

Offline Beta-User

  • Developer
  • Hero Member
  • ****
  • Beiträge: 16372
Antw:99 myUtils anlegen
« Antwort #31 am: 24 Mai 2019, 16:42:03 »
Grade habe ich noch einen Blick in https://wiki.fhem.de/wiki/Guidelines_zur_Dokumentation geworfen. An sich wäre der vorhandene Text dort ganz gut aufgehoben, man müßte/könnte ggf. dann nur zwischen "allg." und "Modul" unterscheiden; dann könnte man recht "unverfänglich" dahin verlinken?
Hab' mir jetzt mal das Doku-Thema nochmal angesehen. Soweit erkennbar haben wir:
- den Abschnitt in 99 myUtils anlegen
- das Hello-Beispiel in https://wiki.fhem.de/wiki/DevelopmentModuleIntro#.22Hello_World.22_Beispiel, das aber dann keine weiteren Erläuterungen enthält und die bereits oben genannten
- https://wiki.fhem.de/wiki/Guidelines_zur_Dokumentation.
Bei näherer Betrachtung kann ich keine wirkliche Doppelung erkennen, das einzige Manko ist das, dass es etwas verteilt ist.

An den "Guidelines" würde ich nichts ändern, Adressat sind klar Developer, und auch die dortige Botschaft sollte man nicht durch Ergänzung mit eher technischen Hinweisen verwässern.

Ergo würde ich es im wesentlichen lassen, wie es ist, der Doku-Abschnitt ist in "99" auch nicht so ausgeprägt lang.

Bleibt m.E. zur Überarbeitung das Beispiel.

Andere Ideen zu dem Punkt?
Server: HP-T620@Debian 10, 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:MySensors, Weekday-&RandomTimer, Twilight,  AttrTemplate {u.a. mqtt2, mysensors, zwave}

Offline krikan

  • Developer
  • Hero Member
  • ****
  • Beiträge: 7028
Antw:99 myUtils anlegen
« Antwort #32 am: 27 Mai 2019, 10:11:25 »
Im Nachgang zu dem hier hätte ich jetzt folgenden Vorschlag für einen Abschnitt im QuickStart (dort nach den "Modulen für die erste Zeit"):

Damit soll es dann von meiner Seite her erst mal sein Bewenden haben, wenn es genügend positive Rückmeldung dazu gibt.
positive Rückmeldung.  :)
Mir ist der Hinweis auf Perl-Grundkenntnisse sehr wichtig.

Letztlich laufen wir aber "Gefahr" Quick-Start irgendwann zu verlassen und in Einsteigerdoku überzugehen. Das finde ich aber nicht tragisch.

Positive Rückmeldung gilt auch für myUtils.

An den "Guidelines" würde ich nichts ändern, Adressat sind klar Developer, und auch die dortige Botschaft sollte man nicht durch Ergänzung mit eher technischen Hinweisen verwässern.

Ergo würde ich es im wesentlichen lassen, wie es ist, der Doku-Abschnitt ist in "99" auch nicht so ausgeprägt lang.

Bleibt m.E. zur Überarbeitung das Beispiel.

Andere Ideen zu dem Punkt?

Keine Ideen. Mach ruhig.

Gruß, Christian

Offline Beta-User

  • Developer
  • Hero Member
  • ****
  • Beiträge: 16372
Antw:99 myUtils anlegen
« Antwort #33 am: 27 Mai 2019, 13:54:25 »
positive Rückmeldung.  :)
Thx, das reicht mir schon :) . Ist drin, und auch eine vorläufige englische Fassung gibt's seit eben; die hat nur leider noch eine ganze Anzahl von deutschsprachigen Links, das überarbeite ich dann ggf. noch.

Zitat
Mir ist der Hinweis auf Perl-Grundkenntnisse sehr wichtig.

Letztlich laufen wir aber "Gefahr" Quick-Start irgendwann zu verlassen und in Einsteigerdoku überzugehen. Das finde ich aber nicht tragisch.

Positive Rückmeldung gilt auch für myUtils.
Keine Ideen. Mach ruhig.

Gruß, Christian
Das mit den Perl-Grundkenntnissen geht (mMn.) nicht nur mir auch so.

Die "Gefahr" mag da sein, aber als "Einsteigerdoku" kann es allenfalls für User angesehen werden, die mit dem (mAn) gehobenen Niveau klarkommen :) . Aber es kann und soll ruhig eine solide Startbasis sein, wenn man auch als erfahrener Nutzer "mal eben was sucht"; daher finde ich die vielen Fußnoten da auch völlig ok :P .

An dem 99-er Artikel mache ich bei Gelegenheit weiter, im Moment fehlt noch Rückmeldung von meinen "Testusern" für das Beispielchen :) . Insbesondere der TE wollte mehr Zeit als ein WE haben.
Server: HP-T620@Debian 10, 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:MySensors, Weekday-&RandomTimer, Twilight,  AttrTemplate {u.a. mqtt2, mysensors, zwave}
Gefällt mir Gefällt mir x 1 Liste anzeigen

 

decade-submarginal