UPGRADE IP 9 verfügbar!
Timberwolf VISU jetzt mit NEUEM Layout Editor
Freie Anordnung, Reihenfolge und Größe der Widgets - viele weitere Verbesserungen
Infos im Wiki: https://elabnet.atlassian.net/l/cp/06SeuHRJ

NEU! Insider & Leistungsmerkmale FÜR ALLE freigeschaltet
Damit kann nun jeder das Upgrade vornehmen und VISU & IFTTT testen. Alle Info hier: viewtopic.php?f=8&t=5074

Diskussion zur Verbesserung der Dokumentation

Hier nur wichtige Tipps und Tricks. Schreibrechte nur für freigeschaltete Benutzer
Forumsregeln
  • Denke bitte an aussagekräftige Titel und gebe dort auch die [Firmware] an. Wenn ETS oder CometVisu beteiligt sind, dann auch deren Version
  • Bitte mache vollständige Angaben zu Deinem Server, dessen ID und dem Online-Status in Deiner Signatur. Hilfreich ist oft auch die Beschreibung der angeschlossener Hardware sowie die verwendeten Protokolle
  • Beschreibe Dein Projekt und Dein Problem bitte vollständig. Achte bitte darauf, dass auf Screenshots die Statusleiste sichtbar ist
  • Bitte sei stets freundlich und wohlwollend, bleibe beim Thema und unterschreibe mit deinem Vornamen. Bitte lese alle Regeln, die Du hier findest: https://wiki.timberwolf.io/Forenregeln

Ersteller
Robert_Mini
Reactions:
Beiträge: 3741
Registriert: So Aug 12, 2018 8:44 am
Hat sich bedankt: 1164 Mal
Danksagung erhalten: 2058 Mal

Diskussion zur Verbesserung der Dokumentation

#1

Beitrag von Robert_Mini »

Hallo zusammen!

Dieser Thread wurde von hier abgetrennt: viewtopic.php?f=24&t=2527&start=50
Ein paar Zitate daraus, nicht ich nicht verschieben wollte (weil zum Kontext des Originalthreads gehören):
Irgendwie habe ich inzwischen das Gefühl das wenn man nicht andauernd im Forum mitliest, man mit dem TWS überfordert ist....
Das Problem liegt eher in der Übertragung der hier erarbeiteten Lösungen in die Doku und deren Zugänglichkeit.
Eine Lösung auf Seite 34 einer Diskussion mit 123 Seiten ist quasi nicht findbar.
An der Stelle scheitere ich auch regelmäßig. Die ist aber auch extrem schwer in den Griff zu bekommen.
Bezüglich Doku ist mir klar, dass zb eine Liste der Custom Logiken + Links zur besseren Auffindbarkeit fehlt.

Der Rest steht mehr oder weniger gut in der KB. Leider wird der KB-Inhalt über die Suche nicht gefunden. Aber wenn was fehlt oder unklar/falsch ist, dann braucht es auch dezidierte Hinweise.
Ich lese zwar hier im Forum mit, aber frage dann auch nicht jedesmal nach, ob in der KB gesucht wurde und die Lösung dort unklar ist.

Den Vermerk, dass man ohne Mitlesen hier im Forum den TWS bald nicht mehr bedienen kann, versteh ich auch nicht ganz. Klar ist das bezüglich neuer custom Logiken im Forum, aber das Bedienkonzept ist seit Anbeginn praktisch gleich. Jetzt in der 1.6 hat sich die Menüführung geändert, aber ist weiter intuitiv.

Wenn Dinge nach längerer Zeit haken, dann wären sicher Hinweise dazu für Stefan hilfreich, damit man integrierte Hilfetexte ab diesen Stellen ergänzen kann.

BITTE um intensive Mithilfe! Ich überlege mir dann noch einen Ort, wo die gesammelten Hinweise einsehbar sind.

