Wie implementiere ich Hilfe für eine Java EE-Webanwendung für Endbenutzer?

Question

Ich versuche den besten Weg zu finden, um Hilfe zu einer Java EE Webanwendung hinzuzufügen. Ich lese, dass .chm-Dateien veraltet sind und aufgrund von Sicherheitsproblemen in Windows nicht verwendet werden sollten. Auf die Site wird nur in einem privaten LAN über einen Webbrowser zugegriffen.

Es klingt Art der alten Schule, aber ich dachte, dass ich nur den HTML schreiben würde und Hyperlinks haben, um zu dem Abschnitt der Seite zu springen, wo der relevante Inhalt ist.

Ich frage mich, ob nur eine normale alte HTML-Seite funktioniert? Ist das in Ordnung für Unternehmen? Gibt es irgendwelche Standards oder Softwareprogramme, die mit einem Inhaltsverzeichnis und einer Liste von Hilfeartikeln helfen?

Die Benutzer müssen natürlich in der Lage sein, schnell und einfach Hilfe zu haben, wenn sie Fragen zu einer bestimmten Seite haben. Könnte ich einige Arten von Tooltips implementieren, die in Java EE oder anders geschrieben sind und die schneller als eine HTML-Seite laden würden?

Answer 1

Sie können einen HILFE-Link in Ihrer gesamten Anwendung haben. Wenn Sie darauf klicken, wird ein einfaches Browserfenster geöffnet, in dem der Inhalt der Hilfe angezeigt wird. Einfaches Browserfenster bedeutet keine Navigationsschaltflächen, so dass Benutzer dieses Fenster nicht verwenden, um ihre Arbeit fortzusetzen, was problematisch sein kann. Dies wird sie zwingen, das Fenster einfach zu schließen, wenn sie damit fertig sind.

Der Inhalt der Hilfe kann einfach HTML oder dynamisch (.jsp) sein, je nachdem, wie komplex die Hilfestruktur ist. Vorteil von jsp ist, dass der Inhalt dynamisch aus einer Datenbank bedient werden kann und Sie das Inhaltsverzeichnis serverseitig erstellen können, also besser für größere Hilfeinhalte geeignet sind.

Der Hilfe-Link kann je nachdem, auf welcher Seite Sie sich befinden, angepasst werden, sodass Benutzer direkt zur entsprechenden Hilfe weitergeleitet werden. Dies kann mit Abfragezeichenfolgen geschehen, zum Beispiel help.html # abc oder help.jsp? Topic = abc, um Benutzer direkt zum Thema abc zu bringen.

Zusätzlich zu den vollständigen Hilfeseiten können Sie auch Inline-Tooltips für einzelne Felder haben. Fügen Sie neben der Feldbeschriftung ein kleines Fragezeichensymbol hinzu, das beim Bewegen oder Klicken auf eine kurze Information zu diesem bestimmten Feld angezeigt wird.

Ein gutes Beispiel für diesen Tooltipp ist, was Sie neben dem CVV-Feld auf verschiedenen Kreditkarten-Zahlungsseiten finden können.

Hoffe, dass hilft.