Entdecken Sie eine Fundgrube an unschätzbaren Einblicken und Abkürzungen, um Ihre Fähigkeiten im Umgang mit dem HelpNDoc-Hilfeerstellungswerkzeug zu maximieren. Entdecken Sie verborgene Juwelen, rationalisieren Sie Ihren Arbeitsablauf und schöpfen Sie das volle Potenzial des Werkzeugs aus, indem Sie sich in eine Sammlung von Expertentipps und -tricks vertiefen. Von der Beherrschung fortgeschrittener Formatierungstechniken bis zur Nutzung zeitsparender Funktionen ist dieser Tag Ihr Leitfaden, um ein HelpNDoc-Virtuose zu werden. Verbessern Sie Ihren Dokumentationserstellungsprozess, steigern Sie die Effizienz und erstellen Sie mit Leichtigkeit ausgefeilte, professionelle Hilfeinhalte. Erforschen Sie den Abschnitt Tipps und Tricks und begeben Sie sich auf die Reise, ein HelpNDoc-Maestro zu werden.
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.
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.
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.
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.
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.
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.
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.
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. Glücklicherweise kann HelpNDocs Scripting-Unterstützung den Status Ihres gesamten Dokumentationsprojekts im Bruchteil einer Sekunde aktualisieren. Im Folgenden erfahren Sie, wie Ihnen das gelingt.
HelpNDoc verfügt über einen äußerst leistungsfähigen Vorlagenprozessor, mit dem Sie beliebige Abschnitte Ihrer erstellten Dokumentation anpassen können. Meistens werden Sie die Standardvorlage des Dokumentationsformats, das Sie anpassen möchten, als Ausgangspunkt verwenden. Wenn jedoch eine neue Version von HelpNDoc veröffentlicht wird, kann die Standardvorlage durch neue Funktionen und Fehlerbehebungen weiterentwickelt worden sein, sodass Sie diese Änderungen eventuell in Ihre benutzerdefinierten Vorlagen übernehmen möchten. Dies ist möglich, indem Sie die aktualisierte Standardvorlage mit Ihrer eigenen Vorlage vergleichen und zusammenführen. Hier erklären wir Ihnen eine Methode, mit der Ihnen diese Aufgabe problemlos und zuverlässig gelingt
Ein Hilfe-Entwicklungstool wie HelpNDoc ist gewöhnlich eine Software, mit der man Inhalte zur Erstellung von Dokumentationsdateien für Endbenutzer schreiben und gliedern kann. Wenn Revisionen erforderlich sind, müssen die Inhalte übersichtlich bleiben, sodass in der Regel etliche mühsame und fehleranfällige Aufgaben wie etwa Kopieren/Einfügen von Inhalten, Löschen von Inhalten und Verschieben und Zusammenführen von Themen im gesamten Projekt erforderlich sind. Glücklicherweise bietet HelpNDoc einen leistungsstarken Scripting-Prozessor, der eine automatische Erstellung, Pflege und Neugliederung von Dokumenten ermöglicht. Hier zeigen wir Ihnen, wie Sie HelpNDocs Scripting-Fähigkeiten zum Zusammenführen mehrerer untergeordneter Themen in ein übergeordnetes Thema nutzen können
