Plans d’appui à la création d’un nouveau projet
| Professional | Business | Enterprise |
|---|---|---|
Un projet dans Document360 sert de conteneur complet pour tous vos besoins en matière de documentation. Il encapsule vos articles, catégories et sous-catégories, la page d’accueil, les comptes d’équipe, les lecteurs et les groupes (pour les projets privés et mixtes), ainsi que les configurations ou paramètres personnalisés. Cette approche centralisée garantit que votre base de connaissances est organisée, facilement accessible et évolutive.
Comment créer un projet de base de connaissances dans Document360 ?
Les projets de Document360 sont conçus pour rationaliser votre processus de documentation, en offrant un moyen structuré et efficace de gérer vos informations. Que vous créiez des manuels d’utilisation, des documents de processus internes ou de la documentation API , un projet Document360 fournit le cadre nécessaire pour stocker, gérer et distribuer efficacement le contenu. Suivez ces étapes pour créer votre projet de base de connaissances.
Accéder au tableau de bord
Connectez-vous au portail Document360 avec votre compte pour accéder à la Dashboard.
Si vous êtes connecté et que vous êtes dans le portail de la base de connaissances d’un autre projet, cliquez sur l’icône Document360 en haut à gauche pour être redirigé vers le Dashboard.Cliquez sur le bouton +Projecten haut à droite pour créer un nouveau projet.
Choisissez votre cas d’utilisation
Sélectionnez votre cas d’utilisation principal pour Document360 en cliquant sur Démarrer.
Cas d'utilisation | Description |
Plateforme de base de connaissances | Vous pouvez créer un hub centralisé où toutes les connaissances et ressources de votre équipe sont stockées. Il aide votre équipe à trouver rapidement des réponses et améliore le libre-service client en lui fournissant un accès facile aux informations dont il a besoin. |
Documentation logicielle/Documentation technique | Vous pouvez organiser et maintenir efficacement toute votre documentation logicielle ou technique. Il aide votre équipe à documenter les fonctionnalités du produit, les API, les notes de version, etc., en s’assurant que les développeurs et les utilisateurs disposent d’informations claires et à jour. |
Documentation SOP | Vous pouvez créer des SOP détaillées que votre équipe peut suivre de manière cohérente. Il garantit que tout le monde adhère aux mêmes processus, réduit les erreurs et facilite l’intégration des nouveaux employés en leur fournissant des directives procédurales claires. |
Manuel | Vous pouvez développer des manuels d’utilisation complets qui guident vos clients ou les membres de votre équipe à travers les fonctionnalités et l’utilisation de votre produit. Il aide à réduire les demandes d’assistance en proposant des instructions étape par étape et des conseils de dépannage. |
Documentation de l’API | Documentez des informations détaillées sur les points de terminaison d’API, les formats de demande et de réponse, les méthodes d’authentification et des exemples. Cela permet aux développeurs de bien comprendre comment s’intégrer à vos API. La sélection de cette option vous redirigera vers le flux de configuration de l’API. |
Autrui | Choisissez cette option si votre cas d’utilisation n’entre pas dans les catégories prédéfinies. Vous pouvez personnaliser votre base de connaissances en fonction des besoins spécifiques de l’organisation ou du projet. |
Sélectionnez un modèle
Sélectionnez le type de contenu que vous allez créer dans votre projet Document360. Vous pouvez choisir jusqu’à deux modèles qui répondent à vos besoins.
NOTE
En fonction de votre sélection, ces modèles seront intégrés à votre projet lors de sa création. Cependant, votre sélection ne vous empêche pas d’utiliser d’autres fonctionnalités ou de créer différents types de contenu.
Si vous avez sélectionné la documentation de l’API comme cas d’utilisation, vous ignorerez cette étape et serez redirigé vers la configuration de l’API à la place.
Modèles de plateforme de base de connaissances
Si vous avez sélectionné la plate-forme de base de connaissances à l’étape 3, vous pouvez choisir deux modèles dans la liste ci-dessous.
Modèle | But |
Guides de démarrage | Aidez les nouveaux utilisateurs à comprendre et à utiliser rapidement votre produit grâce à des instructions claires et détaillées. Cela garantit une expérience d’intégration fluide. |
Guides pratiques | Fournissez des instructions détaillées pour des tâches spécifiques, permettant aux utilisateurs d’utiliser et d’explorer pleinement et efficacement les fonctionnalités de votre produit. |
Foire aux questions | Répondez aux questions courantes à n’importe quelle étape du parcours utilisateur, en aidant les utilisateurs à trouver des réponses rapides et en réduisant les demandes d’assistance. |
Politique et procédures | Décrivez les protocoles organisationnels essentiels, aidant les utilisateurs à comprendre et à respecter efficacement les directives de l’entreprise. |
Modèles de documentation logicielle/technique
Si vous avez sélectionné Logiciel/Documentation technique à l’étape 3, vous pouvez choisir deux modèles dans la liste ci-dessous.
Modèle | But |
Notes de mise à jour | Tenez les utilisateurs informés des mises à jour, des nouvelles fonctionnalités, des corrections de bogues et des améliorations à chaque version du logiciel. |
Documentation de conception de logiciels (SDD) | Décrire l’architecture et la conception du logiciel, y compris les diagrammes et les spécifications pour les conseils de développement. |
Documentation relative aux exigences logicielles | Décrivez l’objectif, les fonctionnalités et l’environnement du logiciel pour vous assurer que le développement s’aligne sur les objectifs du projet. |
Documentation des exigences du produit (PRD) | Définissez l’objectif, la valeur et les fonctionnalités du produit pour répondre aux besoins des utilisateurs et aux objectifs commerciaux. |
Documentation du processus | Étapes et procédures détaillées impliquées dans le développement de logiciels pour normaliser les flux de travail et améliorer l’efficacité. |
Guide de l’utilisateur | Donnez des instructions complètes sur l’utilisation de votre produit, couvrant toutes les caractéristiques et fonctionnalités. |
Modèles de documentation SOP
Si vous avez sélectionné la documentation SOP à l’étape 3, vous pouvez choisir des modèles dans la liste ci-dessous.
Modèle | But |
Politiques et procédures de conformité | Assurez-vous que votre organisation respecte les exigences réglementaires en documentant les politiques qui appliquent la conformité. |
Opération SOP | Améliorez l’efficacité et la productivité en normalisant les procédures opérationnelles dans l’ensemble de votre organisation. |
Modèles de manuels d’utilisation
Si vous avez sélectionné le manuel de l’utilisateur à l’étape 3, vous pouvez choisir deux modèles dans la liste ci-dessous.
Modèle | But |
Manuel d’installation | Fournit toutes les informations de configuration nécessaires, y compris la vue d’ensemble du produit, les spécifications et les instructions de montage, garantissant un démarrage en douceur de la plate-forme de base de connaissances. |
Manuel | Offre des instructions de montage et d’utilisation étape par étape avec des schémas et des avertissements de sécurité, idéaux pour une configuration précise et des avertissements de sécurité pour une utilisation correcte. |
Manuel d’entretien | Fournissez des instructions détaillées pour les procédures d’entretien, de dépannage et de réparation régulières afin de garantir des performances optimales. |
Manuel de formation | Fournit des conseils complets sur l’installation, le fonctionnement et le dépannage, ainsi qu’une assistance pour la formation des utilisateurs et l’utilisation efficace de la plate-forme. |
Manuel d’utilisation | Fournir des instructions détaillées pour la maintenance et le dépannage quotidiens, assurant ainsi une gestion efficace et continue de la plateforme de base de connaissances. |
Personnalisez votre base de connaissances
Entrez l’URL de votre entreprise. Document360 analysera votre site et utilisera l’IA pour générer du contenu pertinent, des éléments de marque et une documentation structurée.
Si vous souhaitez sauter cette étape, le domaine sera par défaut celui lié à votre e-mail d’enregistrement.
Directives de la marque
Le nom de votre projet, la langue par défaut, le logo de votre marque et les couleurs de votre marque seront automatiquement définis en fonction de l’URL que vous avez fournie. Cependant, vous pouvez modifier les champs si nécessaire.
Les paramètres de langue de votre navigateur déterminent la langue par défaut. L’anglais sera sélectionné par défaut si d’autres langues ne prennent pas en charge la langue de votre navigateur.
NOTE
Si vous choisissez l’espagnol ou le portugais brésilien comme langue par défaut ; la langue du portail sera définie sur l’espagnol ou le portugais brésilien. Sinon, l’anglais sera la langue par défaut.
Le logo de marque et les couleurs primaires/secondaires sont extraits de votre site web. Si vous choisissez d’ignorer cette étape, le nom du projet sera dérivé de votre e-mail d’inscription, et le logo et les couleurs par défaut de Document360 seront appliqués.
Vous pouvez prévisualiser le site de votre base de connaissances sur le côté droit de l’écran.
Définir la confidentialité de la documentation
Choisissez les paramètres de confidentialité souhaités pour votre site :
Privé : limitez l’accès à la base de connaissances afin que seuls les comptes d’équipe puissent afficher et interagir avec le contenu, en le gardant sécurisé et interne.
Public : Rendre la base de connaissances accessible à tous, y compris aux utilisateurs externes, en permettant un accès libre à tous les contenus.
Mixte : combinez l’accès privé et public en permettant à certaines sections de la base de connaissances d’être visibles au public, tout en limitant les autres sections aux seuls comptes d’équipe.
Cliquez sur Suivant pour continuer.
Accéder au portail de la base de connaissances Document360
Une fois la configuration terminée, accédez au portail de la base de connaissances Document360.
Pour les utilisateurs qui ont sélectionné la plate-forme de base de connaissances, la documentation logicielle/la documentation technique, la documentation SOP ou le manuel de l’utilisateur comme cas d’utilisation : Document360 générera automatiquement des articles et des catégories pertinents en fonction des cas d’utilisation sélectionnés et du contenu de votre site Web. Chaque catégorie comportera au moins 2-3 articles générés par l’IA, et des sous-catégories seront créées si nécessaire. Si la langue que vous avez sélectionnée est prise en charge par Eddy AI, votre documentation sera générée dans cette langue. Si ce n’est pas le cas, il sera par défaut en anglais. Si aucun contenu pertinent n’est trouvé dans l’URL fournie, vous verrez des articles préchargés en fonction de votre cas d’utilisation et de vos modèles sélectionnés, ce qui vous donnera une longueur d’avance sur la création de votre contenu.
NOTE
Les articles générés par Eddy AI seront publiés, puis mis en mode brouillon. Vous pouvez mettre à jour les articles si nécessaire.
Pour les utilisateurs qui ont sélectionné le cas d’utilisation de la documentation de l’API : Vous serez redirigé vers l’espace de travail de la documentation de l’API, où :
Vous verrez la référence de l’API de la spécification d’API que vous avez fournie lors de l’intégration.
Si vous n’avez pas fourni de spécification d’API, un exemple de référence d’API (API Pet store) sera disponible.
Basculer entre les projets Document360
Une fois que vous avez créé vos projets dans Document360, vous devrez peut-être travailler sur plusieurs projets ou passer de l’un à l’autre pour diverses tâches. Document360 fournit un sélecteur de projet intuitif pour vous aider à gérer cela de manière transparente.
Il existe deux façons de changer de projet à partir du portail de la base de connaissances :
Utilisation de la liste déroulante Projets
À partir du tableau de bord Projets
Changer de projet à l’aide de la liste déroulante Projets
À partir de n’importe quel module du portail de la base de connaissances, cliquez sur le menu déroulant du projet en haut à gauche de l’écran.
Vous pouvez afficher le « Nom du projet », « Accès au site » (public , privé ou mixte ) et une étiquette « Sandbox » s’il s’agit d’un projet Sandbox.
Cliquez sur le projet que vous souhaitez afficher dans la liste.
Changer de projet à partir du tableau de bord Projets
Cliquez sur le logo Document360 en haut à gauche.
Vous serez redirigé vers la page « Mes projets ».
La liste de tous les projets possédés ou associés à votre compte s’affichera.
Cliquez sur le projet auquel vous souhaitez accéder.
Foire aux questions
Document360 prend-il en charge différentes langues dans le flux d’intégration ?
Oui, Document360 offre une prise en charge multilingue dans le flux d’intégration, y compris des langues telles que l’anglais, l’espagnol, le portugais brésilien, l’allemand et le suédois. Cependant, dans le portail Document360, la prise en charge linguistique est actuellement limitée à l’anglais, à l’espagnol et au portugais brésilien.
Puis-je personnaliser l’apparence et la structure de mon projet Document360 ?
Oui, les projets Document360 offrent de nombreuses options de personnalisation. Vous pouvez personnaliser l’apparence de votre base de connaissances en concevant votre page d’accueil, vos thèmes, en ajoutant l’image de marque de votre organisation, en orientant l’éditeur et en organisant les articles dans une structure hiérarchique (catégories) qui répond à vos besoins en matière de documentation.
Est-il possible de contrôler l’accès et les autorisations dans les projets Document360 ?
Absolument. Document360 offre des paramètres de contrôle d’accès et d’autorisation robustes. Vous pouvez attribuer des rôles et des autorisations aux comptes d’équipe, en limitant ou en accordant l’accès à des fonctionnalités et à des contenus spécifiques en fonction de leurs responsabilités et de leurs exigences.
Comment Document360 aide-t-il au contrôle des versions et à l’historique de la documentation ?
Les projets Document360 maintiennent un système complet de contrôle des versions d’articles appelé « Révisions d’articles ». Il enregistre et suit automatiquement les modifications apportées aux articles, ce qui vous permet de revenir aux versions précédentes si nécessaire. Cela garantit l’intégrité de votre documentation et simplifie la collaboration sur les mises à jour de contenu.
Comment puis-je savoir sur quel projet je travaille actuellement ?
Vous pouvez vérifier le nom du projet affiché en haut à gauche de l’écran dans le portail de la base de connaissances.
Que se passe-t-il si je ne vois pas le projet vers lequel je veux basculer ?
Assurez-vous de disposer des autorisations d’accès nécessaires pour ce projet. Si le projet n’apparaît toujours pas, contactez votre administrateur Document360 pour obtenir de l’aide.
Qu’est-ce qu’un projet « Sandbox » et en quoi est-il différent des autres projets ?
Un projet Sandbox est un environnement de test dans lequel vous pouvez expérimenter sans affecter vos projets en direct. Il aura une étiquette « Sandbox » dans la liste déroulante du projet.
Que signifie « Accès au site » dans la liste déroulante du projet ?
« Accès au site » indique si le projet est public, privé ou mixte. Cela définit le niveau d’accessibilité du contenu du projet.
Comment puis-je demander l’accès à un projet auquel je ne suis pas actuellement associé ?
Contactez l’administrateur de votre équipe ou le propriétaire du projet pour demander l’accès au projet souhaité.
Que se passe-t-il si Eddy AI ne peut pas générer de contenu à partir de mon site Web pour les articles par défaut ?
Si Eddy AI n’est pas en mesure d’extraire suffisamment de contenu de votre site Web, le système utilisera des modèles par défaut en fonction du cas d’utilisation que vous avez sélectionné.