Les catégories sont le principal moyen d’organiser le contenu dans votre base de connaissances. Avant de commencer à ajouter des articles, mettre en place une structure claire par catégories aide les lecteurs à naviguer dans votre documentation et à gérer votre contenu à grande échelle.
Quand avez-vous besoin d’une nouvelle catégorie ?
Créez une nouvelle catégorie lorsque vous en avez besoin :
- Regroupez les articles liés sous un sujet commun, par exemple une catégorie « Débuts » pour le contenu d’intégration.
- Séparer le contenu par audience : Créez des catégories distinctes pour les utilisateurs finaux, les administrateurs et les développeurs.
- Reflétez la structure de votre produit : alignez les catégories avec les domaines produits, fonctionnalités ou modules afin que les lecteurs trouvent le contenu là où ils s’y attendent.
- Ajoutez une sous-catégorie à une catégorie existante lorsqu’un sujet devient suffisamment important pour nécessiter une division supplémentaire.
Vous pouvez créer jusqu’à 1 000 catégories par espace de travail. Les noms des catégories ont un maximum de 300 caractères compris.
Créer une catégorie
La façon la plus courante de créer une catégorie est d’utiliser le bouton Créer dans la barre de navigation supérieure.
- Naviguez jusqu’à Documentation () dans la barre de navigation de gauche.
- Cliquez sur le menu déroulant Créer et sélectionnez Catégorie.
- Dans le panneau Créer une nouvelle catégorie , remplissez les éléments suivants :
| Terrain | Que faire |
|---|---|
| Nom | Saisissez un nom pour la catégorie (maximum 300 caractères) |
| Emplacement | Choisissez où se situe la catégorie, au niveau racine ou à l’intérieur d’une catégorie existante. Cliquez sur Réinitialiser pour le placer au niveau root |
| Type | Sélectionnez un type de catégorie : Dossier, Index, Page ou GitHub |
- Cliquez sur Créer. La nouvelle catégorie est ajoutée immédiatement.
Pour en savoir plus sur les types de catégories, lisez Types de catégories.
Vous pouvez également créer une catégorie en utilisant l’icône Volant en survolant juste sous n’importe quelle catégorie dans le volet Catégories & Articles , depuis l’icône Plus () à côté d’une catégorie existante, depuis le menu déroulant Créer dans une catégorie de type Dossier ou Index , ou directement depuis le panneau Créer un nouvel article en cliquant sur Créer une catégorie dans le menu déroulant Category.
Tous les points d’entrée s’ouvrent dans le même panneau Créer un nouveau panneau de catégorie avec les mêmes champs Nom, Emplacement et Type.
Niveaux de sous-catégories
Vous pouvez imbriquer des catégories jusqu’à sept niveaux de profondeur, une catégorie racine plus six niveaux de sous-catégorie.
L’option Nouvelle catégorie devient inactive une fois que vous atteignez le septième niveau.
Utilisez jusqu’à trois niveaux de sous-catégories pour une navigation optimale. Deux niveaux sont l’idéal pour la plupart des bases de connaissances. Des hiérarchies plus profondes rendent plus difficile pour les lecteurs de trouver du contenu sans utiliser la recherche.
Changer l’icône de catégorie
Lorsque vous créez une catégorie, une icône de dossier par défaut est attribuée. Vous pouvez le changer en emoji pour faciliter l’identification de la catégorie d’un coup d’œil.
- Naviguez jusqu’à Documentation () dans la barre de navigation de gauche.
- Dans le volet Catégories & Articles , cliquez sur l’icône de dossier ou l’emoji existant à côté de la catégorie souhaitée.
- Un panneau d’émojis apparaît. Recherchez un emoji dans la barre de recherche, parcourez par catégorie, ou filtrez par teinte de couleur.
- Sélectionnez l’emoji que vous souhaitez pour l’appliquer.
- Pour revenir à l’icône de dossier par défaut, cliquez sur l’icône 🚫 dans le panneau des emojis.
- Les styles d’emoji peuvent varier selon le navigateur.
- Les icônes de catégorie ne peuvent être modifiées que pour les catégories de type Dossier et Index . Les catégories de types de pages ne prennent pas en charge les icônes personnalisées.
Meilleures pratiques
- Nommer les catégories du point de vue du lecteur : Utilisez un langage que vos lecteurs utiliseraient pour rechercher du contenu, et non la terminologie interne de l’équipe.
- Soyez cohérent dans la mise en forme : décidez du titre de la casse ou de la phrase et appliquez-le uniformément dans toutes les catégories.
- Commencez large, puis restreint : les catégories racines doivent couvrir des sujets larges ; Les sous-catégories devraient les diviser en domaines spécifiques et ciblés.
- Évitez les catégories à article unique : si une catégorie ne contient qu’un seul article, considérez si elle appartient à une catégorie plus large.
- Utilisez intentionnellement les icônes d’emoji : Les emojis aident les lecteurs à identifier rapidement les catégories d’un coup d’œil. Choisis ceux qui représentent clairement le sujet.
FAQ
Quels types de catégories puis-je créer ?
Vous pouvez créer quatre types : Dossier, Index, Page et GitHub. Chaque type a des comportements et des cas d’usage différents. Voir Types de catégories pour plus de détails.
Puis-je changer le type de catégorie après l’avoir créé ?
Oui. Vous pouvez changer le type d’une catégorie à tout moment après sa création. Voir Types de catégories pour plus de détails.
Puis-je créer des sous-catégories sous une catégorie principale ?
Oui. Vous pouvez créer jusqu’à sept niveaux de catégories, une catégorie racine et six niveaux de sous-catégories. L’option Nouvelle catégorie devient inactive au-delà du septième niveau.
Puis-je changer l’icône de catégorie en emoji ?
Oui, mais seulement pour les catégories de type Dossier et Index . Les catégories de types de pages ne prennent pas en charge les icônes personnalisées. Pour revenir à l’icône de dossier par défaut, cliquez sur l’icône 🚫 dans le panneau des emojis.
Pourquoi ma nouvelle catégorie n’est-elle pas visible sur le site de la base de connaissances ?
Une catégorie n’apparaîtra pas sur le site de la base de connaissances si elle ne contient pas d’articles publiés, si elle est cachée, ou si tous les articles qu’elle contient sont cachés ou non publiés. Publiez au moins un article dans cette catégorie pour le rendre visible.