Rat, Vorschläge und Ideen zur Entwicklung und Verbesserung des Schreibens und der Anfertigung von Hilfedateien und Handbüchern.

Erstellen einer RTF-Datei (Rich Text Format-Datei) aus Ihrem Dokumentationsprojekt mit dem Hilfe-Entwicklungstool HelpNDoc

Erstellen einer RTF-Datei (Rich Text Format-Datei) aus Ihrem Dokumentationsprojekt mit dem Hilfe-Entwicklungstool HelpNDoc
Kategorien: Artikel

Obwohl das Microsoft Rich Text Format (RTF) als ein veraltetes Dokumentformat betrachtet werden kann, wird es durch ausreichend viele Software und Betriebssysteme unterstützt, um als äußerst portabel und als eine gute Wahl für den plattformübergreifenden Dokumentenaustausch angesehen zu werden. Dank des Hilfe-Entwicklungstools HelpNDoc können Sie Ihre Dokumentationsprojekte nicht nur als Microsoft Word DocX-Dokumente, sondern auch als uneingeschränkt gültige RTF-Dokumente erstellen, sodass Sie eine große Auswahl an Optionen zur Generierung von Dokumentformaten haben.

Mehr lesen →

Kontextsensitive HTML Help- und URL-Aliasse für Hilfethemen in Ihren HTML-Dokumentationswebsites

Kontextsensitive HTML Help- und URL-Aliasse für Hilfethemen in Ihren HTML-Dokumentationswebsites
Kategorien: Artikel

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.

Mehr lesen →

3 Möglichkeiten für eine schnellere Erstellung von Hyperlinks in Ihrer Hilfedatei, Ihrem Benutzerhandbuch oder E-Book

3 Möglichkeiten für eine schnellere Erstellung von Hyperlinks in Ihrer Hilfedatei, Ihrem Benutzerhandbuch oder E-Book
Kategorien: Artikel

Technische Autoren verbringen viel Zeit damit, sicherzustellen, dass der Text, den sie schreiben, relevant, verständlich und präzise ist, sodass sie für gängige Aufgaben wie das Erstellen von Hyperlinks keine Zeit mit der Nutzung ihrer bevorzugten Hilfe-Entwicklungssoftware verschwenden sollten. Glücklicherweise bietet das Hilfe-Entwicklungstool HelpNDoc mehrere Möglichkeiten für eine schnellere Erstellung von Hyperlinks, sodass technische Autoren ihre Zeit mit dem verbringen können, was für sie am wichtigsten ist: das Schreiben großartiger Textinhalte.

Mehr lesen →

Definieren von robots.txt und Robots-Meta-Tags in Ihrer HTML-Dokumentation

Definieren von robots.txt und Robots-Meta-Tags in Ihrer HTML-Dokumentation
Kategorien: Artikel

Technische Autoren können in ihrer HTML-Dokumentation eine spezielle robots.txt-Datei verwenden oder Robots-Meta-Tags definieren, um festzulegen, wie populäre Suchmaschinen wie Google oder Bing einzelne Seiten in den Suchergebnissen indizieren und ausliefern sollen. In diesem Artikel werden Sie erfahren, wie Sie die durch das Hilfe-Entwicklungstool HelpNDoc bereitgestellte Standard-HTML-Vorlage aktualisieren können, um eine robots.txt-Datei zu generieren, einen projektweiten Standardwert für das Robots-Meta-Tag anzugeben und dessen Inhalt auf bestimmten Dokumentationsseiten zu überschreiben. Der Artikel wurde durch einen Code des HelpNDoc-Benutzers Keith Phillips angeregt, dem wir für seinen Beitrag an dieser Stelle danken möchten.

Mehr lesen →

Verwalten der HelpNDoc-Bedienungsfelder durch benutzerdefiniertes Verschieben und Verankern

Verwalten der HelpNDoc-Bedienungsfelder durch benutzerdefiniertes Verschieben und Verankern
Kategorien: Artikel

HelpNDocs beeindruckende Benutzeroberfläche wurde sorgfältig mit dem Ziel einer möglichst großen Übersichtlichkeit und Benutzerfreundlichkeit entwickelt. HelpNDoc bietet die zum möglichst schnellen und effektiven Schreiben und Erstellen von Hilfedateien, Benutzerhandbüchern und E-Büchern erforderlichen Mindestfunktionen sowie erweiterte Funktionen für versierte Anwender wie beispielsweise die Möglichkeit zum benutzerdefinierten Verschieben, Skalieren und Platzieren der Bedienungsfelder. Im diesem Artikel erfahren Sie, wie Sie die HelpNDoc-Bedienungsfelder verwalten können. Einblenden, Ausblenden und Skalieren der Bedienungsfelder Für die aktuelle Aufgabe nicht relevante Bedienungsfelder können zur Maximierung des Bildschirmbereichs wahlweise aus- und eingeblendet sowie skaliert werden.

Mehr lesen →

So aktualisieren Sie die Symbole des Inhaltsverzeichnisses Ihrer HTML-Dokumentation

So aktualisieren Sie die Symbole des Inhaltsverzeichnisses Ihrer HTML-Dokumentation
Kategorien: artikel

