Seite 1 von 1

Neues Leistungsmerkmal - Offline Hilfe System

Verfasst: Do Mai 28, 2020 8:35 am
von StefanW
Verehrte Kunden,

mit der "Version V 1.6 Insider Preview 3" werden wir ein neues Leistungsmerkmal präsentieren:


Offline Hilfesystem (im Bereich Management Docker / Portainer)

Der Timberwolf Server wird zunehmend leistungsfähiger und bietet mehr Möglichkeiten. Es ist unser Anliegen, dass unsere Kunden und Nutzer des Timberwolf Servers die teils komplexen Funktionen möglichst einfach konfigurieren und nutzen können. Ein Beitrag hierzu ist - neben einer möglichst einfach bedienbaren Oberfläche - gute Informationen, insbesondere auch zu technischen Details der Protokolle zu geben.

Dafür betreiben wir dieses Forum und ebenfalls auch die KnowledgeBase - und bedanken uns hierbei auch an die ehrenamtlichen Betreuer der KnowledgeBase - sowie künftig ein Wiki mit einer Bedienungsanleitung. Ebenfalls haben wir in den letzten Versionen die "MouseOver" Einblendungen verbessert, damit die Kunden jeden Wert auch erklärt bekommen.


Das Ziel der Verbesserungen ist:

Viele unserer Kunden sind Elektriker und Systemintegratoren, auch aus der Industrie. Manche müssen zur Installation im Keller eines Gebäudes sitzen, womöglich dabei auf einer Getränkekiste, und haben dabei nur schlechten oder keinen Internet-Empfang.

==> Den Anforderungen wollen wir nun mit einer "Offline-Hilfe" begegnen, die im Timberwolf Server integriert ist, damit man schnell zum jeweiligen Thema geführt wird. Hierbei erfolgt auch - für diejenigen mit Verbindung zum Internet - eine Verlinkung zu Teilen oder Threads im Forum und zur Knowledge Base.


Wir beginnen mit den Hilfetexten für das Management der Docker Container und werden diese Hilfe auf alle Funktionsbereiche des Timberwolf Servers ausdehnen. Wir freuen uns über Eure Rückmeldungen.



Das neue Offline-Hilfesystem in der Übersicht:


Die Offline-Hilfe wird in einer blauen Zeile angezeigt (darunter Support-Informationen):


Zum Aufklappen der Offline-Hilfe auf das (i) drücken:

2020-05-27_Docker-Hilfe_Eingeklappt_1.jpg



Aufgeklapptes Hilfesystems mit Seite Übersicht (Einführung in das Thema):[/b]

2020-05-27_Docker-Hilfe_Uebersicht_groß_1.jpg



Erklärung zu Docker-Themen

2020-05-27_Docker-Hilfe_Docker_schmal_1.jpg



Erklärung zu Portainer-Themen

2020-05-27_Docker-Hilfe_Portainer_schmal_1.jpg



Tipps & Tricks:

2020-05-27_Docker-Hilfe_Tipps_schmal_1.jpg



Links zum Forum und zur Knowledge Base :

2020-05-27_Docker-Hilfe_Links_schmal_1.jpg


Diese neue Offline-Hilfe soll den Einstieg aber auch für fortgeschrittene Themen hilfreich sein. Ss steckt wieder viel Arbeit drin. Wir freuen uns auf Eure Anmerkungen, hoffen auf Eure Mitarbeit und bitten laufend um Rückmeldungen, wenn Euch Themen in der Hilfe fehlen.


Verfügbarkeit:

Diese Woche machen wir damit den 2. Alpha-Test der IP 3 für die Version 1.6, in der Insider Preview dann voraussichtlich erste Juniwoche mit "V 1.6 IP 3".

Danach gilt ein Feature Freeze für die Entwicklung der V 1.6 und wir wollen über ein bis drei Release Candidates zügig die Hauptversion 1.6 ausrollen.


lg

Stefan

Re: Ankündigung: Neues Leistungsmerkmal - Offline Hilfe System

