Charte de qualité

Afin de permettre à tous les contributeurs et contributrices d'avancer dans la même direction, nous avons rédigé une charte de qualité ainsi qu'un système de notation visible sur la page d'accueil des formations.

Critères de qualité

Rédaction

Un soin particulier doit être apporté à l’écriture. Le texte doit être agréable à lire tout en étant informatif, en utilisant un langage courant (ni familier ni jargonnant) et le vouvoiement. Vous pouvez également parler à la première personne, particulièrement dans l'introduction. La concision est appréciée, sans pour autant survoler les détails.

Si vous souhaitez apporter vos connaissances mais avez peur de faire des fautes, soyez sans crainte : l’équipe de modération corrigera les erreurs avant de valider votre contribution. Pour faciliter leur travail, nous vous invitons à vérifier votre texte sur un site tel que BonPatron.

Contenu d'une formation

Quant au contenu, l'objectif est de permettre à un lecteur ou une lectrice débutante d'appréhender et de faire ses premiers pas sur un outil (moteur de création de jeu ou logiciel de modélisation 3D par exemple) ou une compétence donnée (le pixel art, la distribution...). Il ne s'agit ni d'une simple découverte, ni d'une formation complète.

Pensez à illustrer vos propos avec des images voire de courtes vidéos. Utilisez des formats modernes et légers afin que les pages se chargent rapidement sans concession visible sur la qualité. Vous pouvez par exemple passer vos captures d'écran dans PNGGauntlet, et utiliser le format MP4 avec un bitrate raisonnable pour vos vidéos.

Vos lecteurs et lectrices doivent pouvoir vous faire confiance. Ne tentez pas de créer un biais pour tel ou tel outil avec des exagérations ou des informations douteuses. Quand cela vous semble nécessaire, n'hésitez pas à donner une source à vos affirmations.

Organisation

Votre formation commencera par une introduction engageante expliquant pourquoi suivre le cours et quelles compétences vont y être abordées. Le reste de votre formation doit être découpé en chapitres, donnant des objectifs clairs et accessibles, eux-mêmes découpés en quelques pages qui donneront le rythme.

La conclusion de votre formation doit inciter votre lectorat à s'autonomiser : montrez-lui la documentation officielle et comment s'en servir, proposez plusieurs sites pertinents proposant des ressources utiles, et abordez les éventuelles difficultés qu'il risque de rencontrer.

Enfin, sachez que l'équipe de modération et les autres contributeurs et contributrices sont à votre disposition pour vous aider dans la rédaction de votre formation. N’hésitez pas à nous envoyer vos premiers jets afin que nous voyons ensemble comment les améliorer.

Système de notation

Afin de permettre aux lecteurs et lectrices de connaître la qualité d'une formation, mais également aux contributeurs et contributrices de savoir quelles formations ont besoin d'être actualisées, nous avons mis en place un système de médailles accompagnées d'un commentaire justifiant cette note.

La médaille bronze signale qu'une formation est obsolète et qu'elle ne correspond plus du tout à nos critères de qualité. Ces formations nécessitent souvent d'être complètement réécrites.

La médaille argent signifie qu'une formation a besoin d'une actualisation, soit parce que l'outil a été mis à jour, soit parce que les critères de qualité du site ont évolué.

La médaille or indique qu'une formation correspond aux critères de qualité, que les informations sont à jour et que le lecteur peut lire en toute confiance.

Enfin, la médaille platine ne peut être donnée qu'à la meilleure formation du site. Elle sert de mesure étalon à la qualité des formations et les contributeurs et contributrices sont encouragées à placer cette barre toujours plus haut !

Vous pouvez consulter la notation d'une formation directement depuis son accueil, et vous pouvez à tout moment ouvrir une issue GitHub pour demander une requalification. Si vous vous demandez ce qu'est une issue, nous allons le voir dans la section suivante !