Bringen Sie Ihre Dokumentation schnell und einfach online
HelpNDocs integrierte HTML5-Vorlage verwendet die neuesten Webtechnologien, um atemberaubende Hilfedateien zu produzieren, die mit allen Geräten und Bildschirmgrößen kompatibel sind. Unterstützen Sie Ihre Benutzer, indem Sie ihnen die bestmöglichen Dokumentationswebsites anbieten, unabhängig davon, wie sie auf die Websites zugreifen.
Nachdem Sie Ihre Dokumentation mit Hilfe von HelpNDocs übersichtlicher Benutzeroberfläche geschrieben haben, werden Sie eine HTML-Website erstellen wollen: Sie kann dann einfach auf jeden Webserver hochgeladen werden und steht Ihren Lesern und Kunden somit überall auf der Welt als eine Selbsthilfe-Ressource zur Verfügung. HelpNDoc kann auf Knopfdruck tolle, reaktionsfähige Dokumentationswebsites generieren.
Zeigen Sie Ihren Lesern genau das, was Sie angefertigt haben
Nachdem Sie Ihre Zeit damit verbracht haben, ein möglichst gut aussehendes Buch, Handbuch oder Dokumentation zu schreiben, können Sie sicher sein, dass Ihre Leser alles genau so zu sehen bekommen, wie Sie es konzipiert haben.
HelpNDoc arbeitet hart, um sicherzustellen, dass die erstellte HTML-Dokumentation genau so aussieht, wie Sie sie entworfen haben: Stile, Aufzählungen und Nummerierungen, Bilder, Tabellen… alles wird originalgetreu zu Ihrer HTML-Website exportiert werden, dank HelpNDocs WYSIWYG-Konzept.
Außerdem wird HelpNDoc das Framework, das zum Navigieren in Ihrer gesamten Dokumentation erforderlich ist, automatisch generieren: ein Inhaltsverzeichnis, einen Index-Baum, eine Suchmaschine … alles wird für Sie erstellt werden, wenn Sie sich dazu entschließen, Ihre HTML-Dokumentation zu produzieren. Laden Sie einfach die generierten Dateien auf einen beliebigen Webserver hoch, und schon ist Ihre Dokumentationswebsite live und in vollem Umfang nutzbar.
Sie können sich somit auf das konzentrieren, was am meisten zählt (das Schreiben des bestmöglichen Inhalts für Ihr Handbuch, Ihr E-Book oder Ihre Website) und HelpNDoc die harte Arbeit für Sie erledigen lassen.
Reaktionsfähige, plattformübergreifende Websites für alle Geräte und Bildschirmgrößen
Die durch HelpNDoc erstellte HTML5-Dokumentation kann sich jedem Gerät und jeder Bildschirmgröße ohne zusätzliche Arbeit anpassen.
Ihre Benutzer sind daran gewöhnt, auf Websites mit einer Vielzahl von Geräten und Bildschirmgrößen zuzugreifen: Ihre Web-Inhalte müssen sorgfältig entworfen werden, um sich ohne einen Verlust an Lesbarkeit oder Zugänglichkeit anzupassen. Das ist die harte Arbeit, die HelpNDocs reaktionsfähige HTML5-Vorlage im Hintergrund leistet: Sicherzustellen, dass Ihre Dokumentation unter allen Umständen so gut wie möglich aussieht, auf einem Mobiltelefon … bis hin zu einem großen Fernsehbildschirm.
Hier sind einige der durch HelpNDoc angewendeten Tricks, die sicherstellen, dass Ihre HTML-Website auf allen Geräten optimal aussieht:
- Zur Verbesserung der Lesbarkeit wird die Überschrift automatisch ausgeblendet, wenn der Benutzer den Inhalt auf einem kleinen Gerät nach unten scrollt. Die Überschrift wird beim Nachobenscrollen wieder sichtbar.
- Das linke Bedienungsfeld (einschließlich Inhaltsverzeichnis, Index und Suchfunktion) wird auf kleinen Bildschirmen automatisch eingeklappt, um mehr Platz für den Inhalt zu lassen. Es kann bei Bedarf über das “Hamburger-Menü” geöffnet werden.
- Die Schriftart wird auf kleinen Bildschirmen automatisch vergrößert, um sicherzustellen, dass die Leser Hyperlinks einfach lesen und mit den Fingern auf Touchscreens öffnen können.
- Bilder, die für die Anzeige zu groß sind, werden automatisch so skaliert, dass sie in den sichtbaren Bereich passen.
- Und vieles mehr…
Integrierte Suchmaschinenoptimierung (SEO)
Wäre es nicht schön, wenn potenzielle Kunden Ihre Website bei der Suche nach einem Konkurrenten auf ihrer bevorzugten Suchmaschine finden würden? HelpNDoc arbeitet hart, um Ihnen zu helfen, genau das zu erreichen.
Suchmaschinen gehören zu den wichtigsten Zugangstüren zu allen Online-Inhalten. HelpNDoc stellt sicher, dass Ihre Dokumentationswebsite korrekt durch Suchmaschinen verarbeitet wird, indem es SEO-freundliche URLs von der Stange generiert. Da Ihre Website reaktionsfähig und deshalb zugänglich für Benutzer von Mobiltelefonen ist, wird sie außerdem höher durch Suchmaschinen bewertet werden. Zudem ist der durch HelpNDoc generierte HTML-Code standardkonform und wird daher durch Webcrawler leicht verstanden und hoch geschätzt.
Die Seitenladezeit wurde sorgfältig optimiert, um die Downloadzeit und Suchmaschinenzugänglichkeit in Einklang zubringen. Zum Beispiel ist das Inhaltsverzeichnis vollständig im HMTL-Code der Homepage enthalten, sodass die Suchmaschinen Ihre gesamten Inhalte schnell finden können. Es wird nach Bedarf dynamisch auf andere Dokumentationswebseiten geladen, um deren Dateigröße und somit deren Ladezeiten zu verringern, sodass Ihre Leser schnell durch Ihre Inhalte navigieren können. Standardassets wie JavaScript und CSS werden minimiert, um ihre Ladezeit zu reduzieren.
Lassen Sie Ihre Benutzer jederzeit bei Bedarf drucken
Beim Durchsuchen Ihrer Online-Dokumentation müssen Ihre Leser eventuell einige wesentlichen Informationen über die Druckfunktion ihres Webbrowsers ausdrucken. HelpNDocs HTML-Vorlage bietet hierfür ein fantastisches Drucklayout.
Drucken ist ein wichtiger Teil des Dokumentationsvorgangs: Die meisten Benutzer benötigen eine gedruckte Kopie einiger Themen, um sicherzugehen, dass sie die relevanten Schritte befolgen können. Aus diesem Grund bietet HelpNDocs HTML-Vorlage ein optimiertes Druck-Stylesheet mit jeder erstellten HTML-Dokumentation.
Die meisten Websites für Hilfedateien und Handbücher enthalten einen speziellen “Drucken”-Button, um die Leser eine bestimmte Seite ausdrucken zu lassen. Das trägt nicht nur durch einen zusätzlichen Button zur Verwirrung in der Benutzeroberfläche bei, sondern ist oft schlecht umgesetzt, mit halb unterstützten JavaScript-Tricks, um zu versuchen, HTML-Elemente zu verschieben oder auszublenden. HelpNDoc löst dieses Problem, indem es die Leser das tun lässt, was sie zu tun gewohnt sind: die integrierte Druckfunktion ihres Webbrowsers mittels eines speziellen, sorgfältig entworfenen und standardkonformen Druck-Stylesheets zu benutzen.
Passen Sie das Erscheinungsbild nach Ihren Wünschen an
Die Standard-HTML-Vorlage enthält benutzerfreundliche Optionen zum schnellen Anpassen Ihrer HTML-Dokumentationswebsites, wie beispielsweise durch Hinzufügen eines Logos, einer benutzerdefinierten Fußzeile…
Die meisten Tools zur Dokumentationserstellung sind viel zu unflexibel und produzieren einförmige HTML-Dokumentationswebseiten mit wenigen Anpassungsmöglichkeiten. HelpNDocs Philosophie ist das genaue Gegenteil: Bereitstellung von möglichst vielen Anpassungsmöglichkeiten, um wirklich einzigartige Dokumentationsseiten zu produzieren.
Deshalb können Sie die Standard-HTML-Vorlage einfach und schnell mit HelpNDoc anpassen, um:
- die allgemeine Themenfarbe durch eine Auswahl zwischen dunklen und hellen Varianten der Farben Blau, Grün, Orange und Lila anzupassen,
- Ihre Dokumentation durch Auswahl eines Logos aus Ihrer Bibliothek im Handumdrehen zu personalisieren,
- einen benutzerdefinierten HTML-Code in die Fußzeile jeder Dokumentationsseite einzufügen,
- die generierte HTML-Ausgabe durch Hinzufügen eines benutzerdefinierten CSS- und JavaScript-Codes anzupassen,
- jeden integrierten String in jede durch Sie unterstütze Sprache zu übersetzen,
- auszuwählen, welcher Teil der Benutzeroberfläche sichtbar oder nicht sichtbar ist,
- und vieles mehr…
Zusätzlich zu diesen Optionen haben Sie vollständigen Zugriff auf den Quellcode der Vorlage in HelpNDocs Installationsverzeichnis, in dem Sie das Erscheinungsbild Ihrer generierten HTML-Dateien vollständig anpassen können.
Nicht auf die standardmäßige HTML5-Vorlage beschränkt
HelpNDoc basiert auf einem leistungsfähigen Vorlagensystem, in dem Sie alles in Ihrer erstellten HTML-Dokumentation anpassen können.
Wenn Ihnen die voreingestellte, reaktionsfähige HTML5-Vorlage nicht gefällt, können Sie ganz einfach Ihre eigene Vorlage erstellen, um so gut wie alles in HelpNDocs generierter HTML-Ausgabe hinzuzufügen, zu entfernen oder anzupassen. HelpNDocs Vorlagensystem ist ein ähnliches System wie serverseitige Technologien wie beispielsweise ASP.net oder PHP, bei denen die Programmierung zum Produzieren der HTML-Ausgabe verwendet wird, die Sie jeden Tag online durchbrowsen: So leistungsfähig ist HelpNDocs Vorlagensystem.
Um Ihnen die Leistungsfähigkeit von HelpNDocs Vorlagensystem zu zeigen, haben wir den vollständigen Quellcode der folgenden Vorlagen in HelpNDocs Installationsverzeichnis eingefügt, damit Sie ihn überprüfen können:
- die standardmäßige reaktionsfähige HTML5-Vorlage;
- eine iOS-spezifische Vorlage, die mit allen Apple-Geräten wie iPhone und iPad kompatibel ist und die das neueste iOS-Thema verwendet,
- eine jQuery-Mobile-Vorlage, die mit den meisten auf dem Markt erhältlichen Mobiltelefonen und Tablets einschließlich Android-basierten Geräten kompatibel ist,
- eine einseitige HTML-Vorlage, mit der alle Themen innerhalb einer einzigen HTML-Seite erstellt werden,
- eine Legacy-HTML-Vorlage,
- eine Legacy-iOS6-Vorlage mit einem älteren iOS-Erscheinungsbild.
Angesichts all dieser tollen Tools und Funktionen sind dem, was Sie mit HelpNDocs erstaunlichem HTML-Generierungssystem erreichen können, absolut keine Grenzen gesetzt.