Verfasst: Do Mai 28, 2020 9:06 am
von Dante
Hi Stefan,

wieder großen Respekt für die Arbeit die Ihr leistet - wenn ihr etwas macht, steckt ihr volle Energie rein, es richtig zu machen! :bow-yellow:

Bei diesem Punkt fallen mir aber ein paar Schwachstellen auf: :think:

1.
Ob die Annahme, dass die "Elektriker und Systemintegratoren" oft "nur schlechten oder keinen Internet-Empfang" haben, korrekt ist, kann ich nicht verifizieren. Ich glaube aber, dass es bei denen, die solche intelligenteren Geräte und auch KNX-Geräte in Betrieb nehmen, nicht eine so große Schwierigkeit ist oder sie sich zu helfen wissen. Das Handbuch eines KNX-Geräts wird ja auch mal schnell gebraucht oder sonst was nachgesehen. Und auch mit jeder weiteren Mobilfunkgeneration dürfte man immer weniger Offline sein. Aber das nur nebenbei.


2.
Das sich hinter dem kleinen (i) so viele Informationen verstecken ist IMHO nicht intuitiv. Ich hab aber zugegebenermaßen grad auch keine Lösung dafür parat.


3. das wichtigste
Ich sehe nur bei diesem Thema eine große Gefahr für Redundanz und Inkonsistenz, die im schlimmsten Fall zu mehr Verwirrung bei euren Kunden führt. Wie du aufgezählt hast, gibt es jetzt dann:
  • Forum
  • KnowledgeBase
  • Wiki (künftig)
  • "MouseOver" Einblendungen
  • Offline-Hilfe
Eine Idee wäre, die Offline-Hilfe und KnowledgeBase im Wiki zusammenzuführen und dieses dann als Offline-Kopie auf dem TWS mittels Update einzuspielen. Und wenn ihr Angst vor falschen / schädlichen, user-generierten Inhalten habt, die dann vllt. auf dem Server landen könnten, wäre ja vllt. auch so etwas wie "gesichtet Versionen" möglich.

Unter den jeweiligen Wiki-Einträgen dann die Abfrage, ob der Eintrag hilfreich und bei Nein eine Abfrage, was nicht gepasst oder gefehlt hat. Weiter dort dann erst der Verweis auf's Forum für weitere Hilfe - damit erstmal versucht wird, sich über das Wiki selbst zu helfen.

Re: Ankündigung: Neues Leistungsmerkmal - Offline Hilfe System

Verfasst: Do Mai 28, 2020 9:08 am
von fechter65
Super, sieht toll aus und ist sicherlich sehr informativ.
Danke

Re: Ankündigung: Neues Leistungsmerkmal - Offline Hilfe System

Verfasst: Do Mai 28, 2020 9:42 am
von StefanW
Dante hat geschrieben: Do Mai 28, 2020 9:06 amOb die Annahme, dass die "Elektriker und Systemintegratoren" oft "nur schlechten oder keinen Internet-Empfang" haben, korrekt ist, kann ich nicht verifizieren.
Das ist keine Annahme, sondern wurde uns so berichtet mit dem Wunsch nach mehr "Offline-Info". Man darf nicht vergessen, dass dies oft Neubauten sind, die zum Teil nur Baustrom haben und noch kein DSL und die Mobilfunkverbindung im Keller ist häufig auch schwierig.

Dante hat geschrieben: Do Mai 28, 2020 9:06 amDas sich hinter dem kleinen (i) so viele Informationen verstecken ist IMHO nicht intuitiv. Ich hab aber zugegebenermaßen grad auch keine Lösung dafür parat.
Das wird der Kunde dann schon schnell lernen, weil wir darauf im Inbetriebnahme-Leitfaden hinweisen werden.

