Das HTML-Dokumentationsformat ist eines der wichtigsten durch das HelpNDoc-Hilfeentwicklungstool erstellten Hilfedateiformate: Für einen schnellen Zugriff auf On-demand-Dokumentationen können die voll funktionsfähigen Dokumentationswebsites auf jedem Webserver gehostet werden und vereinfachen somit die Kundennähe und Arbeit des Kundendiensts. Kundendienstmitarbeiter müssen zur Erklärung spezifischer Aufgaben häufig kontextsensitive URLs mit Kunden teilen, diese sind jedoch oft zu lang und schwer zu erinnern und einzutippen. Glücklicherweise können alle in HelpNDoc erstellten Themen eine unbegrenzte Anzahl von URL-Aliassen haben: Sehen wir uns an, wie sie in HelpNDocs Benutzeroberfläche definiert werden können.
Kontextsensitives HTML Help
Jedes durch HelpNDocs Standardvorlage erstellte Thema ist kontextsensitiv: Es hat eine eindeutige URL, die für den Zugriff auf dieses spezifische Thema freigegeben werden kann.
Der HTML-Dokumentationsgenerator von HelpNDoc verwendet die Hilfe-ID-Eigenschaft jedes Themas zur Erstellung seines eindeutigen Dateinamens. So kann beispielsweise ein Thema mit einer als MeinBeispielthema definierten Hilfe-ID, das auf der Domäne https://beispiel.de gehostet wird, über die URL https://beispiel.de/MeinBeispielthema.html aufgerufen werden.
Darüber hinaus kann die Hilfe-Kontext-Eigenschaft des Themas für einen direkten Zugriff auf das Thema verwendet werden. Auf ein Thema mit einer Kontextnummer von 42 kann bei Verwendung desselben beispielhaften Domänennamens https://beispiel.de über die URL https://beispiel.de/kontext/42.html zugegriffen werden.
Definieren von Themen-Aliassen
Einige Themen sind beliebter als andere, und ihre Benennung mit einem leicht zu merkenden Alias kann die Kundenbetreuung erheblich beschleunigen und die Benutzererfahrung verbessern.
Nachdem ein Thema im Inhaltsverzeichnis von HelpNDoc ausgewählt wurde, können seine verschiedenen Aliasse im Fenster “Eigenschaften des Themas” definiert werden:
- Klicken Sie neben
Aliasseauf das Editorfeld der Eigenschaft, um die Schaltfläche “…” anzuzeigen, - klicken Sie auf die Schaltfläche “…”, um den “Listeneditor” zu öffnen,
- klicken Sie im “Listeneditor” auf “Dazufügen”, und geben Sie einen Namen ein, um ein neues Alias für dieses Thema hinzuzufügen,
- fügen Sie so viele Aliasse wie nötig hinzu und klicken Sie dann auf “OK”, um den “Listeneditor” zu schließen.
Nachdem die HTML-Dokumentationswebsite durch HelpNDoc generiert wurde, wird dieses Thema über jedes dieser Aliasse zugänglich sein.
Beispielsweise kann das Thema “FAQs und Fehlerbehebung” die folgenden Aliasse haben, die alle zum richtigen Thema weiterleiten:
/faq.htmlerstellt das Aliashttps://beispiel.de/faq.html,/faq/index.htmlerstellt die Aliassehttps://beispiel.de/faq/undhttps://beispiel.de/faq/index.html,/fehlerbehebung.htmlerstellt das Aliashttps://beispiel.de/fehlerbehebung.html,/fehlerbehebung/index.htmlerstellt die Aliassehttps://beispiel.de/fehlerbehebung/undhttps://beispiel.de/fehlerbehebung/index.html.
Dank seiner leistungsstarken HTML-Generierungsfunktionen ist HelpNDoc das perfekte Hilfe-Entwicklungstool zur Erstellung von wahrhaft benutzerfreundlichen Dokumentationswebsites mit erweiterten Funktionen wie kontextsensitiven URLs und unbegrenzten Themenaliassen. Laden Sie sich Ihre kostenlose Version jetzt herunter, um HelpNDoc selbst auszuprobieren.
Das könnte Sie auch interessieren...
Inhaltsaktualisierungen mit HelpNDocs Such- und Ersetzungsfunktionen für technische Redakteure
Haben Sie es satt, Ihre Dokumentationen ständig mühevoll konsistent, aktuell und fehlerfrei zu halten? Für technische Redakteure und Content-Autoren kann die Bewältigung dieser Herausforderungen eine …
Mehr lesen →
Transformieren Sie Ihren Unterrichtsraum mit HelpNDoc: Das ultimative Tool zur Unterstützung von Lehrkräften und Lernenden zu Beginn des neuen Lehrjahres
Angesichts des Beginns des neuen Lehrjahres sind Lehrkräfte und Lernende auf der Suche nach Hilfsmitteln, die die Inhaltserstellung vereinfachen, die Zusammenarbeit verbessern und die Lernerfahrung …
Mehr lesen →
Anpassen der Ausgangsposition und -größe von CHM-Hilfedateien
Die Erstellung von CHM-Dateien (kompilierten HTML-Hilfedateien) mit HelpNDoc ist dank der benutzerfreundlichen Oberfläche und leistungsstarken Funktionen ein Kinderspiel. In diesem Artikel erfahren …
Mehr lesen →
Balance zwischen Sicherheit und Benutzerfreundlichkeit: Die besten Dokumentationsformate für die interne Freigabe
Die effektive und sichere Freigabe von Dokumenten ist in modernen Arbeitsumgebungen von entscheidender Bedeutung. Egal, ob Sie Handbücher, Projektdokumentationen oder Unternehmensrichtlinien intern …
Mehr lesen →