Comment ajouter de la documentation dans WordPress (étape par étape)

La création d’une documentation complète sur votre site WordPress est essentielle si vous souhaitez guider et soutenir efficacement vos utilisateurs. Une documentation appropriée peut les aider à comprendre comment utiliser vos produits ou services, ce qui se traduit par une meilleure expérience globale.

Au cours des 16 dernières années, nous avons construit plusieurs sites où nous vendons des extensions et des cours et nous ajoutons toujours une documentation détaillée pour soutenir nos utilisateurs. Nous couvrons tout, du processus d’installation et des guides de fonctionnalités aux détails des addons, visant à rendre le dépannage facile.

Nous avons remarqué que cela aide les utilisateurs à résoudre leurs propres problèmes et renforce la confiance dans nos produits, car ils se sentent rassurés de savoir que nous avons clairement organisé toutes les informations clés.

C’est pourquoi nous recommandons d’ajouter de la documentation, que vous gériez une entreprise axée sur les produits, un site d’adhésion ou une plateforme éducative.

Dans cet article, nous allons vous montrer comment ajouter facilement de la documentation dans WordPress, étape par étape. Notre guide sera très facile à suivre et ne nécessitera aucune connaissance en codage.

Pourquoi ajouter de la documentation dans WordPress ?

La documentation est le contenu de votre site WordPress qui fournit des informations sur la façon d’utiliser vos produits/services, y compris leurs fonctionnalités, les nouvelles versions, les modules complémentaires, et plus encore.

La documentation de WordPress peut comprendre des tutoriels, des guides, des FAQ, des bases de connaissances et de la documentation sur les API.

Par exemple, si vous avez un magasin en ligne qui vend de la musique, vous pouvez créer une documentation expliquant comment télécharger la musique, renouveler les licences ou créer une playlist.

L’ajout de documentation dans WordPress peut améliorer l’expérience utilisateur en permettant aux clients de découvrir plus facilement les différentes fonctionnalités des produits, de trouver les causes de leurs problèmes et de les déboguer eux-mêmes. Cela peut même réduire le nombre de tickets de support pour votre site.

La documentation peut également améliorer vos Classements du contenu en fournissant du contenu supplémentaire que Google et d’autres moteurs de recherche peuvent indexer et afficher dans les résultats de recherche.

Cela dit, voyons comment ajouter facilement de la documentation dans WordPress, étape par étape.

Comment ajouter de la documentation dans WordPress

Vous pouvez facilement ajouter de la documentation dans WordPress à l’aide de l’extension Heroic KB.

C’est la meilleure extension de base de connaissances WordPress sur le marché qui ajoute une base de connaissances consultable à votre site existant. Il est livré avec une fonctionnalité de recherche AJAX, un système de commande de contenu par glisser-déposer, des fichiers joints aux articles, et bien plus encore.

De plus, l’outil dispose de statistiques intégrées et d’une fonctionnalité de retour d’information de la part des utilisateurs qui vous permet de recueillir des informations afin d’améliorer votre documentation existante.

Il est même doté d’une fonctionnalité d’assistant IA Outil de personnalisation, qui vous permet d’ajouter facilement un chatbot personnalisé à votre site. Le chatbot est formé directement à partir de votre base de connaissances afin qu’il puisse fournir des responsive précises et personnalisées à vos clients/clientes.

Étape par étape : Configurer les Réglages généraux de Heroic KB

Tout d’abord, vous devez installer et activer l’extension Heroic KB. Pour des instructions détaillées, consultez notre guide étape par étape sur l’installation d’une extension WordPress.

Une fois activé, visitez la page  » Réglages  » de Heroic KB dans la colonne latérale de l’administrateur WordPress et passez à l’onglet  » Licence et mises à jour « .

Saisissez ici la clé de licence de votre extension et cliquez sur le bouton « Enregistrer les modifications ». Vous pouvez obtenir ces informations à partir de votre compte sur le site de Heroic KB.

Après avoir ajouté la clé de licence, passez à l’onglet « Home & General » dans la colonne de gauche. Vous devez sélectionner la page d’accueil de la documentation dans le menu déroulant situé à côté de l’option « KB Home Page ».