Dante hat geschrieben: Do Mai 28, 2020 9:06 amIch sehe nur bei diesem Thema eine große Gefahr für Redundanz und Inkonsistenz, die im schlimmsten Fall zu mehr Verwirrung bei euren Kunden führt.
Das denke ich nicht. Wir vernetzen in der Offline-Hilfe grundsätzliche Informationen mit Foren-Einträgen und der KnowledgeBase. Solche Verweise erzeugen keine Inkonsistenzen. Zudem wird es künftig von EINEM technischen Redakteur betreut, der sich um den Änderungsdienst kümmert. Wird ein wenig dauern, aber es wird alles bereinigt und vereinheitlicht.

Dante hat geschrieben: Do Mai 28, 2020 9:06 am[*]KnowledgeBase
[*]Wiki (künftig)
Das Wiki wird die KnowledgeBase integrieren. Es wird also eines werden zusammen mit dem Online Handbuch.

Dante hat geschrieben: Do Mai 28, 2020 9:06 amEine Idee wäre, die Offline-Hilfe und KnowledgeBase im Wiki zusammenzuführen
Das passiert ohnehin. Die Texte in der Offline-Hilfe werden auch im Wiki wiederverwendet werden.

Dante hat geschrieben: Do Mai 28, 2020 9:06 amund dieses dann als Offline-Kopie auf dem TWS mittels Update einzuspielen.
Gute Idee, aber vermutlich im ersten Schritt zu aufwändig. Wir verwenden Confluence als Wiki und das wird aufwändig mit einer lokalen Kopie (unmöglich ist es aber nicht).

Dante hat geschrieben: Do Mai 28, 2020 9:06 amUnter den jeweiligen Wiki-Einträgen dann die Abfrage, ob der Eintrag hilfreich und bei Nein eine Abfrage, was nicht gepasst oder gefehlt hat. Weiter dort dann erst der Verweis auf's Forum für weitere Hilfe - damit erstmal versucht wird, sich über das Wiki selbst zu helfen.
Danke. Mal sehen, bitte nicht vergessen, das muss auch finanziert werden am Ende.


lg

Stefan

Re: Ankündigung: Neues Leistungsmerkmal - Offline Hilfe System

Verfasst: Do Mai 28, 2020 9:47 am
von Sun1453
Wie immer eine sehr durchdachte und schön gestaltete Erweiterung.

Ich würde bei den Links aber keine statischen die auf die aktuelle KB verweisen verwenden. Besser Symlinks. Die könnt ihr einfach auf dem Web-Server anpassen und schon sind Sie bei allen geändert.

Bsp: kb.timberwolf.io/belegte_ports_tws -> app.php/kb/viewarticle?a=17

Re: Ankündigung: Neues Leistungsmerkmal - Offline Hilfe System

Verfasst: Do Mai 28, 2020 10:02 am
von Sensej
StefanW hat geschrieben: Do Mai 28, 2020 8:35 am Verehrte Kunden,

mit der "Version V 1.6 Insider Preview 3" werden wir ein neues Leistungsmerkmal präsentieren:


Offline Hilfesystem (im Bereich Management Docker / Portainer)

...
Wir beginnen mit den Hilfetexten für das Management der Docker Container und werden diese Hilfe auf alle Funktionsbereiche des Timberwolf Servers ausdehnen. Wir freuen uns über Eure Rückmeldungen.

lg

Stefan

Hallo Stefan,

ein weiterer Schritt um noch mehr Stabilität in die TWS-Welt zu bringen :clap:

Ist es nicht übersichtlicher für die TWS-Dokumentation einen separaten Menüpunkt zu machen und unter diesen dann alles Mögliches an Hilfetexten, Tipps, technische Informationen usw zu veröffentlichen?
Dieser Menüpunkt muss dann mit max. einen Mausklick oder einer Tasten-Kombi aufgerufen werden.
Ich sehe bei der jetzigen Methode zu viel Aufwand(falls das an weitere Bereiche übertragen werden soll) die ganzen Infos/Texte an unterschiedlichen Stellen zu verwalten und die Navigation zwischen Themen(z.B. Portainer und KNX-Schnittstelle) wird komplexer und unübersichtlich.

MfG Juri