Guide de style et modèle de contenu

Suivez ce guide pour vous assurer que la documentation de GitHub reste cohérente et suit des modèles clairs que nos lecteurs peuvent comprendre.

Le modèle de contenu décrit la structure et les types de contenu que nous publions.

Chaque article comprend quelques éléments standard et peut inclure des éléments conditionnels ou facultatifs. Le contenu d'un article est également soumis à un ordre standard.

Utilisez des rubriques pour pouvoir rechercher les articles.

Les personnes ont le plus souvent recours à du contenu conceptuel quand ils apprennent quelque chose de nouveau.

Le contenu référentiel fournit des informations détaillées à l’attention des utilisateurs qui se servent activement d’une fonctionnalité.

Le contenu procédural décrit le contexte selon lequel une tâche s’inscrit dans l’objectif plus vaste d’une personne.

Le contenu de dépannage inclut les erreurs intégrées que les utilisateurs peuvent rencontrer, les problèmes courants signalés au support ainsi que les situations dans lesquelles les utilisateurs risquent de se retrouver lors de l’exécution de tâches.

Les notes de publication permettent aux lecteurs de comprendre les modifications affectant les utilisateurs et de s’y préparer chaque fois qu’un produit entreprise GitHub versionné est publié.

Les démarrages rapides sont une solution idéale pour les personnes qui veulent trouver des instructions rapidement sans explications longues sur le fonctionnement ou la raison d’utiliser quelque chose.

Les didacticiels sont utiles quand un utilisateur a déjà des notions de base d’un produit et souhaite approfondir ses connaissances pour résoudre un problème spécifique.

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