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 →

So migrieren Sie eine benutzerdefinierte Vorlage, wenn eine neue Version von HelpNDoc veröffentlicht wird

So migrieren Sie eine benutzerdefinierte Vorlage, wenn eine neue Version von HelpNDoc veröffentlicht wird
Kategorien: artikel

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.

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 →

5 Schlüsselfunktionen von HelpNDoc, die Ihnen die Dokumentenerstellung vereinfachen

5 Schlüsselfunktionen von HelpNDoc, die Ihnen die Dokumentenerstellung vereinfachen
Kategorien: artikel

HelpNDoc ist eine marktführende benutzerfreundliche Hilfe-Entwicklungssoftware mit dem Ziel, das technische Schreiben einfacher zu machen. Um die Benutzerfreundlichkeit und andere Funktionen nicht nur für technische Redakteure, sondern auch für Autoren zu verbessern, wurde die Software im Laufe der Jahre mehreren Entwicklungsphasen unterzogen. Derzeit ist die HelpNDoc-Software weithin für verschiedene benutzerfreundliche Funktionen und insbesondere für ihre Fähigkeit zum Erstellen mehrerer unterschiedlicher Dateiformate aus nur einer Quelldatei bekannt: Sie können zwischen plattformübergreifenden Qt-Help-Dateien, webbasierten HTML5-Dokumentationen, standardmäßigen Windows-CHM-Hilfedateien, druckbaren PDF- und Word-Dokumenten, ePub- und Kindle-E-Books sowie iPhone-spezifischen Websites wählen.

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

HelpNDocs erstaunlich reaktionsschneller Prozess zur Generierung von HTML-Websites kann zum Hinzufügen eines Logos, maßgeschneiderten CSS- und JavaScript-Codes, übersetzter Strings etc. angepasst werden. Hier zeigen wir Ihnen, wie Sie mit HelpNDoc eine wirklich individuelle HTML-Dokumentationswebsite einfach und schnell erstellen können. Hinzufügen eines benutzerdefinierten Logos zur Bibliothek des Projekts Die Bibliothek umfasst alle wiederverwendbaren Medienelemente (Bilder, Filme, Dokumente etc.), die für das Projekt zur Verfügung stehen. Das Hinzufügen eines gewünschten Logo-Bilds zur Bibliothek des Projekts erfordert nur ein paar einfache Schritte:

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 →

Verwenden Sie variable Platzhalter, um Dokumentationen für verschiedene Kulturen herzustellen

Verwenden Sie variable Platzhalter, um Dokumentationen für verschiedene Kulturen herzustellen
Kategorien: artikel

Bei der Anfertigung einer Hilfedatei, einer Bedienungsanleitung oder eines E-Books ist es nicht nur wichtig, Übersetzungen für eine bestimmte Zielgruppe anzubieten, sondern auch die je nach der Sprache der Leser richtigen Begriffe zu verwenden. Betrachten wir zum Beispiel den englischen Begriff für Farbe, “colour”: “color” ist die bevorzugte Schreibweise im amerikanischen Englisch, während in allen anderen wichtigen Varianten des Englischen “colour” bevorzugt wird. Da sichergestellt werden muss, dass die gesamte Dokumentation fehlerfrei ist, kann die Unterstützung mehrerer Sprachvarianten zu Komplikationen und zusätzlicher Arbeit für technische Redakteure führen.

Mehr lesen →