Hallo zusammen!
In meinem letzten Video habe ich darüber gesprochen, wie man eine Produktdokumentation erstellt und wie man sie bearbeitet. Außerdem habe ich Ihnen gezeigt, wie Sie Videos, Bilder, Medien und Code einbetten können, um eine Produktdokumentation zu erstellen, mit der Sie Ihre Kunden über Ihre technischen Plattformen und Lösungen aufklären können.
Jetzt wollte ich tief in die Docsie-Produktdokumentationsplattform eintauchen und Ihnen zeigen, wie Sie Softwaredokumentation einfach und leicht erstellen können.
Hier ist ein kurzes Tutorial, das erklärt, wie man mit Docsie veröffentlicht.
Das Veröffentlichen mit Docsie's Wissensportal kann auf verschiedene Arten erfolgen. In diesem Video erkläre ich, wie man mit Docsie's Wissensportalen, Bücher, Regale oder Artikel mit einer einfachen Codezeile veröffentlicht.
In diesem Beispiel wollte ich dieses spezielle Buch mit dem Titel 'Writing your first Django app, part 2' veröffentlichen.
Wie Sie in meiner aktuellen, bereits erstellten Software-Dokumentation sehen können, habe ich eine Version mit dem Namen "Brand new portal that I am working on" (Brandneues Portal, an dem ich arbeite) geschrieben. Wenn Sie auf das "Stift"-Werkzeug daneben klicken, haben Sie die Möglichkeit, Ihr veröffentlichtes Portal "aktiv" oder "primär" zu machen oder diese Funktionen auszuschalten. Das ist großartig, denn das bedeutet, dass Sie und Ihr Team Ihre Dokumentation schreiben oder aktualisieren können und sie für Ihre Kunden oder Klienten nicht sichtbar ist, bis Sie bereit sind, Ihre erstellte Produktdokumentation in Produktion auf Ihrer Website zu veröffentlichen:
Damit sind Sie bereit für die Veröffentlichung Ihrer Dokumentation! Das geht ganz einfach, indem Sie zuerst auf die drei Punkte in der oberen rechten Ecke der Docsie-Plattform und dann auf Ihr Konto klicken:
Sobald Sie sich auf Ihrer Profil- und Einstellungsseite befinden, klicken Sie auf die Registerkarte mit dem Titel "Einsätze". Dies bringt Sie zur Einsatzseite und hilft Ihnen bei der Erstellung Ihres Einbettungscodes, der auf Ihrer Website platziert wird.
Klicken Sie nun auf "Configure a new deployment +".
Großartig! Da Sie nun Zugriff auf das Dashboard haben, müssen Sie nur noch eine benutzerdefinierte Domäne bereitstellen. Dies ist ganz einfach, indem Sie die Registerkarte "Bereitstellung einer Domäne:" öffnen und auf "Benutzerdefinierte Bereitstellung" klicken
Die nächsten beiden Schritte sind nun einfach:
-
Der erste Schritt ist die Eingabe Ihrer Domain (und denken Sie daran, http:// oder https:// zu verwenden, bevor Sie Ihren Domainnamen schreiben)
-
Im zweiten Schritt wählen Sie aus, was Sie veröffentlichen möchten. Sie haben die Wahl, ein Buch oder ein ganzes Regal zu veröffentlichen. In diesem Beispiel veröffentliche ich ein Buch mit folgendem Inhalt: "Writing your first Django app, part 2".
Großartig! Der letzte Schritt, bevor wir unseren Code erhalten, ist das Klicken auf "+More Options".
Jetzt können Sie unsere verschiedenen Plugins, Funktionen und andere Dokumentationsoptionen nutzen, um Ihr Wissensportal aufzupeppen und es für Ihre Nutzer noch praktischer zu machen. Diese Funktionen, Plugins und Produktdokumentationstools sind ziemlich raffiniert und machen Ihre Wissensportale noch robuster.
Hinweis: Sie können diese zusätzlichen Funktionen und Plugins sowie andere Produktdokumentationstools jederzeit ändern.
Klicken Sie anschließend auf "Webportal erstellen".
Scrollen Sie nun nach unten und klicken Sie auf "+ Get deployment script".
Kopieren Sie Ihr Skript und fügen Sie es in Ihr HTML ein:
Jetzt, wo Sie Zugang zu Ihrem Skript haben, können Sie die Sache mit unserer CSS-Bedienungsanleitung aufpeppen. Sie wird Ihnen helfen, ein stilvolles Docsie-Wissensportal zu erstellen, das dem Aussehen und der Atmosphäre Ihrer Marke entspricht. Bitte lesen Sie unsere Styling-Anleitung unter diesem Link hier: Docsie's styling Guide
Ich hoffe, dass Ihnen dieses Tutorial gefallen hat. Bleiben Sie dran für weitere Docsie-Tutorials in naher Zukunft!
Wenn Sie Fragen dazu haben, wie Docsie Ihnen helfen kann, und wenn Sie eine Demo unserer Tools sehen möchten, können Sie sich gerne an Click Here wenden, um eine Demo mit uns zu buchen.