Integration der Hilfedatei in die Anwendung

Eine Hilfedatei ist ein 'Leitfaden' innerhalb eines Programms, der es ermöglicht, sofort Antworten auf Fragen zu erhalten, ohne im Internet suchen oder den Support kontaktieren zu müssen. Sie ist im Programm sogar ohne Internetverbindung verfügbar. Sie bietet eine komfortable Navigation durch die Abschnitte, ein Inhaltsverzeichnis, ein Stichwortverzeichnis und eine Volltextsuche. Mit Dr.Explain können Sie eine Hilfedatei im CHM-Format für Windows-Anwendungen erstellen – ganz ohne spezielle Kenntnisse.

Was ist eine Hilfedatei?

Eine Hilfedatei ist ein Benutzerhandbuch im CHM-Format mit strukturierten Informationen über eine Anwendung. CHM ist ein spezielles Format in Windows-Betriebssystemen zur Erstellung kontextsensitiver Hilfe in Anwendungen.

Einige Vorteile des Formats:

• Die Volltextsuche erleichtert das Auffinden der benötigten Informationen;
• Es können Lesezeichen für den schnellen Zugriff erstellt werden;
• Bilder, Videos, Audio und andere Multimedia-Elemente können eingebettet werden, was die Anschaulichkeit der Dokumentation erhöht;
• Die Unterstützung von Hyperlinks zwischen Abschnitten verbindet inhaltlich zusammenhängende Informationen und erleichtert das Verständnis des Materials;
• Die Möglichkeit, JavaScript für interaktive Elemente wie Aufklapplisten, Formulare oder dynamische Inhaltsaktualisierungen zu nutzen.

Dr.Explain macht die Erstellung und Integration einer Hilfedatei zu einem einfachen und vorhersehbaren Prozess. Sie konzentrieren sich auf den Inhalt, während das Programm den technischen Teil übernimmt – vom Layout bis zur Kompatibilität mit Ihrer Anwendung. Das beschleunigt nicht nur die Veröffentlichung der Dokumentation, sondern macht sie auch für die Endbenutzer maximal nützlich.

Beispiel für das Fenster einer mit Dr.Explain erstellten Hilfedatei:

Was bedeutet Integration einer Hilfedatei?

Die Integration einer Hilfedatei bedeutet, dass Sie die Dokumentation mit Ihrem Programm verknüpfen können. Wenn der Benutzer dann mit Ihrer Anwendung arbeitet, kann er kontextsensitive Hilfe aufrufen und erhält direkt im Programm Antworten auf auftretende Fragen.

Welche Vorteile bietet der Integrationsmechanismus in Dr.Explain?

Vorteile für den Benutzer

Kontextsensitive Hilfe beschleunigt und erleichtert das Auffinden der benötigten Informationen. Ein Beispiel für kontextsensitive Hilfe sehen Sie in Word: Wenn Sie sich in einem bestimmten Abschnitt oder Dialogfeld von Word befinden und F1 drücken, öffnet sich die Hilfe, die mit dem aktuellen Kontext verknüpft ist.

Vorteile für den Entwickler

Bei der Entwicklung eines Softwareprodukts kann der Entwickler Hilfekontext-IDs in den Eigenschaften der grafischen Benutzeroberflächenelemente des Programms angeben: Dialogfelder, Schaltflächen, Listen, Parameter und andere Steuerelemente. Nach der Kompilierung kann das Programm dann für jedes Oberflächenelement den entsprechenden Hilfetext basierend auf seiner ID anzeigen.

Beispiele für mit Dr.Explain erstellte Hilfedateien

Hier sind einige Beispiele für kontextsensitive Hilfe für Anwendungen, die mit Dr.Explain erstellt wurden.

Welche Vorteile bieten sich Ihnen?

Zeitersparnis. Ohne spezielle Kenntnisse erstellen und integrieren Sie mithilfe automatisierter Werkzeuge eine Hilfedatei in Ihre Anwendung.

Komfort für den Benutzer. Benutzer können Hilfe und Antworten auf ihre Fragen direkt in der Anwendung finden, in die die Hilfedatei integriert ist.

Komfortable Navigation. Das Inhaltsverzeichnis ermöglicht ein schnelles Auffinden der benötigten Informationen. Das Stichwortverzeichnis erleichtert die Suche nach Schlüsselwörtern. Die Volltextsuche hilft bei der Antwortfindung, und Lesezeichen bieten die Möglichkeit, häufig genutzte Seiten für den Schnellzugriff zu speichern.

Offline-Nutzung. Eine CHM-Datei benötigt keine Internetverbindung für die Anzeige, was sie für den Einsatz im Offline-Modus praktisch macht.

Für wen ist Dr.Explain geeignet?

Dr.Explain ist universell einsetzbar: Es eignet sich für große Unternehmen, die ihr Produkt um eine qualitativ hochwertige, professionelle Wissensdatenbank ergänzen möchten, ebenso wie für kleinere Organisationen, die ein erschwingliches, aber sehr effektives Werkzeug benötigen.

• Entwicklern von Windows-Anwendungen, die ihrem Programm eine professionelle kontextsensitive Hilfe hinzufügen möchten.
• Technischen Redakteuren, die eine CHM-Datei erstellen müssen.
• Allen, die die Offline-Nutzung durch ihre Benutzer schätzen. Wenn Ihre Software häufig ohne Internet verwendet wird, ist eine eingebettete CHM-Datei die ideale Lösung.

Nutzer über die Integrationswerkzeuge in Dr.Explain

'Wir sind mit unserer aktuellen Hilfedokumentation und der Integration in unsere Werkzeuge sehr zufrieden. Jetzt können wir in jedem Dialog oder Bedienfeld unseres Programms auf 'Hilfe' klicken und die entsprechende Seite in der Dokumentation öffnen. Ich denke, wir werden uns in Zukunft hauptsächlich darauf konzentrieren, mehr Videos zu erstellen und diese direkt in die Dokumentation einzubetten.'

Are Tømmerås, Senior-Geologe der Firma Migris

'Bei der Bewertung und dem Vergleich moderner Alternativen zur Erstellung von CHM-Dateien hat Dr.Explain hervorragende Ergebnisse gezeigt. Die Software verbindet einen angemessenen Preis mit einem vollständigen Funktionsumfang.'

Joe Evans, Firma Radiant Technologies

'Mit Dr.Explain haben wir nicht nur ein kontextsensitives Hilfesystem erstellt, sondern es auch benutzerorientiert gestaltet. Auf diese Weise stellen wir quasi unterschiedliche Hilfesysteme basierend auf den Benutzerrechten bereit.'

Robert Sibilski, Geschäftsführer und leitender Programmierer der Firma Siborsoft

Häufig gestellte Fragen (FAQ)

Siehe auch

• Erstellung von Help-ID-Map-Dateien
• Automatische Zuweisung von Help-IDs
• Kontextsensitive Hilfe