Überarbeitung der Dokumentation

Hallo Bayaro,

das klingt schon nach einem schönen Beispiel. Ich denke mit „Best Practice“ meinst du das, was wir unter Vorgehensweisen — IP-Symcon :: Automatisierungssoftware auflisten, oder?

Gruß,
gucky

Hi gucky,

so in der Art wie „Email Benachrichtigung“ vom Umfang. Quasi ein erweitertes „wie kann ich“ und nicht nur auf z.B. das Anlegen einer Kategorie bezogen oder ein Code-Beispiel.

…sondern sowas wie „Stehlampe steuern/bedienen mit IPS und einem Taster“
> HM Instanz für Stehlampe anlegen
> HM Instanz für Taster anlegen
> Kategorie „Skripte“ anlegen und darunter „HomeMatic“
> Skript schreiben mit Inhalt X
> Ereignistrigger auf Variable Y
> ein paar Screenshosts dazu

Oder „so baut mein seinen IPS-Baum mit Kategorieren/Hardware/Skripten/Visualization auf“.

Oder „so bauen Sie sich eine Flur Beleuchtung mit 2 Lampen und 2 Bewegungsmelder, damit Sie Nachts nicht im Dunklen stehen“.

Oder oder oder :smiley:

…es geht mir halt darum, dass möglichst viele einen gleichen Aufbau im IPS haben und nach einem möglichst gleichen Schema an Dinge herangehen von der Umsetzung und vom Aufbau. Weniger unterschiedliche Sachen = leichterer Support = leichterer Einstieg für Neulinge = bessere Übersicht im Allgemeinen = …

Grüße,
Chris

Hallo Bayaro,

wir antworten dann mal mit einem klaren Jein auf deinen Wunsch. Wir sehen den Vorteil das Neulinge sehen können wie man bestimmte Probleme lösen kann aber wollen keinen „richtigen“ Weg vorschreiben. Unsere Idee geht in die Richtung besonders hochwertige Anleitungen aus dem Forum in der Dokumentation zu verlinken. Der Ferengi Master hatte da ja eine sehr schöne Sammlung erstellt, auf der werden wir dann aufbauen.

Ich hoffe das stellt dich zufrieden. :wink:

Mir geht es auch nicht darum etwas „vorzuschreiben“, sondern ein „best practice“ zu „empfehlen“. Wie das genau aussieht, darüber kann man streiten :slight_smile: Aber wenigstens man kann Einsteigern einen möglichen Weg aufzeigen, wie man es machen könnte, damit man eine Idee hat wie wo was einzurichten ist und nicht auf gut Glück hier und da ein wenig rum klickt. Weiß nicht, wie ich das noch besser erklären könnte g Ist ja auch nur eine Idee, was ihr davon umsetzt bleibt euch überlassen :wink:

Ich will nur mithelfen, dass „mein“ IPS nicht in 1-2 Jahren am Ende der Heimautomatisierung-Software-Bestenliste ist, sondern an der Spitze und ich hätte dann auf das richtige Pferd gesetzt :smiley:

Grüße,
Chris

Hallo Bayaro,

das ist ja auch eine gute Idee! Wir freuen uns immer über die Mithilfe unserer Nutzer um IP-Symcon im Pferderennen der Hausautomationssoftwaresyteme nach vorne zu treiben. Jede Möhre hilft! Und IP-Symcon ist ganz sicher das richtige Pferd. :wink:

Gruß,
gucky

Moin Moin!
Und zum Frühstück gibt es eine große Möhre! :eek:
Mit der neuen Version 3.3 ist auch der erste Schwung Dokumentation parallel online gegangen.
Schaut doch bitte mal drüber. (Gaaaaanz unten! Bei den Änderungen!)
http://www.ip-symcon.de/service/dokumentation/installation/migration-v32-v33/

Neben den beschriebenen Dingen wurden auch zusätzlich einige Kleinigkeiten intern und auch in den Texten und Formulierungen geändert. Die zwar müßig aber von marginaler Sorte sind. :rolleyes:

