Lancer votre premier centre d'aide

Un site de documentation est un centre d'aide hébergé créé à partir des articles de votre espace de travail, incluant une recherche, un assistant Demander à l'IA et les retours des lecteurs. Cet article vous guide de vos premiers articles jusqu'à un site en ligne à votre propre adresse. Chaque étape renvoie vers l'article contenant les détails.

Avant de commencer#

• Votre rôle : les propriétaires et administrateurs de l'espace de travail créent et configurent les sites de documentation. Les créateurs de contenu peuvent ajouter des pages, et les éditeurs peuvent publier. Voir qui peut faire quoi.
• Votre forfait : les sites de documentation sont disponibles sur tous les forfaits, y compris le forfait gratuit. Les forfaits Gratuit et Starter incluent 1 site ; le forfait Pro inclut 2 à 5 sites, selon le nombre de sièges. Voir Forfaits et limites des sites de documentation.
• Forfait gratuit : la publication nécessite une adresse e-mail vérifiée.

Construire étape par étape#

1. Rédigez vos premiers articles#

   Un site affiche des articles, alors commencez par en ajouter quelques-uns. Cliquez sur Créer, ouvrez l'onglet Article et choisissez un type : Article pratique, Dépannage, Procédure opérationnelle normalisée, Article de blog ou Mise à jour produit. Ajoutez un enregistrement depuis l'application de bureau, l'extension Chrome, un fichier importé, votre bibliothèque ou via Enregistrer avec l'IA, puis cliquez sur Générer l'article. Un article coûte généralement entre 5 et 15 crédits. Consultez Transformer un enregistrement en article.

   Vous avez déjà un centre d'aide ailleurs ? Vous pouvez l'importer lors de la création du site (étape suivante).

2. Créer le site de documentation#

   Cliquez sur Sites de documentation dans la barre latérale, puis sur Nouveau site de documentation. L'assistant comporte trois étapes :

   1. Nommez votre site : saisissez un Nom du site et vérifiez l'Adresse gratuite, qui se termine par .clevera.help. Choisissez la Langue du site.
   2. Que contient-il ? : choisissez Depuis une collection (chaque dossier devient une section), Choisissez le contenu, Démarrer à vide ou Importer depuis un autre outil.
   3. Personnalisez-le : ajoutez un Logotype, une Couleur de la marque, une Police et l'Apparence par défaut.

   Cliquez sur Créer le site. Lorsque vous partez d'un contenu existant, le site est publié immédiatement à son adresse gratuite et s'ouvre sur la Vue d'ensemble, avec une liste de contrôle Démarrer. Voir Créer un site de documentation.

3. Ajouter et organiser des pages#

   Ouvrez Pages dans la barre latérale du site pour ajouter des sections, ajouter des articles depuis votre bibliothèque, rédiger de nouvelles pages et définir leur ordre. La liste de contrôle demande au moins 5 pages. Voir Ajouter et organiser des pages.

4. Définir l'apparence#

   Ouvrez Apparence pour modifier le logotype, la couleur de la marque, le style du site, les polices et l'en-tête de votre page d'accueil. Un aperçu en direct affiche chaque modification. Configurez les menus d'en-tête et de pied de page dans Menu de navigation. Voir Personnaliser l'apparence d'un site de documentation et Configurer l'en-tête et le pied de page d'un site de documentation.

5. Activer l'assistant IA#

   L'assistant est désactivé sur un nouveau site. Allez dans Paramètres → Assistant IA, activez Afficher l'assistant, choisissez ce qui se passe Quand il ne peut pas répondre, et cliquez sur Enregistrer. Il répond uniquement à partir de vos pages publiées et liste ses sources. Les réponses ne coûtent aucun crédit ; votre forfait inclut un nombre mensuel de réponses (300 sur le forfait Gratuit). Voir Configurer l'assistant du site de documentation.

6. Choisir qui peut le lire#

   Chaque site est public par défaut. Pour le rendre privé, allez dans Paramètres → Accès et choisissez Mot de passe ou Connexion à l'espace de travail. Les sites privés nécessitent le forfait Pro ou supérieur. Voir Contrôler qui peut lire un site de documentation.

7. Publier#

   Cliquez sur Publier dans l'en-tête du site, vérifiez la liste des modifications et confirmez (le bouton indique, par exemple, Publier 3 modifications). Les lecteurs voient la nouvelle version en quelques secondes, et chaque version est conservée dans Publication afin que vous puissiez revenir en arrière. Publier automatiquement est activé pour les nouveaux sites : une fois le site en ligne, les modifications enregistrées sont publiées après environ deux minutes sans modification. Voir Publier un site de documentation.

8. Connecter votre propre domaine#

   Les domaines personnalisés nécessitent le forfait Starter ou supérieur. Ouvrez Domaine, saisissez un sous-domaine tel que help.example.com et cliquez sur Connecter. Ajoutez l'enregistrement CNAME indiqué par Clevera auprès de votre fournisseur de domaine, puis cliquez sur Vérifier maintenant. Le certificat prend généralement entre 5 et 30 minutes ; lorsque le statut est En ligne, l'adresse gratuite redirige vers votre domaine. Les domaines racines tels que example.com ne peuvent pas être connectés. Voir Connecter un domaine personnalisé à un site de documentation.

Laissez le Pilote automatique le construire#

Avec l'offre Pro et supérieure, le Pilote automatique peut créer et maintenir le centre d'aide pour vous. Cliquez sur Pilote automatique dans la barre latérale pour commencer ; consultez Obtenir l'accès au Pilote automatique. Seul le propriétaire de l'espace de travail ou un administrateur peut utiliser la recette de création.

Construire un centre d'aide à partir de votre application#

Dans Pilote automatique, cliquez sur la recette Construire un centre d'aide à partir de mon application, ou tapez "Construis-moi un centre d'aide" dans Que doit faire le Pilote automatique ?. L'agent Clevera affiche une carte de configuration. Cliquez sur Remplir les détails, ajoutez votre Site web et votre Adresse de l'application, choisissez une connexion et sélectionnez les langues du site.

Sous Centre d'aide existant, choisissez Démarrer à neuf, ou Importer et sélectionnez Intercom, Zendesk, Help Scout, GitBook, ReadMe, Mintlify, Document360, Docusaurus ou Un autre site de documentation. L'importation ne lit que les pages publiques et est gratuite. Notion et Confluence sont importés depuis les paramètres du site une fois qu'il existe.

La tâche s'exécute en quatre étapes : Marque, Site et vidéos, Articles, et Révision et publication. La planification est gratuite. Vous voyez le plan de chaque étape et ses crédits, et rien ne s'exécute tant que vous ne cliquez pas sur Exécuter. Une construction typique coûte entre 240 et 560 crédits et prend de 1 à 3 heures. Clevera ne publie jamais le site pour vous : à la dernière étape, vous choisissez les articles et cliquez sur Publier. Voir Construire un centre d'aide à partir de votre application avec le Pilote automatique.

Maintenir à jour lors de vos déploiements#

Une fois le site créé, la recette Maintenir mon centre d'aide à jour lors de nos déploiements surveille les versions ou les modifications fusionnées d'un dépôt, une page de journal des modifications ou une modification que vous décrivez. Chaque fois que quelque chose change, Clevera vérifie les vidéos et articles affectés et planifie les correctifs. Chaque exécution attend votre révision ; une exécution typique coûte entre 10 et 150 crédits. Voir Maintenir votre centre d'aide à jour lors de vos déploiements.

Connexe#