Jours
Heures
Minutes
Secondes

Use coupon '40BFCM' to get 40% discounts on BetterDocs PRO

Guide ultime pour une meilleure documentation WordPress pour tout développeur de plugin

Si vous êtes un développeur qui fabrique des plugins pour WordPress, alors configurer un Documentation WordPress ou une base de connaissances devrait être un élément essentiel de votre stratégie de support client. Après tout, il pourrait être très facile pour vous d'utiliser votre propre plugin, mais vos clients potentiels ou utilisateurs finaux pourraient avoir besoin d'un guide approprié pour vraiment comprendre comment fonctionne votre plugin.

développeur de plugin de documentation betterdocs wordpress

Pour cette raison, vous devriez certainement envisager de passer du temps à mettre en place un bon, informatif et utile documentation du plugin pour les utilisateurs de vos produits. Sans offrir documentation du plugin pour vos utilisateurs, il sera difficile pour vous et votre équipe de réussir car vous continuerez à recevoir des tonnes de tickets de support.

Imaginez ce que vous ressentiriez si vous achetiez une toute nouvelle machine à laver, mais vous ne saviez pas comment la faire fonctionner car elle était livrée sans instructions ni manuel d'utilisation. Vous pouvez appeler le service client, mais vous devrez attendre longtemps pendant que le service client répond aux questions de tous les autres.

Donc, si vous êtes Développeur de plugins WordPress et souhaitez que vos clients aient une bonne expérience avec vos produits, alors envisagez de mettre en place une documentation WordPress ingénieuse qui soit facile à utiliser et à comprendre.

Parler de l'importance de la documentation pour les plugins WordPress, Vova Feldman, le fondateur de Freemius partagé: 

"Avec une documentation appropriée, vous et votre équipe d'assistance pouvez travailler plus efficacement en référant les utilisateurs à des sujets documentés au lieu de les écrire encore et encore. Cela améliore l'UX pour les utilisateurs qui sont à l'aise de trouver des solutions dans une approche libre-service qui réduit naturellement la charge de support. "

Vova Feldman - Fondateur et PDG, Freemius Tweet

Table des matières

Tout ce que vous devez savoir sur la documentation WordPress

Le principal but de la documentation est de fournir à vos utilisateurs des informations détaillées sur la façon dont ils peuvent utiliser votre produit. Il est beaucoup plus complet qu'un simple FAQ (Foire aux questions) et doit être facile à lire et à comprendre, même pour les personnes qui n'ont pas de connaissances techniques sur votre produit.

Pour résumer, votre documentation WordPress agit comme le manuel d'utilisation de votre produit et devrait faire en sorte que vos utilisateurs finaux se sentent comme un expert lorsqu'ils utilisent vos plugins. 

Qu'il s'agisse d'apprendre aux utilisateurs comment installer et activer votre plug-in, de configurer les paramètres et de peaufiner avec différentes fonctionnalités, assurez-vous que la documentation de votre plug-in répond à autant de questions que possible.

Voyons pourquoi cela est si important pour tout développeur de plugin. Ci-dessous, nous allons vous donner un très bref aperçu de tous les avantages d'une documentation de plugin.

👉Assist Non-Technical Users To Understand Your WordPress Plugin: Certains de vos utilisateurs finaux peuvent avoir des connaissances techniques, plus les utilisateurs sur WordPress ont tendance à provenir d'un milieu non technique. Cela signifie que vous devez fournir une documentation pour votre plugin WordPress facile à comprendre pour les utilisateurs non techniques.

👉Enhance User Experience With A Detailed WordPress Documentation: Si vos utilisateurs peuvent comprendre comment utiliser votre plugin WordPress en parcourant simplement la documentation du plugin que vous leur avez fournie, ils se sentiront responsabilisés et satisfaits de votre plugin WordPress.

👉Reduce Support Tickets & Workload On Your Team: Une bonne documentation WordPress peut grandement contribuer à réduire les tickets de support et la charge de travail de votre équipe de support. Si vos utilisateurs finaux peuvent résoudre la majorité de leurs problèmes en lisant la documentation de votre plugin, ils n'auront pas besoin de contacter votre équipe d'assistance.

👉Safeguard Yourself From Negative Reviews: Sans une documentation WordPress appropriée, vos utilisateurs pourraient ne pas comprendre comment fonctionne votre plugin. Il est très probable que vos utilisateurs se sentent tellement frustrés qu'ils pourraient finir par laisser des avis négatifs sur vos plugins. Donc, pour vous protéger des avis négatifs, proposez une documentation WordPress riche en contenu.