Ich hoffe man sieht in welche Richtung es geht.

Grüße
Pio

Rechtschreibfehler bitte korrigieren :wink:

Migration (V3.2->V3.3) — IP-Symcon :: Automatisierungssoftware
-Neu: Ein Menge Shortcuts für die logische Baumansicht/Willkommen-Reiter

Sonstiges:
-Navigieren per Tab sollte nun überall korrekt sein (Feedback?) …ob das da noch stehen soll bei einer „Final“ ?! :slight_smile:
-Neu: Bool-Charts können nun unterschiedliche Profile bei Variablen anzeigen …„nun“ weg!?

>> Ist der Bug behoben? Wäre für eine Final vlt. gut gewesen!? :slight_smile: >> Probleme mit IPS_SetEventLimit

Anleitungen:
Schnelleinstieg — IP-Symcon :: Automatisierungssoftware
> Installieren sie IP-Symcon. Folgen sie dazu den Anweisungen im How-To-Install
>>> sollte „Sie“ heißen

> Die Tray Anwendung finden sie als IP-Symcon Icon in ihrer Taskleiste
>>> ebenfalls „Sie“

> (Standardmässig Unten-Rechts bei ihrer Uhr in der Taskleiste).
>>> Nennt man „Sys-Tray“ :wink:

> Hier können sie hier den Dienst starten/stoppen
>>> Auch „Sie“

> Unter „Information“ finden sie die Möglichkeit einen Fernzugriff einzurichten
>>> Ebenfalls „Sie“

> In der Verwaltungskonsole ist es der nächste Schritt,sich mit dem Aufbau ihrer Kategorien auseinander zu setzen.
>>> mein markiertes Komma fehlt, da sollte aber eins sein, oder!? Bei Kommas bin ich mir auch nie so ganz sicher :smiley:

> Wir empfehlen eine Unterteilung wiefolgt: Etagen
>>> „wie folgt“

> Wir empfehlen eine Unterteilung wiefolgt: Etagen -> Räume -> Gerät - und die Nutzung von „Links“
>>> Hier wäre ein Beispiel-Screenshot sicher sehr hilfreich

> Hier können sie auch ihre ersten Geräte/Instanzen und somit ersten Sensoren/Aktoren hinzufügen. Sehen sie dazu: Geräte/Instanzen hinzufügen.
>>> „Sie“

>>>> Alle „sie“ - „Sie“ zähle ich jetzt nicht mehr auf, das ist überall so :smiley: Also die bitte selbst mal alle korrigieren.

Um auch etwas positives zu schreiben > ich finde die neue Doku wirklich gut gelungen! Das bietet schon mal einen guten Einstieg in IPS und sollte das etwas vereinfachen. TOP! :loveips:

MfG,
Chris

PS: Soll kein „klugscheissen“ sein, ihr habt um Korrektur gebeten und ich will helfen!

Hallo Bayaro,

vielen dank für das schnelle und genaue drüber schauen. Ich sehe, wir müssen unsere Qualitätssicherung noch optimieren. :wink:

Dein Bugfix wäre in der Stable zwar super ist aber weiter nur in der Beta verfügbar da wir noch nicht zu 100% sicher sind ob durch den keine Folgefehler entstehen die wir natürlich nicht in der Stable haben möchten.

Wir schalten im Laufe des Tages dann eine neue Version der Dokumentation frei, die deine Vorschläge und Fehler aufgreift.

Gruß,
gucky

Moin gucky,

bin ja noch nicht fertig, ich lese gleich weiter :wink: Sind aber schon arg viele Fehler, ob man daraus Rückschlüsse ziehen sollte, wie bei IPS gearbeitet wird?! :wink: Wäre das eine eBay Beschreibung, dann würde ich da nichts kaufen :smiley:

Bzgl. Bug haste Recht, wäre trotzdem gut in der Stable gewesen :smiley:

Charts — IP-Symcon :: Automatisierungssoftware
> Überschriften der Tabelle: FELD – BESCHREIBEN
>>> Beschreiben??? Wohl eher „Beschreibung“ :smiley:

