Rédaction pour GitHub Docs

Suivez ces meilleures pratiques pour créer une documentation conviviale et facile à comprendre.

La philosophie de notre documentation guide le contenu que nous créons et la façon dont nous le créons.

Notre documentation est traduite en plusieurs langues. La façon dont nous abordons la rédaction de la documentation en anglais peut considérablement améliorer la qualité de ces traductions.

Nous partageons ces principes pour concevoir et créer le meilleur contenu pour les personnes qui utilisent GitHub.

GitHub Docs utilise des opérateurs d'en-tête et liquide YAML pour prendre en charge plusieurs versions de GitHub avec une approche à source unique.

Vous pouvez utiliser Markdown et Liquid pour mettre en forme du contenu, créer du contenu réutilisable et écrire du contenu pour différentes versions sur GitHub Docs.

Vous pouvez utiliser les informations préliminaires YAML pour définir le contrôle de version, ajouter des métadonnées et contrôler la disposition des articles.

Ce guide explique comment créer des vidéos qui répondent aux besoins des utilisateurs de GitHub Docs.

Vous pouvez créer du contenu réutilisable référencé dans plusieurs fichiers de contenu.

Vous pouvez aider les utilisateurs à localiser des éléments de l’interface utilisateur difficiles à trouver en ajoutant des captures d’écran à GitHub Docs.

Ce guide explique quand et comment créer des diagrammes pour GitHub Docs.

Vous pouvez utiliser un sélecteur d’outils pour montrer comment effectuer des tâches à l’aide d’outils spécifiques.

Si le titre, la version ou l’emplacement d’un article change, vous pouvez créer une redirection vers le contenu actuel.

Quand il est nécessaire de changer le titre d’un article, il peut être nécessaire de mettre à jour le nom à plusieurs endroits.

Vous pouvez annoter des exemples de code plus longs pour expliquer comment ils fonctionnent et comment les utilisateurs peuvent les personnaliser pour d’autres utilisations.

Cet article contient des modèles de démarrage pour les différents types de contenu utilisés dans GitHub Docs.