👉SEO Benefits of Documentation: Tout en ayant une documentation appropriée vous aide à fournir aux clients toutes les informations dont ils ont besoin, mais il sera inefficace si les clients ne peuvent pas savoir où y accéder. Ici, la base de connaissances peut être un moyen relativement facile de se classer en haut de la recherche Google si vous avez correctement optimisé votre documentation pour le trafic des moteurs de recherche.

Le contenu est l'un des quatre principaux facteurs de classement de l'algorithme de référencement de Google et la documentation est l'une des sources de contenu de votre site Web, car elle est plus susceptible d'être classée sur les premières pages avec des optimisations appropriées.

✅ Guide de configuration d'une documentation WordPress ingénieuse

Pour configurer une documentation WordPress utile et riche en contenu, vous devez suivre quelques directives de base. Nous allons les examiner maintenant.

Utilisez un langage simple pour la documentation de votre plugin

N'oubliez pas que le but d'une documentation WordPress est de permettre aux utilisateurs de comprendre plus facilement comment utiliser votre plugin sans pour autant ayant besoin d'une expertise technique. Évitez d'utiliser des jargons techniques car les utilisateurs qui n'ont pas de connaissances techniques ne seront pas familiers avec ces termes.

Assurez la lisibilité de vos utilisateurs

Une documentation WordPress informative et ingénieuse est susceptible d'avoir beaucoup de contenu. Pour faciliter la lecture rapide de tout le contenu de la documentation du plugin par vos utilisateurs, utilisez de courts paragraphes, des images, des listes, des puces, une table des matières et bien plus encore. Tous ces éléments vous aideront à faciliter la lecture de votre documentation WordPress.

Suivez une structure appropriée pour votre documentation WordPress

Une documentation WordPress efficace et utile aura une structure appropriée. Cela signifie que tout le contenu de la documentation de votre plugin suivra des instructions séquentielles, étape par étape.

Par exemple, tous les plug-ins WordPress doivent être activés après l'installation. Si vous sautez l'étape d'activation du plugin, de nombreux utilisateurs pourraient ne pas comprendre pourquoi votre plugin ne fonctionne pas pour eux. Ainsi, lorsque vous écrivez la documentation de votre plugin, assurez-vous de suivre une structure séquentielle appropriée qui a du sens pour vos utilisateurs finaux.

Pour avoir une meilleure idée de ce à quoi ressemble une documentation de plug-in WordPress de haute qualité, consultez ces pages de documentation conçues pour certains plug-ins WordPress populaires.

Organiser La documentation de votre plugin avec des catégories et des balises appropriées

Il s'agit d'une règle très importante à retenir lorsque vous écrivez la documentation de votre plugin. Toujours utiliser catégories et balises appropriées pour organiser le contenu de votre documentation WordPress.

C'est Particulièrement important si votre plugin a des tonnes de fonctionnalités qui offrent des avantages uniques à vos utilisateurs. Il permet aux utilisateurs de trouver plus facilement leur contenu pertinent lorsqu'ils se trouvent sur la page d'accueil de votre documentation.

Mettre à jour et améliorer régulièrement la documentation WordPress

Chaque fois que vous mettez à jour et améliorez votre plugin, vous devez également mettre à jour votre documentation WordPress pour vous assurer que les informations sont utilisables pour vos utilisateurs finaux. Sinon, vos utilisateurs se sentiront confus et frustrés car ils ne pourront pas comprendre la documentation du plugin.

En suivant ces directives, vous pourrez créer une documentation WordPress de haute qualité, pertinente et riche en contenu pour vos utilisateurs.  

🚀Create WordPress Documentation With BetterDocs: The Most Powerful Knowledge Base Solution

Maintenant que vous connaissez l'importance d'avoir une documentation de plugin et les directives que vous devez suivre, vous vous demandez peut-être Comment vous pouvez créer votre propre documentation WordPress riche en contenu et informative. La solution la plus avancée pour créer une documentation WordPress de haute qualité est BetterDocs.

BetterDocs est le plugin de documentation le plus puissant car il vous aide considérablement réduire le temps et les tickets de support en créant une belle documentation WordPress consultable. Il vous est présenté par WPDeveloper, la société de produits WordPress qui servir plus de 700 000+ utilisateurs WordPress de plus de 180 pays. C'est le même équipe derrière Essential Addons pour Elementor, NotificationX et plus.

🔝 Key Features Of BetterDocs That Help You Create Better WordPress Documentation