> Dieses Beispiel zeigt die Gegenüberstellung von Verbrauch-Kosten einer Heizungsanlage
>>> Verbrauch oder Verbrauchs-Kosten? Bin mir selbst nicht sicher…

> Hier wurde zweimal der selbe Variable ausgewählt
>> …die gleiche Variable ausgewählt

> wobei einer (hier hellgrün)
>>> „eine“

> In der Wochendarstellung seht man ein Vergleich zur Vorwoche; in der Jahresdarstellung demzufolge ein Vergleich zum Vorjahr.
>>> In der Wochen-Darstellung sieht man einen Vergleich zur Vorwoche, in der Jahres-Darstellung demzufolge einen Vergleich zum Vorjahr.

>>> Weitere Korrektur auf „Update“ verschoben :slight_smile:

Grüße,
Chris

Eine Sache hätte ich doch noch als Anmerkung:

Neu: COMPort_* heißt jetzt SPRT_* und WWWReader_* heißt jetzt WWW_*

> Sollte man das nicht deutlicher erwähnen, dass man die Befehle bei sich ändern muss? Die alten gehen zwar vmtl. noch, aber trotzdem sollte man da vlt. deutlicher drauf hinweisen?! Sonst wirds irgendwann nicht mehr mitgenommen in der „Compatibility“ und dann steht es im Update nicht dabei und man wundert sich was da los ist?!

Grüße,
Chris

So, Bayaro,

wir haben jetzt einen kleinen Fix mit Narrenkappe hochgeladen. Wenn du Zeit und Muße hast kannst du gerne noch einmal drüber schauen. Deine Vorschläge sind außer zwei Kleinigkeiten alle umgesetzt worden, an dieser Stelle noch einmal vielen Dank dafür!

Eventuell musst du mit Cache-Leerung neu laden (strg + F5) um jeweils die aktuellen Seiten zu sehen.

Unsere sie/Sie Schwäche werden wir auf lange Zeit dadurch Lösen, die direkte Ansprache komplett aus der Doku zu verbannen.

Zu deinem letzten Vorschlag: Du hast mit den Funktionen schon Recht, allerdings brauchen wir dafür noch eine pfiffige Lösung damit das auch bei jedem Nutzer ankommt, denn Migrations Anwleitungen liest am Ende doch fast keiner.

Gruß,
gucky

Ochja, jetzt alles auf den Alkohol schieben :wink: :smiley:

Dann mal los :slight_smile:

Geräteliste — IP-Symcon :: Automatisierungssoftware
> PTM 200 Shatler
>>> „Schalter“

Geräteliste — IP-Symcon :: Automatisierungssoftware
> Nicht Unterstützte Komponenten
>>> Nicht unterstützte Komponenten

Z-Wave — IP-Symcon :: Automatisierungssoftware
> Wenn dieses nun ausgewählt und die „Erstellen“-Taste gedrückt wird
>>> Wenn dieses nun ausgewählt und der „Erstellen“-Knopf/Button gedrückt wird

Fernzugriff — IP-Symcon :: Automatisierungssoftware
> Dabei sollten Sie ein sicheres Kennwort (mindestens acht Zeichen mit Sonderzeichen) vergeben
>>> War es nicht mittlerweile so (wenn ich mich richtig erinnere), dass 10 Zeichen der „neue sichere empfohlene Default“ sind!? Also so allgemein…

…und sollte man den Fernzugriff noch aufdröseln in „im eigenen Netzwerk“ und „extern“? Oder genauer bezeichnen? Weil von extern kämen ja noch Dinge wie DynDns und Portweiterleitung dazu. Also sollte man den Fernzugriff genauer auf das eigene Netzwerk beziehen?! Fernzugriff klingt so nach „egal wo ich auf der Welt bin auf mein IPS zugreifen“, also so wie es aktuell beschrieben ist.

Geräte einbinden — IP-Symcon :: Automatisierungssoftware
> Dort können Sie die benötigten Einstellungen überprüfen und gegenfalls nachbessern.
>>> Dort können Sie die benötigten Einstellungen überprüfen und gegebenenfalls nachbessern.

