Contribution à la documentation GitHub Docs
Découvrez comment l’équipe GitHub Docs crée la documentation et comment vous pouvez y apporter votre contribution.
Démarrer ici
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.
Informations sur le modèle de contenu
Le modèle de contenu décrit la structure et les types de contenu que nous publions.
À propos de la contribution à GitHub Docs
Vous pouvez contribuer au contenu de GitHub Docs de plusieurs façons.
Rédaction pour GitHub Docs
- Meilleures pratiques pour GitHub Docs
- À propos de la philosophie de la documentation de GitHub
- A propos des fondamentaux de la documentation de GitHub
- Principes de conception de contenu
- Rédaction de contenu à traduire
- Rendre le contenu accessible dans la recherche
- Documentation sur le contrôle de version
- Utilisation de Markdown et Liquid dans GitHub Docs
- Utilisation des informations préliminaires YAML
- Utilisation de vidéos dans GitHub Docs
- Création de contenu réutilisable
- Création de captures d’écran
- Création de diagrammes pour GitHub Docs
- Création de sélecteurs d’outils dans les articles
- Configurer des redirections
- Changement du titre d’un article
- Exemples d’annotation de code
- Modèles
Guide de style et modèle de contenu
- Guide de style
- Informations sur le modèle de contenu
- Contenu d'un article GitHub Docs
- À propos des rubriques
- Type de contenu conceptuel
- Type de contenu référentiel
- Type de contenu procédural
- Type de contenu de dépannage
- Type de contenu de note de publication
- Type de contenu de démarrage rapide
- Type de contenu de didacticiel
- Informations sur la combinaison de plusieurs types de contenu