Dokumentation für Module/Instanzen

Hallo zusammen

Aus verschiedenen Gründen versuche ich ja auf Fremdmodule weitestgehend zu verzichten. Trotzdem probiere ich auch gerne mal was aus. Wie das so ist wird halt auch nicht immer danach aufgeräumt.
Heute habe ich daher mal IPS Großputz gemacht und jede Menge ungenutztes Zeug entsorgt.

Beim duchsehen bei den Modulen fällt mir da auf das aus den konfigurationsseiten oft kaum hervorgeht was das Ding eigentlich tut oder was da die diversen Eingebefelder eigentlich sollen.
Ich mein ich will jetzt nicht meckern, aber intuitiv ist das nicht. Wenn man schon sowas macht, dann sollte es doch auch ohne im Forum rumsuchen zu müsse halbwegs selbsterklärend bedienbar sein.

Die Schelte geht auch an IPS selbst. Auch einige native IPS Module, bzw. Kern Instanzen gehen hier mit eher schlechtem Vorbild voran. Man sitzt vor einem weißen Bildschirm, 2-3 Eingabefelder, und hat Fragezeichen in den Augen. Dabei wäre doch genug Platz Eingabefelder zu benennen und ein wenig erleuternden Text hinzuzufügen. Oder zumindest ein Link auf die Doku im Web.

Ein weitgehend positives Beispiel gibt es auch, das Patami Framework. So, - oder noch - besser sollten die Konfigurationsseiten sein.

greets
bb

Da stimme ich Dir ja vollkommen zu, nur fehlt da oft die Rückmeldung des Nutzers. Ich denke wenn konkret gesagt wo es hängt kann die Dokumentation bzw. das Konfigurationsformular auch angepasst werden. Ansonsten kann man ja nur raten wo etwas unklar ist.

Hi bb,
den Schuh zieh ich mir direkt an.:smiley:
Mir geht es auch oft so.
Aber aus Zeitmangel baut mal schnell was, und Doku bleibt auf der Strecke.
Ich hoffe mal, dass ich das in Zukunft besser mache, für meine Dinge.:confused:

Wir haben so etwas ähnliches genau gestern auch besprochen und wir wollen für Module anbieten, dass eine URL zur Online Hilfe angegeben werden kann, welche direkt in der Konsole dann schnell angeklickt werden kann.

paresy

Top!
Das hatte ich auch schon versucht einzubauen, allerdings gibt es so ein Spezial Label aktuell scheinbar nicht :wink:
Michael

Buttons dessen Aktion mit http/https anfängt, öffnet einen Browser (Button — IP-Symcon :: Automatisierungssoftware)

paresy

Ne das ist doof.
Besser ein Label (da gibt es doch schon einige Spezielle in der Console bei den onBoard Instanzen :wink: ).
Das kann man direkt oberhalb eines anderen Elementes platzieren und im Action-Bereich macht das auch wenig Sinn mit dem Button.
Ist da ja Test-Center und nicht Hilfe-Center mit x Buttons welche Links beinhalten.
Michael

Es sollte auch ein aussagekräftiger Name in der Konsole Modul-Control-Instanz erkennbar sein.
Leider gibt es immer noch einige Module, die mit IPS-Modules oder Symcon-Module benannt sind. Ist nur eine Kleinigkeit, trägt aber zur Klarheit bei.
Beispiel: Statt „IPS-Module“ „IPS-1-Wire“ oder „IPS-ESERA“

Hallo,

@audi2010: Da bin ich absolut Deiner Meinung. So wie es aktuell ist, ist das Löschen eines Moduls ein Glücksspiel, weil man nicht teilweise erkennen kann, was sich, z.B. hinter „HansDamps_Module“, tatsächlich verbirgt.

Gruß Proxima