Edit:
Ich habe die ToDo-Liste in der KB nun öffentlich gemacht: app.php/kb/viewarticle?a=40
Ähnlich könnte ich die Anregungen sammeln, wo es noch keine Diskussion dazu gibt.

Lg
Robert

PS: Falls wer in der KB mithelfen will, wäre jetzt wieder eine gute Gelegenheit :D .
Zuletzt geändert von Robert_Mini am Mo Dez 28, 2020 11:55 am, insgesamt 3-mal geändert.
Timberwolf Server 2500 / #117 (VPN offen + reboot nach Rückfrage) / zusätzlich: 3500M/#935, 3500L/#1297

SchlaubySchlu
Reactions:
Beiträge: 211
Registriert: Mo Aug 13, 2018 9:32 pm
Wohnort: Allgäu
Hat sich bedankt: 106 Mal
Danksagung erhalten: 91 Mal

#2

Beitrag von SchlaubySchlu »

Hallo Robert,

vielleicht war mein Kommentar etwas hart gewählt aber, zumindest mir geht es zumindest gefühlt so.

Das eigentliche Problem an der ganzen Sache bin vielleicht auch ich, da ich evtl. beim Kauf des TWS die Meinung hatte das das speziell die Logik "einfacher" zu bedienen sei. Ich verstehe aber auch das der Trade-off zwischen maximaler Funktion und leichter Bedienung sehr sehr schwierig, bzw. unmöglich ist.
Auf jeden Fall sollte das keine Kritik an eurer Arbeit sein, speziell nicht an denen die dies alles in ihrer Freizeit machen und dann das Ergebnis der ganzen Community zur Verfügung stellen.
Ich würde da gerne auch etwas beitragen, doch wie ich immer wieder feststellen muss, bin ich noch lange nicht so weit.

Die KB finde ich prinzipiell sehr gut, aber wie du schon geschrieben hast ist das mit der Suche noch ein Problem und verkompliziert damit das ganze.
Auch würde ich ein paar „Komplettbeispiele“, nach dem Motto „Ich wünsche mir eine Zeitschaltuhr, was muss ich tun“ wünschen (Voraussetzung z.B. TWS, KNX/1-Wire und CV).
Das ist jedoch sehr zeitaufwendig, würde das „User-Erlebnis“ mit dem TWS, gerade am Anfang sehr verbessern. Zumindest würde es geht es mir so gehen, da ich am leichtesten an realen Beispielen lerne, als an fiktiven Beschreibungen. Aber das sehen andere vielleicht anders.
Genau dies würde ich gerne zum Anlass nehmen und versuchen so eine Beschreibung zu erstellen, so als Test und diese dann gerne von jemanden hier im Forum „reviewen“ lassen um sie dann online zu stellen.
Was haltet ihr davon?

Generell finde ich die TWS Community genial, die Mitglieder gehen respektvoll miteinander um und es wird einem immer geholfen. Meinungsverschiedenheiten gibt es immer und überall im Leben aber die kann man auch respektvoll „austragen“, so wie es hier geschieht. Dazu auch mein Dank an Stefan und sein Team, die das Forum sehr gut moderieren.
Das gibt es nicht in vielen Foren.

Sorry das ich mit meinen Fragen und Kommentaren etwas von der ZSU abgeschweift bin.

Wünsche euch noch einen schönen Sonntag.

Gruß Ralf
Timberwolf Server 2600 #196, VPN offen, Reboot nach Vereinbarung, BM 729

StefanW
Elaborated Networks
Reactions:
Beiträge: 9689
Registriert: So Aug 12, 2018 9:27 am
Wohnort: Frauenneuharting
Hat sich bedankt: 4831 Mal
Danksagung erhalten: 7632 Mal
Kontaktdaten:

#3

Beitrag von StefanW »

Hallo Ralf,
SchlaubySchlu hat geschrieben: So Dez 27, 2020 12:18 pmDas eigentliche Problem an der ganzen Sache bin vielleicht auch ich, da ich evtl. beim Kauf des TWS die Meinung hatte das das speziell die Logik einfacher" zu bedienen sei.
(edit / neu gefasst für bessere Erklärung)