Si vous choisissez l’option « Archive de la base de connaissances », Heroic KB créera une nouvelle page pour votre documentation à l’adresse www.example.com/knowledge-base.

Toutefois, si vous souhaitez ajouter votre documentation sur une page que vous avez déjà créée, vous pouvez choisir cette option dans le menu déroulant.

Ensuite, vous pouvez également saisir le texte de l’en-tête qui s’affichera en haut de votre page de documentation.

Une fois cette opération effectuée, il vous suffit de cocher l’option « Fil d’Ariane » pour l’activer.

Dans une base de connaissances, les fils d’ariane sont un type d’aide à la navigation qui permet aux utilisateurs de voir comment ils sont arrivés à la page actuelle et de naviguer vers les pages précédentes comme ceci : Accueil  » Produits  » Installation.

Ensuite, vous pouvez également choisir le nombre de colonnes de catégories à afficher sur votre page de documentation dans le menu déroulant.

Cochez ensuite l’option « Afficher le nombre de catégories de KB » si vous souhaitez afficher le nombre d’articles rédigés pour chaque catégorie.

Choisissez ensuite le nombre d’articles à afficher sous chaque catégorie sur la page d’accueil de la documentation dans le menu déroulant « KB Category Article ».

Vous pouvez ensuite cocher les cases « Masquer les catégories vides » et « Masquer les articles non classés ». Ainsi, ni les catégories actuellement vides ni les articles non classés ne seront affichés sur la page d’accueil de votre documentation.

Ensuite, vous pouvez restreindre l’accès à votre documentation WordPress aux utilisateurs/utilisatrices connectés uniquement à partir du menu déroulant  » Restreindre l’accès « .

Une fois que vous avez terminé, il vous suffit de cliquer sur le bouton « Enregistrer les modifications » pour stocker vos réglages.

Étape 2 : Configurer les catégories, les identifiants et les réglages des articles

Passez maintenant à l’onglet « Catégories et identifiés » dans la colonne de gauche. Ici, vous pouvez choisir comment trier vos catégories et vos identifiants et le nombre d’articles qui seront affichés pour chaque taxonomie.

Vous pouvez également cocher la case « Extrait d’article » si vous souhaitez afficher un extrait d’article sous chaque archive de taxonomie dans votre documentation.

Ensuite, il suffit de cliquer sur le bouton « Enregistrer les modifications » et de passer à l’onglet « Article ».

À partir de là, vous pouvez cocher différentes cases pour activer une section de commentaires sous vos articles de documentation, afficher les biographies des auteurs/autrices ou afficher d’autres articles similaires sous chaque tutoriel.

Après avoir fait votre choix, il vous suffit de cliquer sur le bouton « Enregistrer les modifications » pour stocker vos réglages.

Étape 3 : Configurer la recherche dans la base de connaissances et les réglages des slugs

Passez maintenant à l’onglet « Recherche » et cochez la case « Accent sur la recherche » si vous souhaitez que la souris de l’utilisateur se positionne automatiquement sur le champ de recherche de la documentation lors du chargement de la page.

Ensuite, vous pouvez également ajouter un texte de remplacement pour la boîte de recherche, afficher des extraits d’articles dans les résultats de la recherche et même permettre à l’extension de mettre en évidence le terme recherché dans les résultats.

Une fois que vous avez fait cela, cliquez sur « Enregistrer les modifications » et passez à l’onglet « Limaces ».

Ici, vous pouvez ajouter des slugs pour les articles, les catégories et les identifiés de votre documentation.

Après avoir fait votre choix, cliquez sur le bouton « Enregistrer les modifications » pour stocker vos réglages.

Étape par étape : Réglages de la colonne latérale et du style de la base de connaissances

Ensuite, passez à l’onglet « Colonnes latérales » pour sélectionner une mise en page pour les colonnes latérales de vos pages de documentation.

Vous pouvez choisir différentes positions pour la colonne latérale de l’accueil, la colonne latérale des catégories et la colonne latérale des articles. Vous pouvez même cocher l’option « Sticky Article Sidebar ? » pour activer une colonne latérale épinglée pour les pages.

