Online-Handbücher erstellen

Dr.Explain exportiert Ihr Benutzerdokumentations-Projekt in einen satzfertigen Satz HTML-Seiten. Sie erhalten ein responsives Online-Benutzerhandbuch mit Suchfunktion und Navigation – ganz ohne spezielle Kenntnisse.

Platzieren Sie das Online-Handbuch auf Ihrer Website, und Ihre Nutzer können sich mit den Funktionen Ihrer Software vertraut machen, noch bevor sie das Programm herunterladen. Dr.Explain ermöglicht es Ihnen, Tools für die SEO-Analyse in Ihre Web-Dokumentation einzubinden.

Wie erstellt man ein Online-Handbuch mit Dr.Explain?

Nachfolgend wird der Prozess der Erstellung einer Web-Version Ihrer Benutzerdokumentation kurz beschrieben. Detaillierte Informationen dazu finden Sie im Benutzerhandbuch von Dr.Explain.

Schritt 1: Projekt anlegen

• Wählen Sie eine fertige Vorlage für Ihre Benutzerdokumentation oder erstellen Sie ein neues Projekt. Sie können auch eine vorhandene ältere Dokumentation, z. B. im DOCX-Format, in Dr.Explain importieren.
• Wählen Sie ein Farbschema für Ihr Dokument, falls Sie das standardmäßig eingestellte Theme ändern möchten. Für eine feinere Anpassung des Layouts können Sie CSS- und JavaScript-Code verwenden.

Schritt 2: Inhalte zum Projekt hinzufügen

• Fügen Sie in die Abschnitte Ihre Inhalte ein: Text, Videos, Tabellen, spezielle Objekte, Querverweise, kommentierte Screenshots. Die automatische Annotation von Screenshots ist eine der Schlüsselfunktionen von Dr.Explain.
• Prüfen Sie Ihre Änderungen in der Vorschau.

Schritt 3: Projekt exportieren

• Fügen Sie bei Bedarf Code für Web-Analyse-Tools hinzu.
• Exportieren Sie das Dokument. Die Exporteinstellungen können Sie in anderen Dr.Explain-Projekten wiederverwenden. Das exportierte Dokument verfügt über interaktive Elemente und ein responsives Design.

Beispiele für mit Dr.Explain erstellte Online-Handbücher

Unten können Sie sich Screenshots von Handbüchern ansehen, die mit den Werkzeugen des Programms erstellt wurden.

Welche Vorteile bietet Ihnen Dr.Explain?

Die professionelle Software zur Erstellung von Online-Benutzerdokumentationen, Dr.Explain, bietet:

Responsives Design. Ohne Code-Kenntnisse erstellen Sie eine Online-Version Ihres Benutzerhandbuchs, die für die Nutzung auf mobilen Geräten optimiert ist.

Anbindung von Web-Analyse-Diensten. Durch die Integration von Tracking-Codes erhalten Sie Statistiken zur Analyse Ihrer Dokumentations-Metriken. Das ermöglicht die Optimierung Ihres Online-Handbuchs, indem Stärken und Schwächen identifiziert werden.

Integration von Drittanbieter-Code. Die Möglichkeit, Widgets einzubetten, macht Ihre Benutzerdokumentation anschaulicher und interaktiver.

Warum Desktop und nicht SaaS (Cloud)?

Die Desktop-Anwendung Dr.Explain ist aus mehreren Gründen vorzuziehen:

• Datensicherheit. Bei einer SaaS-Plattform können Daten den Kontrollbereich des Nutzers verlassen. Ihre Sicherheit hängt vom Anbieter, dem Browser und der Datenschutzrichtlinie des Cloud-Dienstes ab. Bei Dr.Explain unterliegen die Daten der vollständigen Kontrolle des Nutzers.
• Stabilität. Wenn Sie sich für Dr.Explain zur Entwicklung Ihrer Online-Dokumentation entscheiden, sind Sie nicht von der Qualität Ihrer Internetverbindung abhängig.
• Automatisierung der Screenshot-Annotation. Bei einer Cloud-Plattform kann diese Funktionalität eingeschränkt sein.
• Exportformate. Cloud-Dienste bieten überwiegend HTML, manchmal PDF. Dr.Explain ermöglicht den Export Ihrer Benutzerdokumentation nicht nur ins HTML-, sondern auch ins CHM-, DOCX- und PDF-Format.

In manchen Situationen können die Eigenschaften von Cloud-Plattformen durchaus als Vorteile angesehen werden. Die Wahl zwischen SaaS und einer PC-Anwendung hängt daher von den spezifischen Anforderungen an Sicherheit, Verfügbarkeit und Benutzerfreundlichkeit bei der Arbeit mit den Daten ab.

Wer wählt Dr.Explain für die Erstellung von Online-Handbüchern?

• Wenn Sie ein Online-Handbuch mit komfortabler Navigation ganz ohne Spezialkenntnisse erstellen möchten;
• Technische Redakteure, die eine Web-Hilfe mit vollwertiger Suchfunktion benötigen, die 'out of the box' funktioniert;
• Profis, die das Erscheinungsbild ihrer Online-Dokumentation mithilfe von CSS- und JavaScript-Code anpassen möchten;
• Einsteiger, die einen einfachen und verständlichen Exportprozess in verschiedene Formate benötigen;
• Technische Redakteure, die eine Online-Dokumentation mit standardmäßig responsivem Design benötigen.

Nutzer über die Erstellung von Online-Handbüchern mit Dr.Explain

'Dr.Explain funktioniert hervorragend, und wir haben unser großes Online-Hilfeprojekt bereits in das gewünschte Format übertragen.'

Jim, Mitarbeiter der Firma CNCSimulator

'Ich denke jedoch, dass Dr.Explain besser zu unserer Branche passt und im Online-Format ein 'Buchgefühl' vermittelt, was für unsere nicht-technischen Kunden gut geeignet ist.'

Darryl Winder, Geschäftsführer und Mitinhaber des Projekts SmartFees

'Die Möglichkeit, unsere Dokumente einfach im Internet zu veröffentlichen, ist für uns ebenfalls sehr wichtig. Wir erstellen sowohl eine statische Version der Dokumentation, die mit der Softwareinstallation ausgeliefert wird, als auch eine Online-Version, die immer auf dem neuesten Stand ist.'

Are Tømmerås, Senior-Geologe der Firma Migris

Häufig gestellte Fragen (FAQ)

Siehe auch

• Dokumentation in mehreren Formaten erstellen
• Erstellen von benutzerdefinierten Druckdokumenten
• CHM-Hilfedateien erstellen