À propos des principes de conception de contenu de GitHub
Nous créons une documentation produit qui aide, forme et intéresse tous ceux qui utilisent GitHub. Une des étapes de ce travail consiste à concevoir le contenu que nous écrivons. Nous suivons ces principes lors de la conception et de la planification de contenu.
- Notre contenu est orienté utilisateur et est inclusif. Nous prenons en compte tous ceux qui consultent la documentation et nous créons du contenu adapté avec nos choix de stratégie, de conception et de style.
- Notre contenu explique pourquoi nos produits sont utiles et aide les gens à atteindre leurs objectifs et leurs priorités.
- Nous employons nos ressources à la création d’une documentation qualitative et précieuse pour la communauté GitHub.
- Nous créons juste ce qu’il faut de documentation : l’ajout de contenu rend tout plus difficile à trouver et noie tout le reste (GitHub Zen).
- Notre apprentissage passe par la répétition et la livraison - À mesure que nous apprenons de nouvelles choses, que ce soit par l’expérience, l’expertise du secteur et la collaboration avec notre communauté GitHub Docs, nous ajustons nos processus, nos pratiques et nos instructions.
Nous fournissons un guide de style et des modèles de contenu sous forme de points clés et d’instructions permettant à tout le monde de concevoir et de créer de la documentation.
- Notre guide de style et nos modèles de contenu s’appliquent à divers scénarios.
- Les décisions sont basées sur ce qui convient le mieux aux personnes qui utilisent notre documentation, et pas simplement sur ce qui est correct ou incorrect selon les règles grammaticales ou stylistiques. Nous sommes souples et ouverts au changement tout en gardant une certaine cohérence.
- Nous concentrons notre attention sur la documentation de scénarios à fort impact et à forte valeur ajoutée plutôt que d’essayer de couvrir de manière exhaustive tous les cas d’usage possibles des nombreux produits et fonctionnalités GitHub.
- Nos priorités sont la clarté, le sens, la justesse et la cohérence.
- Lorsque nous prenons une décision de style ou de structure, nous réfléchissons à ce que les gens essaient de faire avec les informations données et à la façon dont notre contenu peut servir au mieux leurs objectifs.
- Lorsqu’une question sur la documentation n’est pas couverte par le guide de style ou le modèle de contenu, nous l’évaluons sur la base de ces principes, puis nous prenons une décision.