ich denke, die Logik ist durchaus einfach zu bedienen. Praktisch alles ist mit einem oder zwei Klicks erreichbar. Was wir nicht noch einfacher machen können ist, dass Steuerungen und Regelungen teils auf komplexen Zusammenhänge im Haus beruhen und diese sind dann auch zu definieren.

Eine Logik ist letztlich eine Abbildung von inhaltlichen und zeitlichen Zusammenhängen der von den angeschlossenen Geräten gelieferten Daten. Bei einfachen Zusammenhängen ist das auch schnell bewerkstelligt. Bei komplexen Zusammenhängen wird es dann aber eben auch schwieriger. Das Thema Logik ist, ähnlich dem Thema Visu, wegen der bei komplexen Zusammenhängen und vielen Details leider nicht immer einfach.

Schließlich muss man dazu durchaus in die Beschreibung derjenigen Geräte eintauchen, die Daten bereitstellen (wann, wo, wie) und insbesondere in die Beschreibung derjenigen Geräte, die letztlich angesteuert werden sollen. Zusätzlich sollte man bei kritischen Steuerungen darauf achten, wie eine solche Steuerung Fail-Safe auszulegen ist und dass eine Logik auch beim Neustart von Teilen des Systems (in beliebiger Reihenfolge) funktioniert. Insbesondere letzteres kann durchaus anspruchsvoll sein und macht auch Kenntnisse des gesamten Systems erforderlich. Alles das hat aber noch gar nichts mit dem Logik Editor selbst zu tun, sondern ist eben immanent zur Aufgabenstellung.


Ich fürchte, man kann gerade die Definition von komplexeren Zusammenhängen nicht beliebig vereinfachen, weil der Aufwand liegt schließlich gar nicht im Server selbst.

Woran wir daher arbeiten sind vor allem Vereinfachungen bei der Datenaufbereitung und interaktiver Konfiguration, damit durch die Echtzeit-Rückmeldung auch Zeit eingespart wird. Bei der kommenden Modbus-Unterstützung haben wir daher bereits eine Menge in die Datenaufbereitung / Datenformatierung / Datenkonvertierung / Datenberechnung eingebaut, so dass für 90% der Themen rund um Datenaufbereitung und Konvertierung die Logikengine gar nicht mehr nötig ist, weil das bereits durch die Modbus Engine erfolgt. Dies soll die Komplexitäten stark reduzieren. So dass man möglichst viel schon einfach so verknüpfen kann, ohne den Wert vorher über die Logik senden zu müssen bzw. bei der Integration der Werte in eine Logik nicht noch Datenaufbereitung betreiben muss.

Damit müsste man nur noch zeitliche oder inhaltliche Zusammenhänge von mehreren Werten über die Logik senden. Dies haben wir auch mit den weiteren Kommunikationsmodulen so geplant, so dass wir Aufwand in Logik damit reduzieren. Auch an anderer Stelle im Produkt sind solche Dinge schon eingebaut, zum Beispiel in der 1-Wire Implementierung. Bei Modbus und Co. legen wir nun nochmal einiges drauf.

SchlaubySchlu hat geschrieben: So Dez 27, 2020 12:18 pmIch verstehe aber auch das der Trade-off zwischen maximaler Funktion und leichter Bedienung sehr sehr schwierig, bzw. unmöglich ist.
Unmöglich nicht, aber in der Tat sehr schwer. Die Mehrheit der im Forum schreibenden Foristen ist sehr weit in allen Funktionen und schreit beständig nach mehr Funktionen. Ein Teil der schweigenden Foristen mag an der Flut dagegen ertrinken. Wir versuchen an diese durchaus zu denken, müssen aber mangels Rückmeldung zum Teil raten, was wir hier verbessern können. Darum bitte mehr qualitative Rückmeldung auch von diesem Teil der Nutzer.