Une fois cela fait, cliquez sur « Enregistrer les modifications » et passez à l’onglet « Styles ».

À partir de là, vous pouvez sélectionner la largeur de votre documentation, la couleur des liens, le style de l’en-tête et la couleur du texte selon vos préférences.

Il suffit ensuite de cliquer sur le bouton « Enregistrer les modifications ».

Étape par étape : Configurer les retours sur les articles et les réglages des e-mails

Ensuite, vous devez passer à l’onglet  » Retour sur l’article  » et cocher l’option  » Activer le retour  » pour permettre aux utilisateurs/utilisatrices d’évaluer vos articles.

Vous pouvez même ajouter un système de vote (upvote/downvote) pour votre documentation WordPress en cochant ces cases. Cela vous permet aux utilisateurs/utilisatrices de vous dire si votre documentation aide à résoudre leurs problèmes sur l’interface publique.

Cliquez ensuite sur le bouton « Enregistrer les modifications » pour stocker vos réglages.

Passez maintenant à l’onglet « Rapports par e-mail » dans la colonne de gauche et cochez la faculté « Activer les rapports par e-mail » si vous souhaitez que Heroic KB vous envoie des rapports hebdomadaires sur votre documentation.

Ce rapport indiquera le nombre total de vues et l’évaluation moyenne des articles de votre documentation et affichera même une liste des articles les mieux notés et les plus appréciés pour la semaine en question.

Une fois que vous avez fait cela, ajoutez votre adresse e-mail d’administrateur dans le champ « Destinataires du rapport ». Vous pouvez même ajouter plusieurs adresses e-mail si vous le souhaitez.

Cliquez ensuite sur le bouton « Enregistrer les modifications » pour stocker vos réglages.

Maintenant que vous avez défini tous les Réglages de l’extension Heroic KB, il est temps de commencer à créer de la documentation pour votre site.

Étape par étape : Créer une documentation pour votre site WordPress

Vous pouvez créer des articles pratiques, des bases de connaissances, des guides et des FAQ pour votre documentation.

Pour commencer à créer un nouveau document, rendez-vous sur la page Heroic KB  » Ajouter un nouvel article depuis le tableau de bord WordPress.

Cela ouvrira l’éditeur de contenu WordPress, où vous pouvez ajouter un Titre pour votre article de documentation et commencer à rédiger le contenu. Vous pouvez également cliquer sur le bouton d’ajout de bloc ‘+’ dans le coin supérieur gauche pour ajouter différents blocs à votre contenu.

Une fois que vous avez rédigé l’article pour la documentation, vous devez déplier l’onglet « Catégories » dans le tableau de bord et cliquer sur le lien « Ajouter une nouvelle catégorie d’article ».

Ensuite, il suffit de créer une catégorie pour l’article que vous êtes en train de rédiger.

Déployez ensuite la section « Identifiants » dans le panneau de blocs et ajoutez autant d’identifiants que vous le souhaitez pour votre article de documentation.

Vous pouvez même ajouter un extrait à l’article en dépliant l’onglet « Extrait ».

Ensuite, déplier l’onglet « Discussion » et décocher l’option « Permettre les commentaires » si vous souhaitez désactiver les commentaires pour cet article. Si vous souhaitez laisser les utilisateurs/utilisatrices ajouter des commentaires, vous pouvez laisser ce paramètre tel quel.

Vous pouvez également ajouter des fichiers joints à vos articles dans la documentation. Pour ce faire, défilez vers le bas jusqu’à la section  » Options de l’article  » dans l’éditeur de blocs et cliquez sur le bouton  » Ajouter ou téléverser des fichiers « .

Cela lancera la médiathèque à partir de laquelle vous pourrez ajouter n’importe quel fichier joint.

Ensuite, cochez la case « Fichiers joints dans une nouvelle fenêtre » si vous souhaitez que les fichiers joints à l’article s’ouvrent dans une nouvelle fenêtre lorsque vous cliquez dessus.

Vous pouvez également désactiver la fonctionnalité « upvote/downvote » pour des articles spécifiques si vous le souhaitez en défilant vers le bas jusqu’à la section « Options de vote ».