> Wie Sie Ihr jeweiliges Gerät einrichten finden sie beschrieben oder per Video-Tutorial im Bereich „Modulreferenz“.
>>> „Sie“

Links verwenden — IP-Symcon :: Automatisierungssoftware
> Darüber hinaus hält die IP-Symcon Professional-Version ein besonderes Extra für Sie bereit. Mit der Professional-Version ist es möglich
>>> Ich persönlich würde hier entweder schreiben „ab der Professional-Version“ oder bei der „Professional und der Ultimate Version“

> Unter Umständen müssen Sie dazu Ihre WebFront neu laden
>>> „Ihr“

> danach setzen Sie ein Häkchen bei “Versteckt” an und bestätigen mit “OK”.
>>> „an“ ist „zuviel“

Email Benachrichtigung — IP-Symcon :: Automatisierungssoftware
> Im Menü “E-Mail senden (SMTP)” müssen Sie nun Ihre persönliche Daten eintragen.
>>> „persönlichen“

> Achten Sie jedoch darauf, dass die Einstellungen des Providers UND der Absender-Adresse korrekt sind
>>> „und“ vergessen?!

VORERST FERTIG :slight_smile:

Grüße,
Chris

Danke Bayaro,

ich denke deine letzten Vorschläge werden morgen online gehen.

Gruß,
gucky

Die Dokumentation wurde jetzt aktualisiert!

Hi!

Mich hat das mit dem Fernzugriff interessiert und das hab ich mir nochmal angeschaut eben. Ganz am Ende der Hinweis „Für einen Zugriff von außerhalb des eigenen Netzwerkes wird die Konfiguration einer Port-Weiterleitung im Router benötigt.“

…den halte ich so für etwas gefährlich.

Klar, jedes ist für sein Sicherheitskram selbst verantwortlich, aber sollte man den Anwender nicht wenigstens darauf hinweisen, dass man für gewisse Sicherheitsvorkehrungen selbst sorgen muss, weil durch die Portweiterleitung „theoretisch“ JEDER auf das IPS zugreifen kann?!
Zum Beispiel > „Denken Sie daran, Ihren Zugang entsprechend abzusichern (z.B. mittels VPN, SSL, Auth, …)“ < und am besten dann zu entsprechenden Dingen Beispiele bringen, wie man das umsetzen könnte!?

Grüße,
Chris

Ich will nicht sagen das du Unrecht hast, aber ich gehe davon aus das jemand der eine Port-Weiterleitung einrichten kann auch weiß wie er sich absichern kann. Außerdem kann ja nicht jeder auf sein IP-Symcon zugreifen, dafür wird schließlich die URL und das Passwort benötigt.

Demnächst wird das ganze ja auch obsolet, nämlich wenn das Connect-Modul veröffentlicht wird und wir den Zugriff von Extern über unsere Server laufen lassen.

Würde man immer davon ausgehen, dass alle alles wissen/verstehen/können/…, dann lies dich mal ein wenig durch das Internet, da tauchen fragen auf, da fällt man vom Hocker :smiley: Und von etwas ausgehen ist, meiner Meinung nach, die falsche Art so ein wichtiges Thema zu behandeln. Ein kleiner Hinweis bringt niemanden um :slight_smile: Die Leute die Ahnung haben überlesen den Hinweis, andere sind vlt. dankbar…also!? :slight_smile:

Auf das Connect bin ich mal gespannt. Aber ich denke mal, dass das nicht in 1-2 Tagen/Wochen Stable und für alle verfügbar sein wird!?

Und gleich vorab, bevor das Connect von euch freigegeben wird > BITTE stellt ausreichend Infos darüber zur Verfügung, wie das Ding arbeitet usw., so kann man Sicherheitsdiskussion direkt „einbremsen“.
Aber wenn man nur Connect veröffentlicht und sagt „Port X ins Internet freigeben, im Handy connect.ips.de eingeben, fertig“, dann ist das eher ungünstig :wink:

Ich kann gerne wieder Test-Lesen und Connect selbst natürlich auch testen :slight_smile:

Grüße,
Chris

Moin Moin!

Nach dem Fauxpas bei der letztmaligen Veröffentlichung geht es nun hoffentlich in verbesserter Methode weiter.
Dieses Mal ging es darum die vorhandenen Formulierungen in eine einheitliche Form zu bringen, sowie offensichtliche Fehlformulierungen oder veraltete Fakten teils auszubessern.
Die ist von Beginn der Doku bis exkl. Komponenten->Visualisierung geschehen.
(Ausnahmen bilden die Migrationseinträge und die Einführungsseite selbst)

Durch einheitliche Namensgebung und Beschriftung hoffe ich die Verständlichkeit zu erhöhen.
So richtig glücklich bin ich noch nicht, doch die ultimative Lösung ist mir noch nicht eingefallen.

Der Medieneintrag wurde aufgeteilt mit den Unterkategorien. Die Dashboard formulare sind hier noch „ToDo“
http://www.ip-symcon.de/service/dokumentation/konzepte/medien/

Wie immer gilt:
Es ist noch viel „Work-In-Progress“ und die ToDo Liste wächst und wächst.
Dennoch bitte ich euch mögliche Typos wie immer mitzuteilen, damit ich diese schnellstmöglich ausbessern kann.

Frohe Grüße von der Doku Front.
Pio

Hab noch nicht angefangen mit dem „Prüfen“, aber hab durch Zufall einen „Fehler“ entdeckt.

Geräteliste — IP-Symcon :: Automatisierungssoftware
>> Fibaro >> FGFS-101 Flood Sensor
>>>>> Ist 2x untereinander aufgeführt, also quasi doppelt

Grüße,
Chris

Überarbeitung der Doku

Lizenz ändern — IP-Symcon :: Automatisierungssoftware
>> Hier könnte mal ein neuer Screenshot eingebaut werden, sieht ja mittlerweile etwas anders aus

Grundlagen — IP-Symcon :: Automatisierungssoftware
> Auch ist es möglich bei der Objektbearbeitung jedem Objekt eine Beschreibung und Icon zu geben.
>> Auch ist es möglich, unter „Objekt bearbeiten“, jedem Objekt eine Beschreibung und ein Icon zu geben.

Kategorien — IP-Symcon :: Automatisierungssoftware
> Der letzte gelbe Kasten, ganz unten auf der Seite, mit „Sollte es in IP-Symcon Stellen geben, in der diese Pfaddarstellung nicht ersichtlich sein sollte und z.B. nur der Name erkennbar ist, so ist dies ein Fehler und sollte dem IP-Symcon Support gemeldet werden.“
>> Rechnet ihr mit Fehlern in eurem Produkt? :smiley: Sowas würde ich dann doch eher nicht schreiben…kann „seltsam“ rüberkommen :wink:

Charts — IP-Symcon :: Automatisierungssoftware
>> Hier könnte man noch auf die „Vollbild-Graphen“ im WebFront eingehen (multi und einzel). Oder wird das an anderer Stelle gemacht (wenn ja, dann verlinken)?

Dann möchte ich an dieser Stelle man ein großes Lob an Pio aussprechen! :slight_smile: Da hat sich jemand richtig Mühe gegeben! Und nach dem letzten „Missgeschick“ mit dem „ein oder anderen Fehler“ :D, hat sich doch einiges getan und die Doku liest sich, meiner Meinung nach, deutlich besser und ist auch schon recht ausführlich. Damit kann ein Neueinsteiger etwas anfangen :slight_smile: TOP

Ich würde mir aber, wie hier im Thread schon geschrieben, aber noch ein paar mehr praktische Beispiele/Anleitungen wünschen. Wie zum Beispiel „2 Bewegungsmelder, 1 Lampe und 2 Schalter - mit Z-Wave / HomeMatic / KNX EIB - für Treppenhausbeleuchtung“ und dann richtig von A-Z mit Screenshots.

Grüße,
Chris