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 →

Automatisches Zusammenführen mehrerer Themen Ihrer Dokumentation zu einem einzigen Thema mithilfe eines Skripts

Automatisches Zusammenführen mehrerer Themen Ihrer Dokumentation zu einem einzigen Thema mithilfe eines Skripts
Kategorien: artikel

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.

Mehr lesen →

Schnelles Hinzufügen eines Logos und benutzerdefinierten CSS- und JavaScript-Codes in Ihre HTML-Dokumentationsdateien

Schnelles Hinzufügen eines Logos und benutzerdefinierten CSS- und JavaScript-Codes in Ihre HTML-Dokumentationsdateien
Kategorien: artikel

Das Schreiben einer Online-Hilfedatei, eines Benutzerhandbuchs, eines E-Books oder eines anderen durch HelpNDoc bearbeiteten Formats ist in der Regel ein langwieriger und nicht geradliniger Prozess. Mit zunehmender Entwicklung des Inhalts ist die übergreifende Themenhierarchie oft nicht mehr optimal, sodass eine Neugliederung erforderlich ist, um die Dokumentation einfacher lesbar und navigierbar zu machen. Obwohl HelpNDoc einige Tools zur einfachen Neugliederung des Inhaltsverzeichnisses bietet, kann dieser Vorgang mitunter langwierig und fehleranfällig sein, beispielsweise wenn eine alphabetische Themensortierung erforderlich ist.

Mehr lesen →

Anwendung von HelpNDocs Scripting-Fähigkeiten zum automatischen Zurücksetzen aller Hilfe-Kontext-Nummern

Kategorien: artikel

HelpNDoc beinhaltet einen äußerst leistungsstarken Skript-Editor mit Zugriff auf mehrere API-Methoden, mit dem Sie nahezu alle Aspekte der Erstellung und Wartung Ihrer Dokumentationen automatisieren können. Wir haben uns bereits angesehen, wie Sie HelpNDocs Scripting-Fähigkeiten zum Automatisieren der Erstellung von Hilfe-Dokumentationen, zum Aktualisieren des Pfads externer Medienelemente, die verschoben wurden, und zum Exportieren von Hilfe-IDs und Hilfe-Kontext-Nummern für Ihre Entwickler verwenden können. Hier erklären wir Ihnen, wie Sie ein praktisches Skript zum automatischen Zurücksetzen der Hilfe-Kontext-Nummern für alle Themen eines Dokumentationsprojekts erstellen können.

Mehr lesen →

Einfaches Aktualisieren des Pfads Ihrer externen Medienelemente, wenn diese verschoben wurden

Kategorien: artikel

Sie können entscheiden, wie Ihre Bibliothekselemente (Bilder, Filme, Dokumente…) durch HelpNDoc gehandhabt werden: Sie können in Ihrem Projekt enthalten sein oder dynamisch zum Zeitpunkt der Generierung, wenn Sie Ihre endgültigen Dokumentationsdateien erstellen, eingefügt werden. Wenn Sie die zweite Option verwenden, bestimmen Sie einen Pfad für Ihre Medienelemente, sodass HelpNDoc die Elemente bei Bedarf finden und einfügen kann. Dies ist sehr nützlich, um die Elemente von außerhalb von HelpNDoc bearbeiten zu können, mit einer Drittsoftware zu teilen…

Mehr lesen →

Hilfe-ID’s und Hilfe-Kontext-Nummern für ihre Entwickler exportieren

Kategorien: artikel

Sobald Sie Ihre Hilfe-Datei oder Dokumentations-Webseite verfasst haben, möchten Sie diese sicherlich mit bereits existierenden Produkten integrieren: Falls ein Nutzer Schwierigkeiten dabei hat eine Handlung auszuführen, kann dieser die Hilfedatei aufrufen und wird umgehend zum korrekt assoziierten Thema geleitet, welches die Handlung erklärt. Aus diesem Grund bieten die Hilfeentwicklungstools, wie HelpNDoc, für jedes Thema zwei einmalige Identifikatoren: Eine alphanumerische Hilfe-ID und eine numerische Hilfe-Kontext-Nummer. Dies ermöglicht den Zugriff auf ein spezifisches Thema von einer Software-Applikation oder Webseite aus.

Mehr lesen →

Mit Scripts die Erstellung von Hilfe-Dateien und Dokumentationen automatisieren

Kategorien: artikel

HelpNDoc ist dermaßen benutzerfreundlich, dass es möglich ist, innerhalb kürzester Zeit, eine vollständige Dokumentation in mehreren Formaten und für mehrere Geräte zu produzieren. Dies ist sogar schon wenige Minuten nach dem Downloaden und dem ersten Austesten von HelpNDoc möglich und zwar dank der intuitiven Benutzeroberfläche und dem Themen-Editor, der Microsoft Word sehr ähnelt. HelpNDoc ist extrem Leistungsstark und bietet seinen Nutzern viele fortschrittliche Instrumente, um die Erstellung von fantastischen Hilfe-Dateien und Handbüchern zu vereinfachen und zu beschleunigen.

Mehr lesen →