Produktdokumentation
Noch nie war es so simpel, eine gute Produktdokumentation zu erstellen!
Erstellen Sie komplexe Dokumentationen, indem Sie Google Dokumente wie gewohnt in Ordnern in einer inhaltlich sinnvollen Struktur in Google Drive ablegen, die der Navigation und Menüführung Ihrer Dokumentation entsprechen soll.
Ultradox wird hieraus eine Online Dokumentation generiert, die sowohl auf Personal Computern als auch auf mobilen Geräten gut funktioniert.
Mit der Automation Produktdokumentation wird auch diese Ultradox Online-Hilfe erstellt, auf der Sie sich gerade befinden. Sichern Sie sich eine Kopie der Automation Produktdokumentation für Ihre eigene Produktdokumentation!
Erstellung einer Menüführung auf drei Navigationsebenen
Die Verwendung von Google Docs und Google Drive für die Erstellung Ihrer Dokumentation hat viele Vorteile:
Die Navigation Ihrer Hilfeseite wird anhand Ihrer Ordnerstruktur auf Google Drive erzeugt.
Fügen Sie einfach einen Ordner auf oberster Ebene hinzu, um einen Hauptmenüpunkt zu erzeugen, oder fügen Sie einen Unterordner hinzu, um dem Untermenü auf der linken Seite, einen Menüpunkt hinzuzufügen.
Durch einfache Textauszeichnung der Überschriften Ihrer Dokumente, können Sie automatisch ein internes Navigationsmenü and der rechten Seite Ihres Dokuments hinzufügen, um schnell zu den gewünschten Absätzen zu gelangen.
Teamwork
Die Verwendung von Google Dokumenten zur Erstellung der Inhalte macht die Zusammenarbeit nicht nur mit Ihren Mitarbeitern, sondern auch mit Ihren Kunden zum Kinderspiel: Lassen Sie sie Vorschläge zur Verbesserung der Dokumentation direkt in den entsprechenden Google Dokumenten machen.
Anschließend können Sie die Änderungsvorschläge überprüfen und die neue Version veröffentlichen. Die Aktualisierung kann auf Knopfdruck und ohne technisches Know-how durchgeführt werden.
Layout
Unser sorgfältig ausgewähltes Set von Layout-Elementen verleiht Ihrer Dokumentation zudem ein professionelles Erscheinungsbild, das durch die Analyse moderner Onlinedokumentation erstellt wurde.
Erste Schritte
Öffnen Sie die Ultradox Automation Produktdokumentation. Der erste Baustein enthält ein Formular, in dem Sie einige Angaben zum Produkt machen können.
Geben Sie den Namen, das Logo und die URL Ihres Produkts und andere Einstellungen wie die Grundfarbe der generierten Seite ein.
Weitere Optionen finden Sie in den folgenden Kapiteln.
Generieren der Seite
Nachdem Sie die Einstellungen festgelegt haben, klicken Sie auf das Symbol Ausführen in der Hauptsymbolleiste oder klicken Sie auf Ausführen im Menü Ausführen.
Nach dem Start der Anwendung werden Sie aufgefordert, entweder alle oder nur ausgewählte Seiten zu generieren. Wenn Ihre Dokumentation umfangreicher wird, werden Sie die Funktion zu schätzen wissen, nur ausgewählte Seiten generieren zu können, da es viel schneller ist und weniger Credits Ihrer Lizenz verbraucht.
Beim Generieren der Seite sehen Sie die Aktionen, die in der Konsole ausgeführt werden.
Wenn die Generierung abgeschlossen ist, öffnet sich ein Dialog, in dem Sie die zuletzt generierte Seite in einem neuen Browser-Tab öffnen können.
Die generierte Seite sieht folgendermaßen aus.
Inhalte erstellen
Die Navigation Ihrer Hilfeseite wird aus der Ordnerstruktur in Ihrem Content-Ordner und dem Inhalt Ihrer Dokumente generiert:
Auf der obersten Ebene finden Sie die Ordern A. en und B. de, in denen Sie die Dokumentation für jede Sprache finden.
Sie finden diese Sprachen in der Top-Level-Sprachauswahl.
In jedem dieser Ordner finden Sie die Ordner für die Navigation auf oberster Ebene.
Die Namen der Ordner werden also in Ihrer oberen Navigationsleiste angezeigt.
Die Ordner unterhalb der oberen Navigation erscheinen auf der linken Seite der Dokumentation. Sie können entweder Ordner oder Dokumente auf dieser Ebene haben.
Die Reihenfolge der Menüpunkte richtet sich nach dem Namen der Ordner und Dateien. Bitte geben Sie Buchstaben oder Zahlen vor, gefolgt von einem Leerzeichen, wie im Beispiel gezeigt, um die gewünschte Reihenfolge zu erstellen.
Das Navigationsmenü auf der rechten Seite wird aus dem Inhalt Ihrer Dokumente generiert.
Alle mit Überschrift 3 formatierten Abschnittsüberschriften werden im Navigationsmenü auf der rechten Seite angezeigt. Wenn Sie keine Abschnittsüberschriften mit Überschrift 3 formatiert haben, wird das Navigationsmenü auf der rechten Seite nicht angezeigt und der Inhalt Ihrer Seite nimmt den zusätzlichen Platz ein.
Layout-Elemente
Wir haben sorgfältig eine Reihe von Elementen zusammengestellt, die in Ihrer Dokumentation verwendet werden können. Halten Sie sich an diese Vorgaben, um ein einheitliches Erscheinungsbild zu schaffen.
Die Beispiel-App enthält eine Seite, die alle Layout-Elemente wie Typografie, Videos, Links, Code-Beispiele, Buttons und vieles mehr beschreibt.
Eine Liste aller Layout-Elemente finden Sie auf der generierten Beispiel-Seite.
Fußzeile konfigurieren
Die Fußzeile wird mit einem HTML-Template generiert. Sie finden die Vorlage mit dem Namen Product Documentation Template im Beispiel-Ordner 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 einfach die gewünschten Informationen in die Fußzeile ein oder löschen Sie die Fußzeile, wenn Sie sie nicht benötigen.
Volltextsuche
Wenn Sie Ihre 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 Einstellungsformular zu kopieren.
Klicken Sie auf die Schaltfläche Suchmaschinen-ID, um die ID Ihrer Suchmaschine zu erhalten.
Die URL, die Sie indizieren möchten, http://web.ultradox.com/<yourfileid>, wenn Sie die Standardeinstellung verwenden.
API-Referenz
Bei der Erstellung Ihrer Dokumentation können Sie natürlich alle 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 schöne API-Referenz für Sie generiert.
Wenn Sie keine API-Referenz benötigen, können Sie den Ordner Reference entfernen.
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, sie in einer benutzerdefinierten 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: 1/15/19