Überarbeitung der Dokumentation

Wir haben uns endlich dazu entschlossen zum neuen Jahr ein überarbeitete Dokumentation zu erstellen. Alte Artikel sollen überarbeitet und fehlende ganz neu erstellt werden. Damit wir auch nichts übersehen oder die Wichtigkeit anders einschätzen als ihr es tut hat in diesem Thread jeder die Möglichkeit uns Seiten vorzuschlagen oder auch detaillierte Beschreibungen zu wünschen.

Gruß,
gucky

Abend gucky! Gutes Vorhaben von euch!!! :slight_smile:

Mir würde es spontan ausreichen, wenn alte und nicht mehr gültige Befehle entfernt werden würden :slight_smile: Glaub aber das war im Wiki, wo ich aufs Glatteis geführt wurde?!

Ansonsten finde ich diesen Aufbau (wie hier: http://www.ip-symcon.de/service/dokumentation/befehlsreferenz/variablenverwaltung/ips-getvariableidbyname/) schon sehr übersichtlich und gelungen.

Was aber für das Forum entlastend wäre, wenn ihr die Rubrik „wie kann ich…“ weiter ausbauen würdet :slight_smile: Oder Beispiele wie man mit WWW Reader und Text Parser sich aus Webseiten etwas rausholen kann… Oder sowas halt :slight_smile:

Grüße,
Chris

„Alte und nicht mehr gültige Befehle“ bitte eher deutlich als solche kennzeichnen, es wird noch genug Installationen geben, wo das verwendet wird. :wink:

Gruß
Bruno

Sehr hilfreich wäre auch die Angabe, ab welcher IPS-Version der Befehl verfügbar ist bzw. rausgenommen wurde. Sehr schön gelöst ist das z.B. in der HighCharts-Doku (um mal ein Beispiel zu nennen).

Hmmm, an das was Bruno sagte hab ich gar nicht gedacht :smiley: Hat ja nicht jeder immer die neusten Versionen installiert…
…also dann so wie Bruno und RS es geschrieben haben :slight_smile:

Wir bieten das ja eigentlich schon an: z.B. zeigt http://www.ip-symcon.de/service/dokumentation/befehlsreferenz/ereignisverwaltung/ips-seteventschedulegrouppoint/ , dass IP-Symcon 3.2 benötigt wird.

Welche die weggefallen sind… hmm… So viele sind es eigentlich nicht.

paresy

Dann vielleicht…
Welche in Zukunft wegfallen werden.
Das Changelog wird ja leider kaum gelesen. Und dann heisst es wieder zur 4.0… wieso geht das nicht.
Außerdem würde ich eine sep. Kategorie vorschlagen wo es um die Einbindung der Hardware geht. Das ist jetzt z.Z. innerhalb der Modulreferenz ‚versteckt‘.
Dort könnte man auch die häufigsten Fallstricke/Einrichtungs/Verständnis Fehler und Probleme mit aufnehmen.

Michael

… und dazu fällt mir gleich noch was ein:

  1. auch Befehle, die in der aktuellen version nicht mehr vorhanden sind, sollten in der Doku auftauchen (mit Angabe, von welcher bis welcher Verrsion aktiv). Grund: es gibt ja noch immer Sparfüchse, die mit 3 Jahre alten Versionen unterwegs sind. Neueinsteiger hätten so eine Chance, das Gebrabbel im Forum nachzuvollziehen.

  2. Jeder im Forum auftauchende Systembefehl (Freitext und Code-Tags) wird austomatisch mit der dazugehörigen Doku-Seite verlinkt. Ich denke, dass auch das die ewigen, sich 1000mal wiederholenden Nachfragen reduziert und insbesondere im Kontext zu Punkt 1 Verwirrungen vermeidet (insbesondere für Neueinsteiger)

Ich hab grad mal die Befehlsreferenz ein wenig durchgeklickt und konnte spontan auf keiner eine Angabe zu Versionsnummern entdecken…

Und was mir dabei, wie schon so oft, wieder aufgefallen ist >> es ist SOOOO umständlich/schwer etwas in der Befehlsreferenz zu finden! Vielleicht könnte man das irgendwie übersichtlicher gestalten oder verschieden sortierbar machen und eine Suche mit in die Doku einbauen, welche nur Befehle durchsucht oder so etwas in der Richtung!?

Eben wollte ich, auf Grund des Posts von paresy, mal sehen wie das mit WWW und WWWReader in der Doku steht…denkste ich find das? Nein :smiley: Also das irgendwie ändern, wie im vorigen Absatz von mir beschrieben, wäre toll :slight_smile:

Und die Idee mit den alten Befehlen drinne lassen, mit Hinweis auf „gültig von Version X bis Y“, finde ich auch nicht schlecht. Oft stolpert man über alte Skripte, die an sich super sind, aber manche Befehle wurden abgelöst…sollte im Thread nichts dabei stehen, könnte man sich über die Doku selbst die alten Befehle raussuchen und darin findet man z.B. Links zu neuen Befehlen oder Befehlen die das übernehmen…

Grüße,
Chris

Morgen, das ist ja mal eins sehr lobenswerter Ansatz. Wobei, soweit ich mich erinnere auch nicht der erste.

Also ich finde die Doku zu den Systemvariablen ist auch viel zu gut versteckt. Wird oft benötigt, ist aber nur zu finden wenn man genau weiß wo. Da hatte ich mir schon oft einen Wolf gesucht. (inzwischen finde ichs blind :cool:)
Ebenso sollte insbesondere zu diesem Bereich das ein oder andere Code Beispiel mit drin sein.

In vielen Anfängerposts findet man nämlich Fragen zu Problemstellungen welche mit halbwegsem Verständnis der der Systemvariablen eigentlich unnötig wären. Denke hier wäre ein wenig Prominenz sinnvoll.

Naja, und im eigenen Interesse würde ich mal eine OFFIZIELLE und gepflegte (!!) Liste der unterstützen Hardware vorschlagen. (nicht nur aus System - sondern auch auf Modulebene denn hier scheitere es ja ab und an(Enocean, DS ect…)
Ich weiß es gibt dazu Ansätze im Wiki, aber eigentlich sollte das doch die Aufgabe eines Herstellers sein zu zeigen was sein eigenes Produkt alles kann.

schöne Grüße
Bernhard

Sehe ich auch so - mir fehlt aber seit langem einem gute Idee, wo man diesen Bereich platzieren könnten und wie man diese speziellen Variablen gut erklärt. Für jemanden der es verstanden hat, ist es einfach… Aber für die meisten ist es einfach schwarze Magie…

Naja, und im eigenen Interesse würde ich mal eine OFFIZIELLE und gepflegte (!!) Liste der unterstützen Hardware vorschlagen. (nicht nur aus System - sondern auch auf Modulebene denn hier scheitere es ja ab und an(Enocean, DS ect…)
Ich weiß es gibt dazu Ansätze im Wiki, aber eigentlich sollte das doch die Aufgabe eines Herstellers sein zu zeigen was sein eigenes Produkt alles kann.

Das sehe ich genauso!

paresy

Eben gerade gesehen das hier die Erklärung für Sender = Execute den Befehl IPS_ExecuteScript beschreibt, statt IPS_RunScript.
Und der Link zeigt auf IPS_Execute.
Also etwas durcheinander gewürfelt ?
Systemvariablen — IP-Symcon :: Automatisierungssoftware
Überhaupt finde ich diese Seite etwas schwer Verständlich für Einsteiger.
Die Logik welche Key->Value bei welchem Sender zur Verfügung stehen erschließt sich nicht sofort. Dies mag zu Teil auch am Design bzw. der Gliederung liegen.
Michael

Stimmt das ist auch etwas Unübersichtlich.
Ist auf jedenfall auf meiner ToDo Liste gelandet.
Mal sehen vielleicht hab ich für die Systemvariablen eine Eingebung.

push ;)+ 10 Zeichen

Moin Moin.

Keine Sorge!
Ich hab den Thread hier ziemlich genau im Blick.
Auch schau ich immer mal wieder rein, wenn was neues kommt.
Ich kann aber soviel verraten.
Die Doku ist sozusagen unter meinen Fittichen gelandet und ich kümmer mich momentan Primär um die Überarbeitung, Aktualisierung und Erweiterung.
Wie ihr aber selbst wisst gibt es viele Baustellen und es braucht einfach Zeit.

Dennoch möchte ich euch bitten, wenn euch irgendeine, sei es auch eine fixe, Idee einfällt.
So schreibt sie hier rein. Ich schau mir das an.

Grüße
Pio

Abend allerseits :slight_smile:

Aus gegeben Anlass wollte ich mal eine Art „Best practice“ Bereich vorschlagen. Gibt es, soweit ich weiß, nicht.

Beispiel:
> Wie steuere ich meine Beleuchtung mit HomeMatic (vom Anlegen der Instanzen [wie der Baum aussehen könnte/sollte], über Namensgebung von Variablen, verschiedene Schalt-/Steuermöglichkeiten [Einzelschaltung, Räume, Alle, …], wie man was mit Skripten abfragt/schaltet, bis hin zu wie man das in eine Visualisierung bribgt)
…das halt für die „Hauptsysteme“ (gab es ja mal eine Umfrage) wie z.B. HomeMatic, EIB, …

War wie gesagt nur ein Beispiel und hab sicher 50 Punkte vergessen, war nur so eine laut gedachte und nicht tiefer überlegte Idee/Wunsch :slight_smile: Weil jeder macht so „übliche/einfache“ Sachen meist alleine und nur die „großen/schweren“ Projekte werden im Forum diskutiert.

…hätte man aber so eine Art „best practice“ Übersicht, dann würden mehrere das vmtl. gleich oder ähnlich aufbauen, was den Support erleichtert und so könnte man auch „Fallstricke“ umgehen oder vermeiden, dass man irgendwann merkt „oh, das hätte man ja so und so machen können“ und muss dann alles umbauen.

Wisst ihr wie ich meine? :slight_smile:

Danke und Grüße,
Chris

Hi Pio,
prima, das hört sich gut an. Immer, wenn ich von Euch nichts mehr lese, weiß ich nicht:

[ul]
[li]hammse ignoriert?[/li][li]hammse aufgenommen und grübeln noch?[/li][li]hammse aufgenommen und abgelehnt?[/li][li]hammse nicht mal ignoriert?[/li][/ul]

Muss ja nicht immer gleich ne Zu- oder Absage sein, ein kurzes Ack hilft auch schon mal weiter :wink:
Wenn der konstruktive Dialog sicher gestellt ist, wirkt das mitunter motivierend :smiley:

Moin Moin!

Genau das ist uns auch aufgefallen:
Eine Kombination aus der überarbeiteten Version von:
http://www.ip-symcon.de/service/dokumentation/einfuehrung/schnelleinstieg/
und
http://www.ip-symcon.de/service/dokumentation/vorgehensweisen/

soll da erstmal unterstützen.
Und wird sicherlich noch ausgebaut.

JA! :wink:

Also es wird demnächst hoffentlich schonmal ein kleines Update geben, damit ihr auch sehen und „kritisieren“ könnt :wink:
Ich schreib mit Absicht klein. Im Moment ist es so, dass ich mit nem kleinen Loch angefangen habe und es sich langsam aber sicher zu einer positiven Großbaustelle entwickelt.

Stay tuned!
Pio

Hi Pio!

Na das klingt doch mal richtig gut :slight_smile: Ich hoffe nur, dass es dann auch so ausgebaut wird, wie ich mir das vorstelle :smiley:
…also nicht nur mit den IPS-Sachen, sondern auch z.B. best practice für „so überwachen Sie die Waschmaschine mit HomeMatic (z.B. mit Beispiel-Skript das den Stromverbrauch in eine Variable schreibt, welchen man dann als „Ereignisschwelle“ eintragen kann)“ oder „Flur-Beleuchtung mit HomeMatic von A-Z (Bewegungsmelder, Dimmer, Nachtlicht, kein plan g)“.
Oder irgendwie so Sachen :slight_smile:

Wenn ihr konkrete Vorschläge mal braucht, könnt ihr vlt. ein Thema aufmachen und abstimmen lassen bzw. Vorschläge sammeln lassen „was hat jeder/viele“, „was muss jeder mal einrichten“, …

Danke und Grüße,
Chris

Vlt. könnte man auch sowas in „best practice“ aufnehmen > Alle Links zu einer Variablen finden - Seite 2

…also wie macht man einen sinnvollen Struktur-Aufbau in der IPS-Console. Also Hardware, Skripte, Visualisierung mit Links, … Bräuchte man an sich nur, wie in Michaels Beitrag, ein paar kleine Screenshots mit Beispielen.

MfG,
Chris