Contribution à la documentation GitHub Docs
Découvrez comment l’équipe GitHub Docs crée la documentation et comment vous pouvez y apporter votre contribution.
Recommandé
À propos de la contribution à GitHub Docs
Vous pouvez contribuer au contenu de GitHub Docs de plusieurs façons.
Meilleures pratiques pour GitHub Docs
Suivez ces meilleures pratiques pour créer une documentation conviviale et facile à comprendre.
Guide de style
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.
Articles
À propos de la contribution à GitHub Docs
Vous pouvez contribuer au contenu de GitHub Docs de plusieurs façons.
À propos de la philosophie de la documentation de GitHub
La philosophie de notre documentation guide le contenu que nous créons et la façon dont nous le créons.
A propos des fondamentaux de la documentation de GitHub
Tous les contenus publiés sur GitHub Docs doivent répondre à ces exigences fondamentales.
Changement du titre d’un article
Quand il est nécessaire de changer le titre d’un article, il peut être nécessaire de mettre à jour le nom à plusieurs endroits.
Configurer des redirections
Si le titre, la version ou l’emplacement d’un article change, vous pouvez créer une redirection vers le contenu actuel.
Contenu d'un article GitHub Docs
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.
Création d’un environnement local
Vous pouvez exécuter l’application GitHub Docs localement sur votre ordinateur.
Création de captures d’écran
Vous pouvez aider les utilisateurs à localiser des éléments de l’interface utilisateur difficiles à trouver en ajoutant des captures d’écran à GitHub Docs.
Création de contenu réutilisable
Vous pouvez créer du contenu réutilisable référencé dans plusieurs fichiers de contenu.