SchlaubySchlu hat geschrieben: So Dez 27, 2020 12:18 pmIch würde da gerne auch etwas beitragen, doch wie ich immer wieder feststellen muss, bin ich noch lange nicht so weit.
Doch, Du bist GENAU RICHTIG weit um anderen zu helfen, die ebenfalls sich noch nicht so Fit fühlen. Wir brauchen mehr Infos von Nutzern wie Dir.

SchlaubySchlu hat geschrieben: So Dez 27, 2020 12:18 pmDie KB finde ich prinzipiell sehr gut, aber wie du schon geschrieben hast ist das mit der Suche noch ein Problem und verkompliziert damit das ganze.
Wir arbeiten, immer noch, an der Confluence Doku, die dann auch eine tolle Suche bieten wird. Allerdings haben wir die Vereinfachung der Bedienung, die interaktiven Anzeigen und den Ausbau der Hilfe- und Infotexte in der Benutzeroberfläche des TWS demgegenüber priorisiert.

==> Die jetzige KB wird dann auch inhaltlich in die Confluence Doku überführt werden. Ich appelliere daher an Euch, helft uns dabei tolle Anleitungen und Infos gerade zu speziellen Einsatzbereichen zu schreiben und bringt bitte diese in die KB. Von dort werden wir dann, sobald wir dazu kommen, diese in das Wiki überführen.

Die Doku wird beständig ausgebaut, bis jetzt war es allerdings so, dass wir neue Texte und Erklärungen erstmal als Info- und Hinweis-Texte im Timberwolf Server selbst untergebracht haben. Hier ist in letzter Zeit bereits eine Menge entstanden und eine Menge wird noch kommen.

Wir würden uns hier mehr Rückmeldungen zu solchen Verbesserungen wünschen, weil wir hier den Eindruck haben, dass die Nutzer das gar nicht wünschen.

SchlaubySchlu hat geschrieben: So Dez 27, 2020 12:18 pmGenau dies würde ich gerne zum Anlass nehmen und versuchen so eine Beschreibung zu erstellen, so als Test und diese dann gerne von jemanden hier im Forum „reviewen“ lassen um sie dann online zu stellen. Was haltet ihr davon?
Ganz hervorragend, JA BITTE sehr!

Bitte gerne als Tutorial, ich nehme das dann gerne in das Wiki mit auf, bzw. melde mich dann, dann kannst Du es auch selbst dort eintragen.

SchlaubySchlu hat geschrieben: So Dez 27, 2020 12:18 pmGenerell finde ich die TWS Community genial, die Mitglieder gehen respektvoll miteinander um und es wird einem immer geholfen.
Danke sehr an die Community für die tolle Hilfe und die tollen Inhalte.

lg

Stefan
Zuletzt geändert von StefanW am Mo Dez 28, 2020 10:15 am, insgesamt 3-mal geändert.
Stefan Werner
Product Owner für Timberwolf Server, 1-Wire und BlitzART
Bitte WIKI lesen. Allg. Support nur im Forum. Bitte keine PN
Zu Preisen, Lizenzen, Garantie, HW-Defekt an service at elabnet dot de

Link zu Impressum und Datenschutzerklärung oben.

Sun1453
Reactions:
Beiträge: 1849
Registriert: Do Feb 07, 2019 8:08 am
Hat sich bedankt: 1541 Mal
Danksagung erhalten: 788 Mal

#4

Beitrag von Sun1453 »

@StefanW

Also ich finde diese inline Informationen sehr gut im TWS. Da muss man an diesen Stellen nicht ein Handbuch suchen sondern hat alles direkt griffbereit.

In Sachen Conference wolltest du diversen Foristen den Zugang einrichten um den Content zu sichten und ein Review zu machen. Das ist leider durch andere Themen untergegangen.

@SchlaubySchlu sehr gerne kannst du das machen. Ich und auch viele andere würden gerne einen Blick darauf werfen.

Ja die Community ist hier einfach super und auch der angenehme Ton. Da muss ich @SchlaubySchlu zustimmen.
Gruß Michael