Il existe plusieurs fonctionnalités spéciales qui distinguent BetterDocs de tous les autres plugins similaires. D'une collection de belles, modèles prédéfinis, à une utilisation simple personnalisateur intégré, BetterDocs a tout ce dont vous pourriez avoir besoin pour créer une page de documentation organisée et attrayante en quelques minutes. Ces fonctionnalités incluent:

✔️ Une collection de modèles de modèles prêts à l'emploi prêts à l'emploi 
✔️ Un intégré personnalisation au style vos pages de documentation
✔️ Créez automatiquement des collants Table des matières pour une navigation plus facile
✔️ Avancé Recherche en direct pour trouver rapidement du contenu pertinent
✔️ Gardez une trace des performances avec Analytique et rapport 
✔️ Réponses instantanées ChatBot pour une expérience utilisateur améliorée 
✔️ SEO convivial documentation à l'aide du balisage de schéma approprié

🔥How To Use BetterDocs To Quickly Create Your WordPress Documentation

Dans cette section, nous allons vous apprendre à utiliser BetterDocs pour créer rapidement votre documentation WordPress. Nous allons commencer par les bases, telles que la façon d'installer le plugin BetterDocs pour WordPress, puis nous vous montrerons comment vous pouvez utiliser toutes les fonctionnalités intéressantes que nous avons mentionnées précédemment pour créer votre documentation de plugin.

Installer et activer le plug-in BetterDocs pour WordPress

La toute première chose que vous devez faire est de trouver le plugin BetterDocs pour WordPress en accédant à wp-admin -> Plugins -> Ajouter un nouveau depuis votre tableau de bord WordPress. Ensuite, vous devez écrire «BetterDocs» dans la zone de recherche.

Une fois que vous avez trouvé le plugin, simplement installer et activer il.

Configurer la page d'accueil de la documentation et la page unique avec BetterDocs

L'étape suivante après l'installation et l'activation de BetterDocs consiste à configurer votre page d'accueil de documentation.

C'est très simple à faire. Par défaut, BetterDocs est livré avec sa propre page d'accueil de documentation que vous pouvez personnaliser comme vous le souhaitez. Cependant, si vous souhaitez attribuer votre propre mise en page, vous pouvez le faire en désactivant la page d'accueil par défaut et en utilisant des codes courts ou des widgets de création de page.

Pour configurer et personnaliser la page d'accueil par défaut fournie avec BetterDocs, accédez à BetterDocs -> Paramètres -> Disposition. Choisissez le nombre de colonnes, activez ou désactivez la recherche en direct et la disposition de la maçonnerie, le nombre de publications et bien plus encore.

Si vous souhaitez configurer les pages de documentation individuelles, il vous suffit de sélectionner «Single Doc» onglet pendant que vous êtes dans le 'Disposition' onglet jusqu'à ce que vous trouviez l'option 'Single Doc'. Tweak around avec les options pour styliser votre page unique de documentation.

Si vous le souhaitez, vous pouvez également configurer votre page d'archives de documentation WordPress exactement de la même manière. Cliquez simplement sur le «Page des archives» onglet dans le 'Disposition' languette.

Attribuer et gérer des rôles d'utilisateur pour rationaliser la charge de travail

Cette étape est complètement facultative. Si vous êtes développeur de plugins et que vous souhaitez affecter différentes personnes à la création et à la gestion de la documentation de vos plugins, vous pouvez gérer les rôles utilisateur dans BetterDocs en allant à BetterDocs -> Paramètres -> Paramètres avancés à partir de votre tableau de bord WordPress.

BetterDocs

Créez et publiez votre documentation WordPress

Ceci est la partie amusante. C'est l'étape où nous vous montrons comment créer et publier une nouvelle documentation dans BetterDocs.

Vous devez vous diriger vers BetterDocs -> Ajouter un nouveau à partir de votre tableau de bord WordPress. Cela ouvrira l'éditeur pour vous, où vous pouvez écrire le contenu de votre documentation et également choisir des catégories et des balises.

Triez et organisez votre documentation WordPress avec des catégories et des balises

Nous avons mentionné combien il est important d'utiliser des catégories et des balises dans notre guide pour configurer une documentation WordPress ingénieuse. Ici, dans cette section, nous allons vous montrer comment trier et organiser la documentation dans BetterDocs. Pour configurer vos catégories, vous devez vous rendre sur BetterDocs -> Catégories à partir de votre tableau de bord WordPress où vous pouvez créer autant de catégories que vous le souhaitez.

Plus tard, lorsque vous rédigez la documentation de votre plugin, vous pouvez attribuer ces catégories et voir comment elles vous aident à garder votre documentation organisée après les avoir publiées.

Inclure la recherche avancée en direct pour votre documentation WordPress

