Types de catégories

Dans Document360, chaque catégorie a un type qui détermine son apparence et son comportement à la fois sur le portail de la base de connaissances et sur le site de la base de connaissances. Choisir le bon type vous aide à construire une structure claire et accessible pour vos lecteurs. Il existe quatre types de catégories : Dossier, Index, Page et GitHub.

Types de catégories en un aperçu

Dossier

Le type de dossier est le type de catégorie par défaut et le plus couramment utilisé. Il agit comme un conteneur pur, regroupant articles et sous-catégories sous un sujet commun sans générer sa propre URL ou page de contenu sur le site de la base de connaissances.

Utilisez Dossier lorsque :

• Il faut un groupe de premier plan pour un domaine thématique large.
• La catégorie n’a pas besoin de lien partageable.
• Vous souhaitez que les lecteurs naviguent dans des sous-catégories ou des articles plutôt que de se retrouver sur une page de catégorie.

Caractéristiques clés :

• Aucune URL n’est générée pour ce type de catégorie.
• Prend en charge les opérations en bloc : Masquer (), Réafficher (), Supprimer (), Déplacer () et Étoile () pour les articles de la catégorie.
• L’icône de catégorie peut être personnalisée avec un emoji.

Index

Le type d’index génère sa propre URL et affiche un aperçu structuré de tous les articles de la catégorie. Lorsque les lecteurs cliquent sur une catégorie Index du site de la base de connaissances, ils voient une liste d’articles, incluant le titre, les contributeurs, la date de dernière mise à jour, le statut et les tags, avant d’en ouvrir un spécifique.

Utilisez l’index lorsque :

• Vous voulez que les lecteurs aient un aperçu du contenu d’une catégorie avant de s’y lancer.
• La catégorie nécessite une URL partageable et liable.
• Vous avez besoin d’un point d’entrée structuré pour une grande partie de votre base de connaissances.

Caractéristiques clés :

• Un slug unique est généré. Vous pouvez partager des liens de catégorie d’index et y appliquer des règles de redirection.
• Prend en charge les mêmes opérations en bloc que Dossier : Cacher, Désafficher, Supprimer, Déplacer, et Étocher.
• Prend en charge les paramètres SEO (méta-titre, slug, description) via l’icône More () > SEO.

Vue du portail :

Vue du site de la base de connaissances :

Lorsque les lecteurs cliquent sur une catégorie d’Index, ils voient le titre de la catégorie ainsi que le nombre d’articles et de sous-catégories qu’elle contient.

Page

Le type de page se comporte comme un article classique. Vous pouvez écrire, formater et publier du contenu en utilisant l’éditeur Markdown, WYSIWYG ou Advanced WYSIWYG. Il peut toujours contenir des sous-catégories et des articles en dessous, ce qui le rend adapté aux pages d’accueil de sections qui servent également de parents de navigation.

Utilisez Page lorsque :

• Vous voulez une catégorie qui possède son propre contenu écrit, comme un aperçu de section ou une introduction.
• Vous avez besoin d’une fonctionnalité complète d’article (paramètres SEO, slug, statut, historique des révisions) au niveau de la catégorie.
• La catégorie doit à la fois contenir du contenu et agir comme parent pour les sous-catégories.

Caractéristiques clés :

• Ça se comporte exactement comme un article classique. Vous pouvez changer le titre, le slug, et effectuer toutes les mêmes actions au niveau de l’article.
• Prend en charge les paramètres SEO via l’icône More () > SEO.
• Contrairement à un article classique, une catégorie de Page peut contenir des sous-catégories et des articles supplémentaires en dessous.

Vue du portail :

Vue du site de la base de connaissances :

GitHub

Le type GitHub synchronise directement le contenu documentaire d’un dépôt GitHub connecté vers votre base de connaissances. Chaque branche du dépôt apparaît comme un article dans la catégorie, identifiée par une icône de branche. Chaque fois qu’un commit est envoyé dans le dépôt connecté, Document360 extrait automatiquement les fichiers Markdown mis à jour et les publie.

Utilisez GitHub lorsque :

• Votre documentation cohabite votre code dans un dépôt GitHub et est maintenue sur GitHub.
• Vous voulez des documents contrôlés par version qui restent synchronisés avec les versions de code automatiquement.
• Votre équipe préfère écrire Markdown dans un éditeur local plutôt que dans l’éditeur Document360.

Caractéristiques clés :

• Le contenu synchronisé depuis GitHub est en lecture seule dans Document360. Toutes les modifications doivent être effectuées dans le dépôt source GitHub.
• Seule la branche principale est prise en charge pour la synchronisation.
• Chaque branche dans le dépôt connecté apparaît sous forme d’article avec une icône de branche dans le portail.
• Les utilisateurs ne peuvent pas modifier ni publier des articles dans une catégorie GitHub. Toutes les modifications doivent provenir du dépôt GitHub.
• L’icône GitHub est affichée uniquement pour les catégories publiques .
• De nouveaux articles ne peuvent pas être créés dans Document360 pour des catégories synchronisées sur GitHub.

Comparaison des types de catégories

Changer le type de catégorie

Vous pouvez changer le type d’une catégorie à tout moment sans perdre de contenu.

1. Naviguez jusqu’à Documentation () dans la barre de navigation de gauche.
2. Survolez la catégorie dans le volet Catégories & Articles .
3. Cliquez sur l’icône Plus () et sélectionnez Modifier le type.
4. Sélectionnez le nouveau type de catégorie et cliquez sur Mettre à jour.

Meilleures pratiques

• Utilisez Dossier pour les catégories de premier niveau qui existent uniquement pour la navigation. C’est le type le plus simple et il ne génère pas d’URL inutiles.
• Utilisez Index pour de grandes sections où les lecteurs bénéficient de consulter un aperçu de l’article avant de naviguer, par exemple, dans une référence API ou un long guide de dépannage.
• Utilisez la page pour les pages d’accueil de sections qui nécessitent un contenu introductif aux côtés des articles enfants, par exemple une page « Démarrage » qui explique la section et renvoie vers des articles enfants.
• Utilisez GitHub uniquement lorsque votre documentation est activement maintenue dans un dépôt et que vous avez besoin d’une synchronisation automatique, pas pour des importations ponctuelles.
• Évitez les changements fréquents de type dans les catégories à fort trafic. La conversion en Page laisse la catégorie en état brouillon, ce qui peut entraîner des liens cassés jusqu’à publication.

FAQ