Automatische Zuweisung von Help-IDs

Mit Dr.Explain können Sie jedem Abschnitt numerische IDs (Help Context ID) und textbasierte Aliase zuweisen, um eine kontextsensitive Hilfedatei für Ihre Softwareanwendung zu erstellen. Wenn Sie bereits ein Hilfeprojekt ohne Help Context IDs haben, kann Dr.Explain allen Themen automatisch Help Context ID-Werte zuweisen. Sie müssen lediglich die Vergaberegel festlegen, und Dr.Explain erledigt den Rest.

Eine kontextsensitive Hilfedatei ist komfortabel für den Benutzer, da er keine Suchbegriffe in die Suchleiste eingeben muss, um die benötigten Informationen zu finden.

Wie funktioniert das? Lassen Sie es uns am Beispiel von Dr.Explain verdeutlichen. Angenommen, ein Benutzer hat ein Problem beim Export eines Projekts ins HTML-Format und befindet sich im entsprechenden Dialogfeld des Programms. Ruft er aus diesem Dialog die Hilfe auf, öffnet sich das Handbuch genau auf der Seite, die die Arbeit mit diesem Dialog und die Szenarien für den Projektexport in das Online-Dokumentationsformat erklärt.

Für den Dokumentationsentwickler ist das Werkzeug zur automatischen Zuweisung von Help Context IDs eine hervorragende Möglichkeit, Zeit zu sparen, da er nicht allen Abschnitten der Dokumentation manuell IDs zuweisen muss.

So sieht das Fenster der kontextsensitiven Hilfe aus:

Wie weist man Abschnitten in Dr.Explain automatisch Help Context IDs zu?

Um die Einstellungen für die Help Context ID-Verwaltung beim CHM-Export für das aktuelle Projekt zu ändern, verwenden Sie eine der folgenden Methoden:

• Gehen Sie zum Menü 'Einstellungen' und wählen Sie den Befehl 'Projekteinstellungen';
• oder klicken Sie in der Symbolleiste des Programms auf das Zahnradsymbol.

Wechseln Sie zum Abschnitt 'CHM-Export' / 'Help Context ID-Verwaltung'. Es öffnet sich ein Dialogfeld:

Beispiele für mit Dr.Explain erstellte Benutzerdokumentationen

Dies sind Projekte von Benutzerdokumentationen in verschiedenen Formaten und für die unterschiedlichsten Branchen:

Welche Vorteile bietet die automatische Zuweisung von Help Context IDs?

• Zeitersparnis. Dr.Explain automatisiert die Zuweisung der IDs.
• Ausschluss von Fehlern. Die automatische Zuweisung stellt sicher, dass jeder Abschnitt eine eindeutige ID hat, und vermeidet Tippfehler, die bei manueller Eingabe unvermeidlich sind.
• Sofortige Integrationsbereitschaft. Nach der automatischen ID-Zuweisung können Sie das Projekt sofort zusammen mit der Map-Datei für den Entwickler als CHM exportieren.
• Flexible Konfiguration. Sie legen die Regel oder den Bereich für die ID-Generierung selbst fest, was es ermöglicht, die Hilfe in das bestehende ID-System Ihrer Anwendung einzupassen.
• Transparenz des Prozesses. Sie können die zugewiesenen IDs jederzeit in den Abschnittseigenschaften einsehen und bei Bedarf bearbeiten.

Für wen ist Dr.Explain geeignet?

Dr.Explain eignet sich für Autoren, die auf ein schnelles und qualitativ hochwertiges Ergebnis abzielen. Das Programm ermöglicht die Erstellung professioneller Hilfesysteme, in denen das Lernmaterial als anschauliches, gut strukturiertes und visuell ansprechendes Dokument präsentiert wird. Es ist Ihre Wahl, wenn:

• Sie Entwickler sind und kontextsensitive Hilfe in Ihre Anwendung integrieren. Dr.Explain ermöglicht die schnelle Erstellung einer Dokumentation mit korrekten IDs, ohne dass dies manuell erfolgen muss.
• Sie ein technischer Redakteur sind, der an großen CHM-Hilfeprojekten arbeitet. Bei Hunderten von Seiten löst die Automatisierung dieses Problem.
• Sie Zeit schätzen und Fehler vermeiden möchten. Die Automatisierung monotoner Arbeit ist immer ein Gewinn an Qualität und Geschwindigkeit.

Nutzer über die Arbeit mit Help-IDs in Dr.Explain

'Dr.Explain kam zur Hilfe, indem es den Prozess der Erstellung und Pflege der Benutzerdokumentation vereinfachte und strukturierte. Jetzt können wir uns auf den Inhalt konzentrieren, und die Software hilft beim Rest. Bei Bedarf können wir dasselbe Dokument für verschiedene Medien und in druckfertige Formate exportieren.'

Ali Ataya, Geschäftsführer und Inhaber des Crystaltrack-Programms der Firma Evolusys

Häufig gestellte Fragen (FAQ)

Siehe auch

• Integration der Hilfedatei in die Anwendung
• Erstellung von Help-ID-Map-Dateien
• Kontextsensitive Hilfe