Skip to main content

Cette version de GitHub Enterprise Server n'est plus disponible depuis le 2024-09-25. Aucune publication de correctifs n’est effectuée, même pour les problèmes de sécurité critiques. Pour de meilleures performances, une sécurité améliorée et de nouvelles fonctionnalités, effectuez une mise à niveau vers la dernière version de GitHub Enterprise. Pour obtenir de l’aide sur la mise à niveau, contactez le support GitHub Enterprise.

Informations sur la combinaison de plusieurs types de contenu

Vous pouvez combiner plusieurs types de contenu dans un seul article pour aider les personnes à effectuer des tâches complexes.

Il est souvent utile de regrouper des informations dans un contexte donné pour aider les personnes à effectuer une tâche complexe, à comprendre un ensemble de tâches associées ou à illustrer un workflow entier. Utilisez des articles plus longs combinant plusieurs types de contenu pour vous assurer que les utilisateurs trouvent le contenu contextuel dont ils ont besoin au bon endroit. Les articles plus longs permettent également d’éliminer la duplication du contenu et de faire évoluer le contenu à mesure que d’autres options sont ajoutées au produit. Les utilisateurs ont souvent besoin d’articles plus longs s’ils utilisent activement le produit et s’ils doivent consulter l’article à différents stades de leur parcours.

Comment combiner plusieurs types de contenu dans un article

  • Utilisez différents contenus (conceptuels, procéduraux, référentiels, dépannage, problèmes connus) dans un article plus long, mais n’utilisez pas de guides de démarrage rapide ni de tutoriels.
  • Utilisez des sections des différents types de contenu dans l’article en fonction des besoins et suivez les instructions relatives aux titres pour chaque type de contenu.
  • Le plus souvent, ces articles contiennent au moins une section procédurale et au moins une section conceptuelle, référentielle ou procédurale supplémentaire.
  • Utilisez les instructions de classement du contenu pour organiser les en-têtes dans l’article.
  • Utilisez les informations de dépannage aussi souvent que possible.
  • Vous pouvez reproduire le titre de l’article dans un en-tête si nécessaire.

Instructions relatives aux titres pour les articles combinant plusieurs types de contenu

  • Si l’article comprend une procédure, utilisez un titre basé sur une tâche qui commence par un substantif.
  • Les titres sont suffisamment généraux pour décrire toute la gamme d’informations et de tâches contenues dans l’article.
  • Les titres décrivent le paramètre à régler et sont indépendants du paramètre choisi par le lecteur, par exemple « Définition de la visibilité du dépôt » au lieu de « Configuration d’un dépôt privé en tant que dépôt public ».

Exemples d’articles combinant plusieurs types de contenu