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.
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. Und das ist noch nicht alles! Hier stellen wir Ihnen fünf weitere Schlüsselfunktionen von HelpNDoc vor, die Ihnen das Schreiben Ihrer nächsten technischen Dokumentation erleichtern werden.
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
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. Zum Glück enthält HelpNDoc Scripts zum automatischen Umsortieren der Themen nach Titeln. Im Folgenden erfahren Sie, wie Ihnen das einfach und schnell gelingt
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. Glücklicherweise lässt sich diese Aufgabe mit dem HelpNDoc Hilfe-Entwicklungstool durch variable Platzhalter und ein leistungsstarkes Build-System einfach und schnell durchführen
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
HelpNDoc ist ein leistungsfähiges Hilfe-Entwicklungstool, das mehrere Dokumentationsformate (einschließlich CHM, HTML, Word, PDF, ePub, Kindle, Qt Help) aus einer Hand generieren kann. Es verfügt über ein äußerst leistungsfähiges Vorlagensystem, mit dem Sie das Look-and-Feel der generierten Dokumentation in nahezu allen Einzelheiten anpassen können. Nachdem Sie eine benutzerdefinierte Vorlage erstellt haben, können Sie diese ganz einfach für mehrere Mitarbeiter freigeben oder sichern. Im Folgenden erfahren Sie, wie Ihnen das gelingt
Auch wenn HelpNDocs Hilfe-Entwicklungstool für eine extrem einfache Anwendung entwickelt wurde, ist eventuell einige Hilfe notwendig, um mit der Anwendung zu beginnen oder erweiterte Funktionalitäten zu verstehen. Zum Glück stehen viele Ressourcen in verschiedenen Formaten zur Verfügung, die helfen, die in HelpNDoc verwendeten Begriffe und vorhandenen Funktionen einfach und schnell zu begreifen. Betrachten wir sie im überblick
Wir haben uns bereits angesehen, wie Sie ein YouTube-Video in Ihre CHM- oder HTML-Hilfedateien einbetten können. Auch wenn YouTube eine tolle Plattform zum Teilen von Videos ist, bevorzugen einige Vimeo, einen der wichtigsten Konkurrenten von YouTube. Zum Glück ist das Einfügen eines Vimeo-Videos in Ihre CHM- oder HTML-Hilfedateien mit HelpNDoc äußerst einfach
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... Problematisch kann es jedoch werden, wenn die Elemente auf Ihrer Festplatte oder Ihrem Netzwerkpfad verschoben werden müssen: Um sicherzustellen, dass HelpNDoc Ihre Medienelemente weiterhin finden kann, müssen Sie sie alle der Reihe nach einzeln manuell aktualisieren. Da das eine sehr langwierige, langweilige und fehleranfällige Aufgabe sein kann, ist dies ein großartiger Anwendungsfall für HelpNDoc's leistungsstarken Script-Editor. Sehen wir uns an, wie wir ihn wirksam einsetzen können, um die gesamte Bibliothek in ein paar Sekunden zu aktualisieren
Wir wurden auf FaceBook gefragt, ob es möglich ist, ein Favicon für ein durch HelpNDoc erstelltes HTML-Hilfe-Build zu definieren. Das ist eine großartige Frage, und die Kurzantwort lautet "ja, absolut, dank HelpNDocs leistungsstarkem Vorlagensystem". Schauen wir uns an, wie dies kann gemacht werden kann, indem wir zuerst ein Favicon erstellen und dann unsere eigene benutzerdefinierte Vorlage, die dieses Favicon verwenden wird