Avec BetterDocs, vous avez la possibilité de ajouter et personnaliser la recherche en direct de la documentation. Aller vers wp-admin -> BetterDocs -> Paramètres. Ensuite, ouvrez le 'Conception' languette. Maintenant, appuyez sur le «Personnaliser BetterDocs» et vous serez redirigé vers la page Personnaliser.

À partir de ce personnalisateur, vous pouvez configurer la recherche en direct pour votre documentation. Jouez avec les options de style et observez vos changements en temps réel. Lorsque vous êtes satisfait de votre style, assurez-vous d'enregistrer vos modifications.

BetterDoc

Ajouter des réponses instantanées ChatBot pour une meilleure expérience utilisateur

Si vous souhaitez réduire encore plus vos tickets d'assistance et améliorer l'expérience utilisateur, vous devez savoir comment fournir une réponse instantanée dans WordPress et améliorez l'expérience utilisateur avec BetterDocs. Vous pouvez ajouter ce ChatBot de réponses instantanées dans n'importe quelle page que vous aimez. Pour l'activer, vous devez accéder à wp-admin -> BetterDocs -> Paramètres puis cliquez sur l'onglet «Réponse instantanée».

Vous devez ensuite configurer le ChatBot de réponses instantanées selon vos préférences. Vous pouvez modifier les options de la section "Paramètres de conversation", de la section "Paramètres d'apparence", et bien plus encore.

Réponses instantanées ChatBot peut être largement personnalisé pour créer un ChatBot de conversation interactif qui s'occupera instantanément des problèmes de vos utilisateurs. 

Pour une meilleure idée de la façon dont le ChatBot Instant Answers de BetterDocs peut vraiment faire ressortir votre page de documentation, voyez comment Easy.Jobs utilise Instant Answers ChatBot sur son site.

Documentation WordPress

Comme vous pouvez le voir, chaque fois qu'un utilisateur clique sur le chat instantané de réponses instantanées, il répond immédiatement aux requêtes de l'utilisateur. De cette façon, BetterDocs vous aide à améliorer l'expérience utilisateur tout en réduisant les tickets de support avec son ChatBot Instant Answers.

Évaluez les performances de votre documentation WordPress avec des analyses et des rapports

Nous avons mentionné que l'amélioration de votre documentation WordPress est un élément essentiel de la mise en place d'une meilleure documentation. La meilleure façon de le faire est d'évaluer les performances de la documentation de votre plugin avec des analyses et des rapports. 

Vous pouvez configurer des analyses pour évaluer les performances de votre base de connaissances en accédant à wp-admin-> BetterDocs -> Paramètres. Dans l'onglet `` Général '', vous pouvez définir la façon dont vous souhaitez que vos analyses soient appliquées et également choisir d'activer ou de désactiver Bot Analytics.

BetterDocs

Vous pouvez vérifier les informations de vos analyses à partir de BetterDocs -> Analytique. Cela vous donnera une évaluation claire et perspicace de la performance de votre documentation WordPress.

BetterDocs

Migrez facilement du plug-in de documentation existant vers BetterDocs

Même si vous utilisez déjà un plugin de documentation différent, ne vous inquiétez pas! Vous pouvez facilement migrer vers BetterDocs en quelques clics. Pour plus de détails, consultez ce guide d'aide sur les détails et apprendre à migrer à BetterDocs. 

🎁 Grab An Exclusive for only WordPress Plugin Developer: BetterDocs Pro​ for FREE

Cela conclut notre guide pour une meilleure documentation WordPress pour tout développeur de plugin.

Si vous êtes un développeur de plugins et que vous souhaitez obtenir un aperçu exclusif de tout ce que BetterDocs a à offrir, alors vous avez de la chance aujourd'hui! Nous donnons une licence gratuite pour BetterDocs Pro uniquement pour les développeurs de plugins WordPress qui ont un plugin freemium WordPress et qui souhaitent créer une page de documentation, puis remplissez ce formulaire ci-dessous et nous vous contacterons.

Accédez à la licence BetterDocs PRO
Afshana Diya

Afshana Diya

Afshana is CMO at WPDeveloper where she is helping to accelerate business growth & the company is currently reached 800,000+ users from 190+ countries. She is also co-organizer of WordCamp Dhaka & Product Hunt Meetup, Global Community Deputy for WordPress.

Partagez cette histoire

Partager sur facebook
Partager sur twitter
Partager sur linkedin
Partager sur pinterest
Partager sur whatsapp

Laisser un commentaire

Votre adresse de messagerie ne sera pas publiée. Les champs obligatoires sont indiqués avec *