Le portail de la base de connaissances est le centre de contrôle pour la création, l’organisation et la gestion de tous les aspects de votre projet de documentation. De la rédaction d’articles à la structuration des catégories, en passant par la configuration de l’image de marque, des domaines et de la sécurité, le portail vous offre une visibilité et un contrôle complets. Il vous connecte également à des outils avancés tels que des arbres de décision interactifs, la documentation des API, les analyses et la gestion des commentaires, ce qui garantit que votre base de connaissances reste structurée, accessible et efficace.
Tout ce que vous créez ou configurez dans le portail façonne directement le site de la base de connaissances, c’est-à-dire la version avec laquelle vos utilisateurs finaux et lecteurs interagissent.
Dans le portail de la base de connaissances, vous pouvez :
Créez desCategory, des Articleet des Template
Gérer les fichiers, les comptes d’équipe et les lecteurs
Configurer l’image de marque, le domaine, la sécurité et bien plus encore pour le site de la base de connaissances
Voici quelques éléments que vous trouverez sur le portail de la base de connaissances :
Page d’aperçu
Documentation
Arbres de décision interactifs
Documentation de l’API
Gestionnaire d’évaluations
Analytique
Widgets
Conduire
Paramètres
Rechercher
Ouvrir le site
NOTE
Tout ce qui est créé et/ou configuré sur le Knowledge base portal affectera ce qu’un utilisateur final ou un lecteur verrait sur le Knowledge base site.
1. Overview page
La page Vue d’ensemble fournit une vue unifiée de votre projet Document360. Il affiche l’activité de votre contenu, les tâches attribuées, les performances de l’article, les commentaires et les indicateurs de projet en fonction de votre rôle et de votre sélection d’espace de travail, ce qui vous permet de surveiller et de gérer votre travail de documentation à partir d’une seule page. Vous pouvez passer la souris sur l’icône Accueil pour accéder rapidement aux pages Vue d’ensemble, Tâches, Récents, Favoris et Corbeille .
À partir de la page Vue d’ensemble, vous pouvez :
Suivez les tâches en attente en fonction de l’état du flux de travail, des rappels de révision ainsi que des commentaires qui vous sont attribués dans le gestionnaire de commentaires.
Accédez et gérez les articles récemment mis à jour, ainsi que les articles ou dossiers favoris pour une référence rapide.
Surveillez les indicateurs de performance des articles tels que les vues, les lectures, les likes et les aversions.
Répondez aux commentaires en ligne ou aux @mentions des articles auxquels vous avez contribué.
En tant qu’administrateur, affichez les données critiques du projet telles que le nombre d’utilisateurs et de lecteurs, l’utilisation du stockage, les recherches ayant échoué et la sauvegarde la plus récente.
Chaque section est présentée sous la forme d’une carte distincte et comprend des actions de filtrage, de recherche et d’accès rapide. Cela vous donne un aperçu rapide de votre documentation et vous permet d’agir sans vous déplacer.
NOTE
La visibilité de certaines cartes et actions dépend de votre rôle dans le portail et le contenu, ainsi que des fonctionnalités disponibles dans le cadre de votre abonnement Document360.
2. Documentation
La page Documentation est l’endroit où vous allez créer et gérer la structure de dossiers de l’arborescence des catégories qui gardera vos articles organisés. Démarrez une base de connaissances en créant un Category , puis remplissez-les avec des Subcategory et Articles.
Faites glisser et déposez des catégories et des articles pour les réorganiser, les masquer, les renommer et les supprimer à l’aide du menu Plus d’options () qui s’affiche lorsque vous passez votre souris sur n’importe quel élément de l' .
a. All articles
La section Tous les articles vous permet d’effectuer des opérations en masse (publication, masquage, déplacement, suppression, etc.) sur plusieurs articles à la fois, ce qui vous fait gagner du temps par rapport à l’exécution de ces actions individuellement sur chaque article.
b. Recent
La page Recent vous permet de revenir rapidement aux articles sur lesquels vous avez travaillé récemment. Il suit automatiquement les articles que vous avez consultés ou mis à jour au cours des 30 derniers jours.
c. Starred
La section Favoris contient les articles que vous avez marqués comme favoris. Cela permet d’accéder rapidement aux articles importants.
d. Recycle bin
La section Corbeille comprend une liste des articles et des catégories supprimés au cours des 30 derniers jours. Vous pouvez restaurer les catégories et les articles supprimés dans ce délai.
e. Site builder
Vous pouvez personnaliser l’apparence de votre site de base de connaissances à partir de la section Créateur de site .
Vous pouvez choisir le logo et l’icône de votre choix pour votre site de base de connaissances. À partir de cette section, vous pouvez également personnaliser les couleurs de la marque, la police et le style du site.
f. Content tools
Les outils de contenu, comme leur nom l’indique, contiennent tous les outils nécessaires à la gestion du contenu de votre article et de votre projet.
Vous pouvez gérer les fonctionnalités suivantes à partir de ce menu.
Réutilisation du contenu : gérez toutes les variables, les extraits, les modèles et le glossaire.
Importation et exportation - Gérez toutes vos activités d’importation et d’exportation de projets à partir de cette section. Dans cette section, vous pouvez exporter votre contenu au format PDF ou migrer le contenu d’autres outils de gestion des connaissances.
Éléments essentiels du contenu - Gérez la recherche et le remplacement au niveau du projet, examinez les rappels, les balises et les descriptions SEO à partir du menu.
Gestionnaire de commentaires - Affichez et répondez aux articles sans commentaires de recherche à partir d’un module unifié.
Concepteur de flux de travail - Créez vos statuts et séquences de flux de travail à partir de cette section.
g. Categories & Articles (Gestionnaire de catégories)
La rédaction et la publication d’articles dans Document360 sont simples : choisissez votre catégorie, créez un article (titre et slug), ajoutez SEO détails et publiez-le dans votre base de connaissances.
Lorsque vous mettez à jour ou edit an article (Fork), Document360 crée un nouveau Article revision sans affecter l’espace de travail en direct/public.
Vous pouvez apporter les modifications nécessaires et republier lorsque vous êtes prêt. Vous pouvez identifier les articles mis à jour dans le site de la base de connaissances à l’aide de la Article status indicators. Document360 gère tous les espaces de travail pour vérifier les différences entre eux.
3. Interactive decision trees
Les arbres de décision interactifs vous permettent de guider les lecteurs à travers des décisions étape par étape ou des processus de dépannage à l’aide d’une logique visuelle à embranchements. Chaque étape peut inclure du texte, des images, des vidéos et des entrées interactives pour simplifier les flux de travail complexes.
Vous pouvez utiliser ce module pour créer des procédures pas à pas structurées pour l’intégration, le dépannage, les tutoriels ou les processus internes. Une fois publiés, les arbres de décision apparaissent sous forme d’articles interactifs sur votre site de base de connaissances et fonctionnent de manière transparente sur toutes les tailles d’écran.
Pour accéder à ce module, cliquez sur Arbre de décision interactif dans le panneau de navigation de gauche du portail de la base de connaissances.
4. API documentation
La fonctionnalité de documentation de l’API dans Document360 fournit une solution complète pour la création et la gestion des références d’API. Cette fonctionnalité vous permet de créer une documentation d’API de haute qualité qui aide les utilisateurs à comprendre et à utiliser efficacement vos API.
Ce module API inclut la fonctionnalité Essayez-le ! , qui permet aux utilisateurs de tester les points de terminaison de l’API dans le site de la base de connaissances. Vous pouvez créer des versions dédiées de la documentation de votre API. Cette fonctionnalité fournit une interface intuitive pour le téléchargement de références d’API sous forme d’URL ou de fichiers JSON/YAML. Après avoir téléchargé la définition OpenAPI, les articles interactifs sur les points de terminaison de l’API sont créés dans le portail de la base de connaissances. Désormais, les utilisateurs finaux peuvent accéder à l’option Essayer ! avec les points de terminaison, les paramètres et les réponses disponibles dans la documentation de l’API sur le site de la base de connaissances.
5. Feedback manager
Le gestionnaire de commentaires vous permet de suivre et de répondre aux commentaires des utilisateurs recueillis à partir des articles et des requêtes de recherche Eddy AI.
Il comprend :
Commentaires sur les articles : affiche les mentions J’aime, les aversions et les commentaires des utilisateurs sur des articles ou des catégories spécifiques. Utilisez-le pour améliorer la qualité et la clarté de votre documentation.
Commentaires d’Eddy AI : Capture les commentaires lorsque les utilisateurs interagissent avec Eddy AI, qu’ils aient trouvé les résultats utiles ou qu’ils n’aient reçu aucun résultat. Utilisez-le pour identifier les lacunes de contenu ou affiner la pertinence de la recherche.
Vous pouvez attribuer des commentaires aux membres de l’équipe, mettre à jour les statuts, afficher les discussions internes et exporter les données des commentaires à des fins d’analyse. Pour ouvrir le Gestionnaire d’évaluations, sélectionnez Gestionnaire d’évaluations dans le panneau de navigation de gauche.
6. Analytics
Document360 comprend un menu Analytics avec des outils pour vous aider à comprendre l’engagement de l’utilisateur final avec votre base de connaissances.
Voici la liste des métriques et des modules que vous pouvez suivre avec l’outil Analytics :
Articles de presse
Eddy AI
Rechercher
Comptes d’équipe
Rétroaction
Statut des liens
Page introuvable
Déflecteur de billets
7. Widget
Le widget Base de connaissances (anciennement appelé Assistant de base de connaissances ou Assistant in-app) aide les lecteurs à trouver leurs réponses sans quitter votre site ou votre application.
Vous pouvez mettre à jour les paramètres suivants du widget Base de connaissances à partir de ce menu.
Installation et configuration
Custom CSS
JavaScript personnalisé
Mappage d’URL
8. Drive
Stockage centralisé et basé sur le cloud pour les projets Document360 qui stocke et permet aux membres de l’équipe de gérer tous les artefacts (fichiers) de la base de connaissances. Si vous avez déjà utilisé d’autres poids lourds, tels que Google Drive ou OneDrive, il devrait être relativement facile de s’habituer aux fonctions de Document360 Drive. Vous pouvez accéder à votre Drive en cliquant sur l’icône Drive dans le menu de gauche.
9. Settings
Vous pouvez définir et configurer tous les aspects du projet et de la base de connaissances dans les paramètres du projet , tels que l’invitation de membres de l’équipe, la modification des paramètres de notification, la configuration des domaines, la configuration des redirections d’articles, etc.
Les différentes fonctionnalités sont répertoriées sous les classifications suivantes dans le menu Paramètres :
Portail de la base de connaissances
Site de la base de connaissances
Utilisateurs et sécurité
Fonctionnalités de l’IA
10. Search
Un espace dédié à la recherche de l’ensemble du contenu du projet est désormais disponible sur le portail de la base de connaissances. Effectuez une recherche combinée dans tous les espaces de travail et toutes les langues simultanément. La barre de recherche est disponible en haut de tous les modules et pages du portail de la base de connaissances.
Le moteur de recherche fonctionne de la même manière que les autres fonctionnalités de recherche du portail. Saisissez le mot-clé et affinez les résultats à l’aide de filtres tels que l’espace de travail, la langue, la visibilité, les balises et la plage de dates. Vous pouvez afficher un aperçu de la page de l’article/de la catégorie, puis afficher un aperçu de l’article ou accéder à l’article dans le Editor.
Comme la recherche est effectuée universellement dans le projet, elle couvre les fichiers. Les utilisateurs peuvent basculer entre la recherche d’articles et la recherche Drive à l’aide des onglets situés sous la barre de recherche.
11. Ouvrir le site
L’action Ouvrir le site () permet d’accéder au site de la base de connaissances et de l’afficher. En cliquant sur l’icône, vous accédez au site de la base de connaissances de l’espace de travail actuellement ouvert dans votre portail de base de connaissances. Si vous êtes dans l’espace de travail de documentation de l’API, l’action Ouvrir le site vous amènera à la page d’accueil de la documentation de l’API. Si votre site de documentation API n’a pas de page d’accueil, vous serez dirigé vers la première page d’article ou de catégorie de la documentation API.