Cochez ici l’option « Désactiver le vote » pour désactiver le système de vote par le haut/par le bas pour cet article spécifique.

Enfin, cliquez sur le bouton « Publier » en haut de la page pour publier votre article en tant que documentation.

Répétez le processus pour ajouter plusieurs entrées pour votre documentation dans différentes catégories.

Une fois que vous avez fait cela, vous pouvez facilement voir la documentation en visitant la page www.example.com/knowledge-base, ou vous pouvez visiter la page personnalisée que vous avez choisie pour votre documentation.

Étape par étape : Modifier l’ordre des articles et des catégories de votre documentation

Avec Heroic KB, vous pouvez également modifier l’ordre des articles affichés dans votre base de connaissances WordPress. Pour ce faire, rendez-vous sur la page Heroic KB Article Ordering depuis le tableau de bord WordPress.

Choisissez ici la catégorie pour laquelle vous souhaitez modifier l’ordre des articles. Il vous suffit ensuite de faire glisser les articles pour les réorganiser selon vos préférences.

Une fois que vous avez terminé, n’oubliez pas de cliquer sur le bouton « Enregistrer la commande » pour stocker vos paramètres.

Pour modifier l’ordre des catégories affichées sur votre page de documentation, visitez la page Heroic KB  » Category Ordering à partir de la colonne latérale de l’administrateur WordPress.

Une fois que vous y êtes, vous pouvez réorganiser l’ordre des catégories en les faisant glisser et en les déposant. Après avoir effectué les modifications, cliquez sur le bouton « Enregistrer l’ordre » pour stocker vos paramètres.

Vous avez bien créé une documentation pour votre site et modifié la catégorie et l’ordre des articles.

Bonus : Ajouter une section FAQ à votre site WordPress

L’ajout d’une documentation WordPress est un excellent moyen d’aider vos utilisateurs/utilisatrices à trouver les informations dont ils ont besoin. Vous pouvez également ajouter des FAQ (questions fréquemment posées) avec vos publications de blog pour répondre aux questions similaires liées à votre contenu.

Cela peut augmenter l’engagement des utilisateurs sur votre blog WordPress et renforcer la confiance et la crédibilité de vos utilisateurs en leur montrant que vous comprenez leurs questions et leurs inquiétudes.

De plus, les FAQ peuvent améliorer votre classement SEO en vous permettant d’utiliser des mots-clé de longue traîne que les utilisateurs/utilisatrices recherchent couramment dans les moteurs de recherche.

Vous pouvez facilement ajouter des FAQ à votre site en utilisant All in One SEO (AIOSEO). C’est la meilleure extension WordPress SEO sur le marché qui vous permet d’optimiser facilement votre site web pour améliorer le classement dans les moteurs de recherche.

AIOSEO est même doté d’un bloc FAQ convivial qui peut être directement ajouté à l’éditeur de blocs, où vous pouvez saisir des questions et des réponses pour votre section FAQ.

Le plugin vous permet également de personnaliser votre section FAQ à partir du panneau de bloc, y compris sa couleur de texte, sa couleur d’arrière-plan, sa typographie et son conteneur de titre, ce qui fait d’AIOSEO le meilleur plugin WordPress de FAQ sur le marché.

De plus, l’extension est livrée avec un balisage de schéma de FAQ qui peut stimuler le classement de votre site et le taux de clics organiques en faisant apparaître vos questions fréquemment posées directement dans les résultats de recherche de Google.

Pour des instructions plus détaillées, consultez notre tutoriel sur l ‘ajout d’une section Foire aux questions dans WordPress.

Nous espérons que cet article vous a aidé à apprendre comment ajouter de la documentation sur WordPress. Vous pouvez également consulter notre guide du débutant sur la façon d’embaucher des assistants virtuels pour votre site WordPress et nos choix d’experts pour le meilleur logiciel de documentation technique pour WordPress.

Si vous avez aimé cet article, veuillez alors vous abonner à notre chaîne YouTube pour obtenir des tutoriels vidéo sur WordPress. Vous pouvez également nous trouver sur Twitter et Facebook.