Un article peut être défini comme pertinent pour une ou plusieurs rubriques en répertoriant ces rubriques dans les informations préliminaires de l’article. Par exemple :
---
title: "Managing branches in your repository"
topics:
- "GitHub"
- "Git"
- "Repositories"
---
Pour plus d’informations sur l’ajout de rubriques à un article, consultez « Utilisation des informations préliminaires YAML ». Pour obtenir la liste complète des rubriques autorisées, consultez allowed-topics
.
Rubriques pour tous les types de contenu
- Utilisez des noms pour les rubriques.
- Les rubriques permettent aux utilisateurs de regrouper du contenu de manière utile.
- Dans la mesure du possible, optez pour des rubriques spécifiques pertinentes au lieu de rubriques d’ordre plus général. Par exemple, utilisez
REST
ouGraphQL
plutôt queAPI
. - Veillez à ce que les rubriques sur des articles similaires soient cohérentes afin que les personnes utilisant un filtre par rubrique obtiennent tous les articles pertinents. Par exemple, tous les articles sur CI doivent avoir la rubrique
CI
ainsi que des rubriques plus spécifiques. - Évitez les rubriques ambiguës. Par exemple,
Actions
peut ne pas être une rubrique utile dans le produit Actions, car elle peut faire référence au produit GitHub Actions ou à l’élément de produit appelé « action ».
- Dans la mesure du possible, optez pour des rubriques spécifiques pertinentes au lieu de rubriques d’ordre plus général. Par exemple, utilisez
- Les rubriques apportent une valeur ajoutée et ne reproduisent pas le titre, le type ou la catégorie de l’article.
- Par exemple, dans le produit Actions,
Actions
n’apporte aucune valeur ajoutée puisque toute personne dans cette section de la documentation sait déjà qu’elle consulte les documents Actions.
- Par exemple, dans le produit Actions,
- Utilisez :
Fundamentals
pour les articles liés aux concepts de base d’un domaine de produit.- Utilisez :
Fundamentals
dans un article comme « Introduction à GitHub Actions ». - Évitez :
Actions
dans un article comme « Introduction à GitHub Actions ».
- Utilisez :
- Vous pouvez utiliser des abréviations courantes, mais évitez de recourir à des abréviations obscures ou ambiguës.
- Utilisez :
CI
à la place deContinuous integration
. - Évitez :
AS
à la place deAdvanced Security
.
- Utilisez :
- Utilisez les formes courtes des noms de produits GitHub.
- Utilisez :
Actions
à la place deGitHub Actions
.
- Utilisez :
Check-list pour choisir des rubriques
Pour vous aider à choisir les rubriques d’un article, posez-vous les questions suivantes. Chaque article n’a pas nécessairement une rubrique pour tous les éléments de la check-list.
- Quelle est la fonctionnalité ou quel est le domaine du produit ?
- Exemple :
Enterprise
L’article porte-t-il sur une sous-fonctionnalité (à moins que le nom du produit ne corresponde au nom de la fonctionnalité) ? - Exemple :
Dependabot
- Exemple :
- La fonctionnalité fait-elle partie d’un programme restreint ?
- Exemple :
Advanced Security
- Exemple :
- De quel élément de la fonctionnalité ou du produit l’article traite-t-il ?
- Exemple :
Organizations
- Exemple :
- Quel est l’objectif général de l’article ?
- Exemple :
Permissions
- Exemple :
- Quels langages de programmation, gestionnaires de package ou écosystèmes l’article aborde-t-il explicitement ? Incluez uniquement ces rubriques si elles confèrent une valeur ajoutée à quelqu’un qui filtre les documents. Ne les incluez pas si un article liste les langages, gestionnaires de package ou écosystèmes pris en charge.
- Exemple :
Ruby
- Exemple :