Bonjour à tous !
Dans ma dernière vidéo, j'ai expliqué comment créer et modifier votre documentation produit. J'ai également montré comment intégrer des vidéos, des images, des médias et du code pour créer une documentation qui informe vos clients sur vos plateformes et solutions techniques.
Aujourd'hui, je souhaite explorer en profondeur la plateforme de documentation Docsie et vous montrer comment créer simplement une documentation logicielle.
Voici un tutoriel rapide sur la publication avec Docsie.
La publication avec le portail de connaissances Docsie peut se faire de plusieurs façons. Dans cette vidéo, j'explique comment publier des portails de connaissances, des livres, des étagères ou des articles Docsie avec une simple ligne de code.
Dans cet exemple, je vais publier ce livre spécifique intitulé "Writing your first Django app, part 2"
Comme vous pouvez le voir dans ma documentation déjà créée, j'ai une version appelée "Brand new portal that I am working on". En cliquant sur l'icône "crayon" à côté, vous avez la possibilité de rendre votre portail publié "actif" ou "principal", ou de désactiver ces fonctionnalités. C'est très pratique car cela permet à vous et votre équipe de rédiger ou mettre à jour votre documentation sans la rendre visible à vos clients jusqu'à ce que vous soyez prêts à publier votre documentation en production sur votre site :
Maintenant que vous êtes prêt à publier, il est temps de déployer votre documentation ! C'est simple : cliquez d'abord sur les trois points dans le coin supérieur droit de la plateforme Docsie, puis sur votre compte :
Une fois sur votre page Profil et paramètres, cliquez sur l'onglet "Deployments". Cela vous amènera à la page de déploiement qui vous aidera à créer votre code d'intégration à placer sur votre site web.
Maintenant, cliquez sur "Configure a new deployment +"
Parfait ! Maintenant que vous avez accès au tableau de bord, vous devez déployer un domaine personnalisé. Ouvrez simplement l'onglet "Deploy a domain" et cliquez sur "custom deployment"
Les deux étapes suivantes sont simples :
-
La première étape consiste à saisir votre domaine (n'oubliez pas d'utiliser http:// ou https:// avant le nom de domaine)
-
La deuxième étape consiste à choisir ce que vous voulez publier : un Livre ou une Étagère entière. Dans cet exemple, je publie un livre intitulé : "Writing your first Django app, part 2"
Excellent ! La dernière étape avant d'obtenir notre code est de cliquer sur "+More Options"
Vous pouvez maintenant utiliser nos différents plugins, fonctionnalités et autres options pour enrichir votre portail de connaissances et le rendre plus pratique pour vos utilisateurs. Ces fonctionnalités, plugins et outils de documentation sont très utiles et rendent vos portails plus robustes.
Note : vous pouvez modifier ces fonctionnalités, plugins et outils à tout moment.
Une fois terminé, cliquez sur "Create web portal".
Faites défiler jusqu'en bas et cliquez sur "+ Get deployment script"
Copiez ensuite votre script et collez-le dans votre HTML :
Maintenant que vous avez accès à votre script, vous pouvez améliorer l'apparence avec notre guide CSS. Il vous aidera à créer un portail Docsie élégant qui correspond à l'identité visuelle de votre marque. Consultez notre guide de style à ce lien : Guide de style Docsie
J'espère que vous avez apprécié ce tutoriel. Restez à l'écoute pour d'autres tutoriels Docsie prochainement !
Si vous avez des questions sur l'utilisation de Docsie et souhaitez une démonstration de nos outils, n'hésitez pas à Cliquer ici pour réserver une démo avec nous.