Timberwolf 950 QL #344 | Mit Internetanbindung | VPN Offen | Reboot nach Absprache | PROD Server
Timberwolf 2500 #602 | VPN offen | TEST Server | Reboot nach Absprache |

StefanW
Elaborated Networks
Reactions:
Beiträge: 9689
Registriert: So Aug 12, 2018 9:27 am
Wohnort: Frauenneuharting
Hat sich bedankt: 4831 Mal
Danksagung erhalten: 7632 Mal
Kontaktdaten:

#5

Beitrag von StefanW »

Hallo Michael,
Sun1453 hat geschrieben: So Dez 27, 2020 3:24 pmIn Sachen Conference wolltest du diversen Foristen den Zugang einrichten um den Content zu sichten und ein Review zu machen. Das ist leider durch andere Themen untergegangen.
Ja, weil wir haben Vereinfachungen in der Benutzeroberfläche, insbesondere hinsichtlich mehr Rückmeldungen und mehr einfach bedienbare Assistenten gegenüber der Doku priorisiert. Weil was man einfach so ganz einfach versteht, muss man nicht aufwändig beschreiben. In diesem Zusammenhang bauen wir auch die Offline-Hilfe im System selbst aus.

Trotzdem wird es natürlich das Handbuch geben, weil Zusammenhänge zwischen mehreren Modulen lassen sich durch Inline-Texte nur bedingt beschreiben.

Ich melde mich schon noch bei denjenigen Nutzern, die sich an der Confluence Doku beteiligen wollen, aber dafür wollen wir erst einen besseren Stand schaffen, weil wir sonst nur eine Flut an Rückmeldungen produzieren würden, was uns auch nicht hilft.

lg

Stefan
Stefan Werner
Product Owner für Timberwolf Server, 1-Wire und BlitzART
Bitte WIKI lesen. Allg. Support nur im Forum. Bitte keine PN
Zu Preisen, Lizenzen, Garantie, HW-Defekt an service at elabnet dot de

Link zu Impressum und Datenschutzerklärung oben.

Ersteller
Robert_Mini
Reactions:
Beiträge: 3741
Registriert: So Aug 12, 2018 8:44 am
Hat sich bedankt: 1164 Mal
Danksagung erhalten: 2058 Mal

#6

Beitrag von Robert_Mini »

SchlaubySchlu hat geschrieben: So Dez 27, 2020 12:18 pm Hallo Robert,
Ich würde da gerne auch etwas beitragen, doch wie ich immer wieder feststellen muss, bin ich noch lange nicht so weit.
...
Die KB finde ich prinzipiell sehr gut, aber wie du schon geschrieben hast ist das mit der Suche noch ein Problem und verkompliziert damit das ganze.
Auch würde ich ein paar „Komplettbeispiele“, nach dem Motto „Ich wünsche mir eine Zeitschaltuhr, was muss ich tun“ wünschen (Voraussetzung z.B. TWS, KNX/1-Wire und CV).
...
Hallo Ralf!

Danke für deine Anmerkungen. Das Feedback ist sehr wichtig, da es sonst schwer ist zu erkennen, wo Dinge noch klarer beschrieben werden müssen oder wo eben was fehlt!

Ich erlaube mir einen gesonderten Thread dazu anzulegen bzw. Teile hier abzutrennen, um das weiter zu diskutieren/präzisieren.
Feedback/Kritik ist auch eine wichtige Form von Mithilfe - ich freu mich drauf.

Danke und lg
Robert
Timberwolf Server 2500 / #117 (VPN offen + reboot nach Rückfrage) / zusätzlich: 3500M/#935, 3500L/#1297

Sun1453
Reactions:
Beiträge: 1849
Registriert: Do Feb 07, 2019 8:08 am
Hat sich bedankt: 1541 Mal
Danksagung erhalten: 788 Mal

#7

Beitrag von Sun1453 »

Gute Sache Robert mit der Abtrennung.
Gruß Michael