Die Erstellung möglichst vollständiger, umfassender und aktueller Dokumentationen hat bei technischen Redakteuren oberste Priorität. Die Leser erwarten zudem ein sauberes und modernes Design, und die Unternehmen müssen häufig Dokumentationswebsites in ihr bestehendes Material integrieren und so ein vorgegebenes Look-and-Feel nachahmen. Glücklicherweise können Sie Ihre Inhalte mit dem HelpNDoc-Hilfe-Entwicklungstool schnell durch ein hinzugefügtes Logo oder einen CSS-Code oder vollständig durch das Erstellen einer komplett neuen Vorlage anpassen. In diesem Artikel erklären wir Ihnen, wie Sie benutzerdefinierte Symbole im Inhaltsverzeichnis der generierten HTML-Dokumentation verwenden können.

Mehr lesen →

So können Sie eine automatisierte Dokumentationserstellung planen

So können Sie eine automatisierte Dokumentationserstellung planen
Kategorien: artikel

Technische Redakteure müssen häufig Dokumentationen, Handbücher oder Hilfe-Websites erstellen und diese dann mit Teammitgliedern teilen oder ihren Endnutzern bereitstellen. Dies kann ein zeitaufwändiger Prozess sein, der Sorgfalt und Aufmerksamkeit erfordert, um sicherzustellen, dass die korrekte Version regelmäßig erstellt wird. Glücklicherweise kann das Hilfe-Entwicklungstool HelpNDoc zur Durchführung einer geplanten Dokumentationserstellung automatisiert werden. Im Folgenden erfahren Sie, wie Ihnen das gelingt. Anwendung von HelpNDocs Kommandozeilenschnittstelle Sie können HelpNDocs Vorgang zur Dokumentationserstellung durch eine Eingabeaufforderung oder PowerShell-Eingabeaufforderung zur Erstellung aller durch das Hilfe-Entwicklungstool unterstützten Formate automatisieren.

Mehr lesen →

Identifizieren und Reparieren defekter Hyperlinks in Ihren Benutzerhandbüchern, E-Büchern und Hilfedateien

Identifizieren und Reparieren defekter Hyperlinks in Ihren Benutzerhandbüchern, E-Büchern und Hilfedateien
Kategorien: artikel

Technische Redakteure nutzen Hyperlinks zur Gliederung und für Verweise auf verschiedene Abschnitte ihrer gedruckten Benutzerhandbücher, E-Bücher oder Hilfedateien. Aktuelle Hyperlinks sind insofern äußerst wichtig, als dass defekte Links den Lernfluss der Endbenutzer unterbrechen können. Endbenutzer, die erforderliche Informationen aufgrund fehlerhafter Hyperlinks nicht finden können, fühlen sich mitunter überfordert und wenden sich an den Kundendienst, was zu zusätzlichen Kosten für die Kundenbetreuung führt. Glücklicherweise bietet das Hilfe-Entwicklungstool HelpNDoc einen einfachen Hyperlink-Analysator, der technische Redakteure hinsichtlich einer schnellen Identifizierung und Reparatur problematischer Hyperlinks unterstützt.

Mehr lesen →

Erstellen einer neuen HTML-Vorlage zur Anpassung Ihrer Online-Dokumentationsprojekte

Erstellen einer neuen HTML-Vorlage zur Anpassung Ihrer Online-Dokumentationsprojekte
Kategorien: artikel

Die vor Kurzem veröffentlichte neue Version von HelpNDoc (HelpNDoc 6.4) bietet eine verbesserte einseitige HTML-Vorlage mit der Sie Ihrer generierten einseitigen HTML-Dokumentation ein Inhaltsverzeichnis hinzufügen können. Wir haben diese einseitige Vorlage mit HelpNDocs leistungsfähigem Vorlagen-Editor modifiziert und denken, dass es eine gute Idee ist, diesen Vorgang zu Lernzwecken zu dokumentieren. Befolgen Sie die in diesem Artikel beschriebenen Schritte, um zu erfahren, wie Sie Ihre HTML-basierten Dokumentationsvorlagen mit den in HelpNDoc integrierten Tools erstellen und ändern können.

Mehr lesen →

Massenbearbeitung des Status aller Themen Ihres Dokumentationsprojekts

Massenbearbeitung des Status aller Themen Ihres Dokumentationsprojekts
Kategorien: Artikel

“HelpNDoc 6.0 bietet eine bessere Unterstützungsfunktion für den Status von Themen, die technischen Redakteuren die Pflege ihrer Dokumentationsprojekte deutlich erleichtert: Die Themen können als “Veraltet”,“In Bearbeitung”,“Zu überprüfen”,“Vollständig” oder mit einem anderen benutzerdefinierten Status markiert werden. Sie können diese Funktion zur Aktualisierung eines alten Projekts nutzen, um zum Beispiel den Status aller Themen als “Zu überprüfen” zu markieren und die Themen anschließend der Reihe nach zu überarbeiten. Das Aktualisieren jedes einzelnen Themas in einem großen Projekt kann jedoch recht zeitaufwändig sein.

Mehr lesen →