A propos des fondamentaux de la documentation de GitHub
Ces principes de base sont requis pour la documentation GitHub. Utilisez les listes ci-dessous pour vous assurer que vos contributions sont précises, accessibles et inclusives et cohérentes.
Précises
La documentation est correcte et précise.
- Assurez-vous que le contenu est exempt d’erreurs factuelles.
- Veillez à ce que le contenu soit exempt de fautes d'orthographe et de formatage.
Accessible et inclusif
La documentation est à jour avec les dernières normes d’accessibilité et est écrite pour être inclusive et conviviale pour la traduction.
- Assurez-vous que le contenu respecte les instructions d’accessibilité et de capture d’écran. Pour plus d’informations, consultez « Création de captures d’écran ».
- Vérifiez que le contenu peut être traduit avec succès. Pour plus d’informations, consultez « Rédaction de contenu à traduire ».
De façon régulière
La documentation maintient une voix, un ton et un style cohérents tout au long du document, créant ainsi une expérience cohésive pour les lecteurs.
- Veiller à ce que le contenu respecte le guide de style GitHub Docs. Pour plus d’informations, consultez « Guide de style ».
- Appliquer une terminologie cohérente et des conventions de dénomination.
- Utilisez des éléments de personnalisation (par exemple, des noms de produits et de caractéristiques, des logos, des jeux de couleurs) de manière cohérente dans le contenu.