Timberwolf 950 QL #344 | Mit Internetanbindung | VPN Offen | Reboot nach Absprache | PROD Server
Timberwolf 2500 #602 | VPN offen | TEST Server | Reboot nach Absprache |

Sun1453
Reactions:
Beiträge: 1849
Registriert: Do Feb 07, 2019 8:08 am
Hat sich bedankt: 1541 Mal
Danksagung erhalten: 788 Mal

#8

Beitrag von Sun1453 »

Eventuell könnte man Confluence auch wie wir es in Projekten nutzen für CR /FR nutzen. Sammeln würdest dazu du und eben Leute wie Robert, Göran, ich und Yves wenn ich das noch im Blick hatte. Hoffe das ich an alle gedacht habe, die bei der Doku mithelfen wollten. Diskussionen hier im Forum wie es sich gehört aber der FR liegt eindeutig abgegrenzt und aktuell im Confluence .
Gruß Michael

Timberwolf 950 QL #344 | Mit Internetanbindung | VPN Offen | Reboot nach Absprache | PROD Server
Timberwolf 2500 #602 | VPN offen | TEST Server | Reboot nach Absprache |

Ersteller
Robert_Mini
Reactions:
Beiträge: 3741
Registriert: So Aug 12, 2018 8:44 am
Hat sich bedankt: 1164 Mal
Danksagung erhalten: 2058 Mal

#9

Beitrag von Robert_Mini »

Sun1453 hat geschrieben: Mo Dez 28, 2020 10:34 am Eventuell könnte man Confluence auch wie wir es in Projekten nutzen für CR /FR nutzen. ...
Diskussionen hier im Forum wie es sich gehört aber der FR liegt eindeutig abgegrenzt und aktuell im Confluence .
Kann man machen. Dazu muss aber Confluence am Start sein und eine gewisse Akzeptanz erreicht haben.
Über das Zusammenspiel Forum / Confluence (anstelle der KB) und Inline-Hilfe bin ich mir noch nicht ganz sicher, ich sehe es aktuell so:
1) Dinge wo möglich in die Inline-Hilfe (meist auf die aktuelle Seite beschränkt, keine übergreifenden Erklärungen)
2) Geprüfte und gut dokumentierte Erklärungen im Confluence
3) Diskussion wie jetzt im Forum. Immer wenn ein Thema angesprochen wird, dass im Confluence schon beschrieben ist => Link dazu posten und erneutes erklären vermeiden.

lg
Robert
Timberwolf Server 2500 / #117 (VPN offen + reboot nach Rückfrage) / zusätzlich: 3500M/#935, 3500L/#1297

Ersteller
Robert_Mini
Reactions:
Beiträge: 3741
Registriert: So Aug 12, 2018 8:44 am
Hat sich bedankt: 1164 Mal
Danksagung erhalten: 2058 Mal

#10

Beitrag von Robert_Mini »

Ich habe die ToDo-Liste in der KB nun öffentlich gemacht:
app.php/kb/viewarticle?a=40

Darin sind alle Themen, die ich aus den laufenden Diskussionen im Forum so mit notiert habe, gesammelt.
Es hat sich leider einiges aufgestaut... :crying-yellow: :confusion-helpsign: :confusion-helpsos:

Manches geht oft rasch, da bereit in toller Form beschrieben, die verbleibenden Dinge sind aber über mehrere Postings gereift und das erstellen eines Beitrages ist dann doch sehr aufwendig.

In ähnlicher Form könnte ich weitere Anregungen/Wünsche für die Doku sammeln, also nur her damit.

lg
Robert
Zuletzt geändert von Robert_Mini am Mo Dez 28, 2020 11:55 am, insgesamt 1-mal geändert.
Timberwolf Server 2500 / #117 (VPN offen + reboot nach Rückfrage) / zusätzlich: 3500M/#935, 3500L/#1297
Antworten

Zurück zu „Essentials - Wichtige Tipps & Tricks“