Produktdokumentation
Noch nie war es so simpel, eine gute Produktdokumentation zu erstellen!
Erstellen Sie komplexe Dokumentationen, indem Sie Google Dokumente in Ordnern auf Google Drive in einer inhaltlich sinnvollen Struktur ablegen.
Ultradox wird anhand dieser Ordnerstruktur die Menüführung der Website anlegen und die einzelnen Webseiten aus den Google Dokumenten generieren!
Mit der Automation Produktdokumentation wird auch diese Ultradox Online-Hilfe erstellt und laufend aktualisiert.
Die Online Dokumentation ist responsive und funktioniert sowohl auf Personal Computern als auch auf mobilen Geräten.
Sichern Sie sich eine kostenlose Kopie der Automation Produktdokumentation und erstellen Ihre eigene Produktdokumentation!
Erstellung der Menüführung auf drei Navigationsebenen
Die Verwendung von Google Docs und Google Drive für die Erstellung der Dokumentation hat viele Vorteile, denn die Navigation Ihrer Hilfeseite wird anhand der Ordnerstruktur auf Ihrem Google Drive erzeugt:
- Um einen Hauptmenüpunkt zu erzeugen, fügen Sie einen Ordner auf oberster Ebene hinzu.
- Ein Untermenü auf der linken Seite wird erzeugt, wenn Sie in den Ordnern auf oberster Ebene einen Unterordner oder ein einzelnes Google Dokument hinzufügen.
- Ein internes Navigationsmenü and der rechten Seite der einzelnen Webseiten, wird durch einfache Textauszeichnung der Überschriften im Google Dokument erzeugt.
Teamwork
Die Verwendung von Google Dokumenten zur Erstellung der Inhalte, macht die Zusammenarbeit mit Ihren Mitarbeitern und Ihren Kunden zum Kinderspiel:
- Sie können für Verbesserungsvorschläge den Zugriff auf die Google Dokumente erlauben.
- Nach Überprüfung der Vorschläge kann die neue Version einfach aktualisiert und veröffentlicht werden.
Die Aktualisierung wird per Knopfdruck ohne technisches Know-how durchgeführt.
Layout
Unser sorgfältig ausgewähltes Set von Layout-Elementen, das durch die Analyse moderner Onlinedokumentation erstellt wurde, sorgt für ein professionelles Erscheinungsbild und das responsive Layout passt sich an Personal Computer und an mobile Geräte an.
Erste Schritte
Einstellungen
Öffnen Sie die Ultradox Automation Produktdokumentation. In dem Formular des obersten Werte zuweisen Baustein können Sie die Einstellungen für Ihre Website vornehmen: Favicon, Namen, Logo, die URL Ihres Produkts oder die Farbe des Menüs.
Weitere Optionen, wie Volltextsuche, API-Referenz oder das verwenden von benutzerdefinierte Domains, finden Sie weiter unten beschrieben.
Generieren der Seite
Nachdem Sie die Einstellungen festgelegt und gespeichert haben, klicken Sie auf das Symbol Ausführen in der Hauptsymbolleiste. Sie werden aufgefordert, entweder alle oder nur die geänderten Seiten zu generieren.
Wenn Ihre Dokumentation umfangreicher wird und nur einzelne Seiten geändert wurden, generieren Sie einfach nur die aktualisierten Seiten. Das geht schneller und verbraucht weniger Credits Ihrer Lizenz.
Beim Generieren der Seite werden die Aktionen die ausgeführt werden in der Konsole angezeigt.
Wenn die Generierung abgeschlossen ist, öffnet sich ein Dialog, über den Sie die zuletzt generierte Seite in einem neuen Browser-Tab öffnen können.
Die generierte Seite sieht folgendermaßen aus.
Für einen schnellen Zugriff setzten Sie einen Bookmark für die Startseite Ihrer Dokumentation.
Inhalte erstellen
Die Navigation der Produktdokumentation wird aus der Ordnerstruktur in dem Content Ordner und dem Inhalt der Dokumente generiert:
Auf oberster Ebene befinden sich die Ordner A. en und B. de, in denen sich die Dokumentation in der jeweiligen Sprache befindet.
Sie finden diese Sprachen in der Top-Level-Sprachauswahl.
In jedem dieser Ordner befinden sich die Ordner für die Navigation auf oberster Ebene.
Die Namen der Ordner werden also in der oberen Navigationsleiste angezeigt.
Die Ordner unterhalb der oberen Navigation erscheinen auf der linken Seite der Dokumentation. Es können sich entweder Ordner oder Dokumente auf dieser Ebene befinden.
Die Reihenfolge der Menüpunkte richtet sich nach dem Namen der Ordner und Dateien. Um die gewünschte Reihenfolge zu erstellen, geben Sie, wie im Beispiel gezeigt, Buchstaben oder Zahlen vor, gefolgt von einem Leerzeichen.
Das Navigationsmenü auf der rechten Seite wird aus dem Inhalt Ihrer Dokumente generiert.
Alle mit Überschrift 3 formatierten Überschriften werden im Navigationsmenü auf der rechten Seite angezeigt. Wenn Sie keine Überschriften mit Überschrift 3 formatiert haben, wird kein Navigationsmenü auf der rechten Seite erstellt und der Inhalt Ihrer Seite nimmt den zusätzlichen Platz ein.
Layout-Elemente
Die Layout-Elemente, die in der Dokumentation verwendet werden können, erzeugen ein einheitliches Erscheinungsbild und sind in der Onlinedokumentation aufgeführt.
Nachdem Sie die Produktdokumentation mit Hilfe der Automation erstellt haben, finden Sie unter dem Menüpunkt Guides / Creating content / Layout elements, alle Layout-Elemente wie Typografie, Videos, Links, Code-Beispiele, Buttons und vieles mehr.
Fußzeile konfigurieren
Die Fußzeile wird mit einem HTML-Template generiert. Sie finden die Vorlage mit dem Namen Product Documentation Template im Projektordner auf Ihrem Google Drive.
Wenn Sie das Template mit Editey öffnen, sehen Sie den HTML-Code, um die Fußzeile am Ende der Seite zu generieren.
Geben Sie die gewünschten Informationen in die Fußzeile ein oder löschen Sie die Fußzeile, wenn Sie keine benötigen.
Volltextsuche
Wenn Sie der Hilfeseite eine Suchfunktion hinzufügen möchten, konfigurieren Sie eine Google Custom Search Engine, um die generierte Seite zu indizieren und die ID in das Formular Einstellungen zu kopieren.
Klicken Sie auf die Schaltfläche Suchmaschinen-ID, um die ID Ihrer Suchmaschine zu erhalten.
Wenn Sie die Standardeinstellung verwenden, lautet die URL die Sie indizieren: http://web.ultradox.com/<yourfileid>.
API-Referenz
Bei der Erstellung Ihrer Dokumentation können Sie natürlich auch alle weiteren Funktionen von Ultradox nutzen. Als Beispiel für die Generierung von Inhalten aus strukturierten Daten, haben wir eine API-Referenz in die Beispieldokumentation aufgenommen, die aus einer API-Definition generiert wird.
Wenn Sie an einer App mit einer im Swagger 2.0-Format definierten öffentlichen API arbeiten, können Sie einfach die öffentliche URL Ihrer Swagger-Definition in dieses Formular einfügen.
Bei der Generierung Ihrer Dokumentation wird aus Ihrer Definitionsdatei eine API-Referenz generiert.
Wenn Sie keine API-Referenz benötigen, entfernen Sie den Ordner Reference.
Benutzerdefinierte Domain
Standardmäßig finden Sie die generierte Online-Hilfe unter http://web.ultradox.com/<yourfileid>/
Abhängig von Ihrer Ultradox-Lizenz können Sie die generierte Dokumentation auf Ihrer eigenen Domain veröffentlichen. Geben Sie einfach den konfigurierten benutzerdefinierten Domain-Namen in den Einstellungen ein.
Stellen Sie sicher, dass Ihre benutzerdefinierte Domain von unseren Experten richtig konfiguriert wurde, bevor Sie versuchen, die Dokumentation als eine benutzerdefinierte Domain zu veröffentlichen.
Questions and Feedback
If you have any comments on this page, feel free to add suggestions right to the Google document that we are using to create this site.
If you are not yet member of the Ultradox community on Google+, please join now to get updates from our end or to provide feedback, bug reports or discuss with other users.
Last Updated: 4/23/19