PHP ist eine leistungsstarke serverseitige Skriptsprache, die seit Jahrzehnten ein wichtiges Tool für die Webentwicklung ist. Mit der Fähigkeit zur dynamischen Erstellung von Inhalten, Verbesserung der Benutzererfahrung, Handhabung von Sicherheitseinschränkungen, Erhöhung der Interaktivität und Erfassung von Benutzerdaten ist PHP eine ausgezeichnete Ergänzung für Online-Benutzerdokumentationen. Dank des leistungsstarken und vielseitigen Vorlagensystems von HelpNDoc sind diese Vorteile jetzt leicht zu erreichen: In diesem Artikel werden wir besprechen, wie die Integration von PHP in Online-Benutzerdokumentationen die Benutzererfahrung verbessern und eine bessere Interaktion und ein besseres Feedback bieten kann.
CHM Hilfedateien werden zur Bereitstellung von Online-Hilfen und -Dokumentationen für Softwareanwendungen, Plugins oder Treiber verwendet und häufig mit Windows-Installationsprogrammen verteilt. Programme von Drittanbietern wie HelpNDoc sind spezielle Tools für die Erstellung von Hilfeinhalten, mit denen die Erstellung einer CHM-Hilfedatei einfacher und schneller vonstattengehen kann. Die Anwendung eines Drittanbieterprogramms zur Erstellung einer CHM-Hilfedatei kann im Vergleich zum integrierten HTML Help Workshop von Microsoft mehrere Vorteile bieten, da diese Programme eine benutzerfreundliche grafische Oberfläche, leistungsstarke Funktionen und zeitsparende Tools sowie eine größere Flexibilität bieten, die das Erstellen einer professionellen CHM-Hilfedatei einfacher und effizienter macht.
Wenn es darum geht, qualitativ hochwertige Hilfedateien, Benutzerhandbücher, Dokumentationswebsites oder E-Bücher zu erstellen, ist Microsoft Word nicht das am besten geeignete Tool. Tatsächlich kann die Anwendung von Microsoft Word ein echtes Problem darstellen, und die Ergebnisse sind oft alles andere als zufriedenstellend: Die Verwaltung mehrerer miteinander verbundener Dokumente mit Microsoft Word ist äußerst schwierig, fehleranfällig und zeitaufwändig. Die Anwendung eines Hilfe-Entwicklungstools (HET), wie HelpNDoc, ist deutlich einfacher, schneller und somit günstiger.
Die Verwaltung von Medienressourcen wie Bildern in Hilfedateien, Dokumentationsprojekten oder E-Büchern kann eine schwierige Aufgabe sein, und deshalb nutzt das Hilfe-Entwicklungstool HelpNDoc eine zentrale Bibliothek: Die Medienressourcen werden von der Bibliothek des Projekts aus verwaltet und Änderungen werden automatisch auf alle Instanzen im gesamten Projekt angewendet.
Einige Einstellungen (wie Größen, Positionen, alternative Texte …) können jedoch für jede Instanz angepasst werden, sodass sie für häufig verwendete Assets nur schwer aktualisiert werden können.
Microsoft Word und ähnliche Textverarbeitungssoftware wie LibreOffice eignen sich hervorragend zum Schreiben und Formatieren von Dokumenten, die gedruckt werden sollen, jedoch weniger gut zum Erstellen von HTML-Websites aus diesen Dokumenten: Sie generieren einen suboptimalen einseitigen HTML-/CSS-Code, der nicht für verschiedene Bildschirmgrößen und Geräte wie Smartphones optimiert ist.
Durch die Nutzung der Import- und Exportfunktionen eines Hilfe-Entwicklungstools wie HelpNDoc (das für den persönlichen Gebrauch kostenlos ist), ist das Konvertieren eines Word-Dokuments in eine voll funktionsfähige, mehrseitige und responsive HTML 5-Website äußerst einfach.
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.
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.
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.
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.
