Le site de la base de connaissances est la partie accessible aux lecteurs de votre projet Document360. C’est le site web publié où vos lecteurs, clients ou membres d’équipe vont chercher et lire votre documentation.
Tout ce que vous créez et configurez dans le portail de la base de connaissances, comme les articles, les catégories, le branding, la navigation, les paramètres du site, est ce qui façonne l’expérience sur le site de la base de connaissances.
Le site de la base de connaissances est accessible directement à vos lecteurs via l’URL de votre base de connaissances. Selon la configuration de votre projet, il peut être :
- Public - accessible à tous sans connexion
- Privé - accessible uniquement aux lecteurs connectés
- Mixte - certains contenus sont publics, d’autres nécessitent une connexion
Les lecteurs peuvent rechercher du contenu, parcourir des catégories, lire des articles, suivre des sujets qui leur tiennent à cèle, donner des retours et interagir avec Eddy AI, le tout sans jamais avoir besoin d’accéder au portail.
Caractéristiques principales
Le site de la base de connaissances comprend une gamme de fonctionnalités conçues pour améliorer l’accessibilité du contenu, la personnalisation et l’engagement des lecteurs.
| Caractéristiques | Description |
|---|---|
| Favoris | Les lecteurs connectés peuvent enregistrer des articles, des arbres de décision, des points de terminaison API et des catégories de pages en favori à l’aide de l’icône cœur (). ❤️ Tous les éléments sauvegardés sont accessibles depuis la section Favoris dans le panneau de gauche ou depuis leur profil. |
| Panneau droit personnalisable | Les administrateurs peuvent réorganiser les modules du panneau droit comme fichiers, balises, articles associés, et Dans cet article, en utilisant le glisser-déposer, et déplacer les articles associés entre le panneau droit et le pied de page de l’article. |
| En-tête épinglé sur le défilement | Les icônes clés des en-têtes telles que Thème, Profil, Sélecteur de langue, Recherche, Partage, Modifier, Exporter PDF, Imprimer, Suivre et Favoris restent visibles pendant que vous faites défiler de longs articles. |
| Télécharger des articles et des catégories au format PDF | Les lecteurs connectés peuvent télécharger en masse certains articles et catégories sous forme de fichiers PDF depuis le site de la base de connaissances dans des projets privés, facilitant ainsi l’accès hors ligne. |
| Historique des versions publiées | Les lecteurs peuvent consulter un historique structuré des versions des articles et des catégories de pages directement sur le site de la base de connaissances. Le journal de version affiche le numéro de version, la date de publication, l’éditeur et le résumé de la version sélectionnée, accessibles via le menu Plus d’options ( ) dans l’article. La visibilité est contrôlée au niveau du projet et peut être contournée par article. |
| Téléchargement PDF depuis les notifications | Les PDF exportés sont disponibles en téléchargement direct depuis la section Notifications. Aucune dépendance à l’email n’est requise. Les PDF sont disponibles pendant 30 jours à partir de la date de création. |
| Partagez des liens privés vers des articles | Générez des liens partagés et privés pour permettre aux utilisateurs externes tels que les évaluateurs, collaborateurs ou parties prenantes de consulter les articles sans avoir besoin d’accéder à votre base de connaissances. |
| Articles et catégories de suivi | Les lecteurs peuvent s’abonner aux mises à jour pour des articles ou catégories spécifiques et recevoir des notifications par e-mail concernant les changements. Disponible pour des projets publics et privés. |
| Reçus de lecture améliorés | Mettez en place des règles dynamiques pour les accusés de réception de lecture basés sur l’espace de travail, la catégorie ou le rôle de l’utilisateur. Effectuez des opérations en gros et gérez efficacement la conformité. |
| Noms d’affichage localisés des espaces de travail | Personnalisez le nom de votre espace de travail par langue pour les sites de bases de connaissances multilingues, offrant ainsi une expérience native aux utilisateurs selon leur choix de langue. |
| Assistance de l’IA et chatbots Conversational Eddy | Eddy AI conserve le contexte de la conversation , permettant aux utilisateurs de poser des questions complémentaires et d’obtenir des réponses plus précises dans plusieurs langues. Également disponible dans le chatbot Eddy AI. |
| Analyses améliorées pour Eddy AI | Obtenez des informations plus approfondies sur les interactions des utilisateurs avec Eddy AI. Filtrez les conversations par sujet, retour ou statut de réponse. |
| Blocs de contenu conditionnel | Contrôlez la visibilité du contenu en fonction du pays, de l’IP, de la date, du type d’appareil ou du groupe de lecteurs, en personnalisant le contenu sans dupliquer les articles. |
| Écoutez les articles | Les lecteurs peuvent écouter le contenu d’un article grâce à la fonction Écouter (lire à voix haute), améliorant ainsi l’accessibilité et permettant le multitâche. |
| Amélioration de la recherche mondiale | Recherchez dans tous les espaces de travail, y compris ceux de l’API. Alternez entre les vues globale et les vues d’espace de travail individuel grâce à des filtres intelligents et des résultats unifiés. |
| Personnalisation du site | Les administrateurs peuvent personnaliser l’apparence et la mise en page du site de la base de connaissances – y compris les thèmes, les couleurs, la typographie, la navigation et le contenu de la page d’accueil grâce à la personnalisation du site. |
Disposition du site de la base de connaissances
Le site de la base de connaissances est organisé en sections distinctes. L’image ci-dessous montre la mise en page d’une page de documentation.
1. En-tête
L’en-tête traverse le haut de chaque page du site de la base de connaissances et est toujours visible.
.png)
| Élément | Ce que ça fait | |
|---|---|---|
| a | Logo | Affiche le logo de votre organisation. Cliquer dessus, vous naviguez vers la page d’accueil de la base de connaissances. |
| b | Espace de travail | Utilisez le menu déroulant pour naviguer entre les espaces de travail. Cliquez sur l’espace de travail de documentation de l’API pour accéder à la page d’accueil de la documentation de l’API. |
| c | Navigation principale | Liens configurés par votre administrateur pour aider les lecteurs à naviguer vers différentes pages depuis la page d’accueil ou le site de la base de connaissances. |
| d | Notifications ( ) | Affiche les articles récemment publiés et les notifications pour les PDF exportés, prêts à être téléchargés. Un badge indique le nombre non lu. |
| e | Reconnaissance, mention requise ( ) | Affiche des articles qui nécessitent une reconnaissance de lecture de la part du lecteur. |
| f | Thème | Alternez entre le thème du Système, les thèmes Lumière et les Ténèbres. Le thème clair est défini par défaut. |
| g | Langue | Sélectionnez la langue dans laquelle lire les articles, parmi la liste disponible. |
| h | Navigation secondaire | Des liens de navigation supplémentaires configurés par votre administrateur, généralement regroupés ou imbriqués. |
Si un seul langage est configuré pour un espace de travail, le menu déroulant du langage n’apparaîtra pas sur le site de la base de connaissances.
2. Volet de navigation gauche
Le panneau de navigation de gauche affiche la structure de votre base de connaissances, permettant aux lecteurs de parcourir les catégories et les articles. La barre de recherche en haut du volet permet aux lecteurs de rechercher des articles en utilisant des mots-clés ou Eddy AI — utiliser le raccourci Ctrl + K (Commande + K sur Mac). Pour plus d’informations, consultez l’article de recherche .
.png)
| Élément | Ce que ça fait | |
|---|---|---|
| A | Explorer les articles | Cliquez pour filtrer l’arbre de navigation par catégorie ou nom d’article. |
| B | Dissimuler la navigation | Cliquez pour faire replier le panneau gauche afin d’une vue plus large de l’article. |
| C | Vue arborescente | Affiche les catégories et les articles selon une structure hiérarchique en arbre. |
| D | Favoris | Une fois activés, les utilisateurs connectés peuvent marquer les articles, les arbres de décision et les points de terminaison comme favoris. Les éléments favoris apparaissent dans une section dédiée aux favoris. |
| E | Insigne de statut | Un petit badge de couleur sur chaque article indique son statut , comme badge Nouveau, Mis à jour ou personnalisé. |
| F | Plus d’options | Pour les projets privés et mixtes, passez la souris sur un article pour accéder à l’option Ajouter aux favoris. |
3. Section Article
La section article est l’endroit où le contenu de l’article sélectionné est affiché.
| Élément | Ce que ça fait |
|---|---|
| Chapelure | Affiche le chemin de navigation vers la catégorie et la sous-catégorie parentes. |
| Titre de l’article | Affiche le titre de l’article. |
| Lien copié | Copie l’URL de l’article dans le clipboard. |
| Insigne de statut | Affiche le statut de l’article comme Nouveau, Mis à jour ou badge personnalisé. |
| Date de l’article | Indique la date de publication ou dernière mise à jour. |
| Temps de lecture | Affiche un temps de lecture estimé basé sur le nombre de mots. |
| Contributeurs | Liste les membres de l’équipe ayant travaillé sur l’article. Cliquer sur l’avatar d’un contributeur ouvre sa page de contributeur affichant tous les articles sur lesquels il a travaillé. |
| Suivez | Permet aux lecteurs de s’abonner aux mises à jour des articles. Disponible pour les témoignages des lecteurs. |
| Favoris (❤️) | Ajoute ou retire l’article des favoris du lecteur. Disponible pour les utilisateurs connectés dans des projets privés. |
| Partager | Partagez l’article via Twitter, LinkedIn, Facebook ou par email. |
| Export PDF | Télécharge l’article ou la catégorie en PDF lorsqu’activé par l’administrateur. |
| Plus d’options () | Accédez à des options supplémentaires, notamment l’historique des versions et l’impression imprimée. L’historique des versions n’est visible que lorsque le journal des versions publié est activé pour l’article. |
| Résumé de l’article | Consultez un résumé généré par IA de l’article, propulsé par Eddy AI. |
4. Visualiseur d’images
Lorsque vous cliquez sur une image sur le site de la base de connaissances, elle s’ouvre dans un visualiseur d’images.
| Contrôle | Ce que ça fait | |
|---|---|---|
| a | Texte du titre | Affiche la légende de l’image, si elle est fournie. |
| b | Lien ouvert | Ouvre l’URL de l’image dans un nouvel onglet, si disponible. |
| c | Zoom back ( ) | Minimise l’image. |
| d | Zoom ( ) | Agrandit l’image. |
| e | Télécharger ( ) | Télécharge l’image dans un stockage local. |
| f | Fermer (X) | Ferme le visualiseur d’images. |
| g | Suivant ( ) | Passe à l’image suivante de l’article. |
| h | Précédent ( ) | Passe à l’image précédente. |
Vous pouvez aussi maintenir et faire glisser l’image pour la repositionner à l’écran. Cliquer n’importe où en dehors de l’image ferme le visualiseur.
5. Vitre droite
Le panneau de droite affiche des informations complémentaires à côté de l’article. Par défaut, les sections apparaissent dans cet ordre : Fichiers > Tags > Articles connexes > Dans cet article.
Les administrateurs peuvent personnaliser cet ordre en utilisant le glisser-déposer en naviguant dans Paramètres () > site de la base de connaissances > Paramètres d’article et SEO > section droite de l’article > Réordre des sections.
| Section | Ce qu’il montre | |
|---|---|---|
| a | Vitre de cachette | Ça fait glisser le volet droit pour une vue plus large de l’article. |
| b | Dossiers | Pièces jointes associées à l’article. |
| c | Tags | Tags appliqués à l’article. Cliquer sur une étiquette ouvre une page listant tous les articles associés à cette étiquette. |
| d | Dans cet article | Une liste des titres de l’article (précédemment appelée « Table des matières »). S’étend automatiquement lorsque l’article se charge. Il y a un défilement dédié aux listes de titres longs. |
| — | Articles connexes | Articles liés à la version actuelle. Les administrateurs peuvent déplacer cette section vers le pied de page de l’article si elles le souhaitent. |
Comportement des modules :
- Tous les modules supportent l’expansion et l’effondrement.
- Les modules avec plus d’éléments que la hauteur visible initiale montrent un Afficher plus de contrôle.
- Sur tablette et mobile, le panneau droit se replie dans un tiroir.
- Le dernier module dans le panneau de droite reste épinglé sur le défilement.
6. Pistage d’article
Le pied de page de l’article apparaît en bas de chaque article.
| Élément | Ce que ça fait | |
|---|---|---|
| a | Retour d’information | Les lecteurs peuvent cliquer sur Oui ou Non pour évaluer si l’article a été utile, et éventuellement laisser un commentaire. |
| b | Article précédent et suivant | Liens de navigation pour passer d’un article à l’autre dans la même catégorie. |
| c | Articles connexes | Articles liés à la version actuelle. Par défaut, cette section apparaît dans le pied de page. Les administrateurs peuvent le déplacer dans le volet droit en activant le bouton Afficher les articles liés sous Paramètres () > Base de connaissances site > Paramètres d’article et SEO > Droit de l’article. |
Autres pages sur le site de la base de connaissances
Au-delà des pages principales de documentation, le site de la base de connaissances comprend quelques pages supplémentaires que les lecteurs peuvent rencontrer.
Page de glossaire - Si votre projet utilise des termes de glossaire, les lecteurs peuvent accéder à une page de glossaire dédiée qui liste tous les termes définis par ordre alphabétique. Cette page est disponible à l’adresse https://yourdomain/docs/glossary-overview. Les administrateurs peuvent ajouter un lien vers le glossaire depuis l’en-tête, le pied de page ou la navigation secondaire. Pour plus d’informations, consultez la page de l’article sur le glossaire.
Page du contributeur - Cliquer sur l’avatar d’un contributeur sur n’importe quel article ouvre sa page de contributeur, qui liste tous les articles sur lesquels cette personne a travaillé dans le projet. Pour plus d’informations sur la gestion des contributeurs, consultez l’article sur les contributeurs.
Page des tags - Cliquer sur une étiquette sur un article ouvre une page dédiée listant tous les articles et pages de catégories associés à cette étiquette. Chaque tag a sa propre URL unique, ce qui aide également à la découverte SEO. Pour plus d’informations, consultez les tags d’article.