Conseils pour l'écriture de questions/réponses pour les FAQ

[LittleWhite]

Voici quelques conseils d'ordre général pour les contributeurs des différentes FAQs :

• Essayez de soigner l'orthographe et la formulation des phrases ; des relectures sont faites, mais étant un boulot assez conséquent, moins il y aura de fautes mieux ce sera.
• Lorsque vous citez des liens, pensez à préciser s'il s'agit de liens français (FR), anglais (EN) ou FAQ (FAQ). Cela m'aidera à placer le petit drapeau correspondant à coté du lien.
• Gardez à l'esprit que l'on s'adresse majoritairement à des débutants, dont la plupart n'a jamais entendu parlé des sujets concernés. Pensez donc à utiliser des mots simples, et détailler les choses a priori évidentes pour vous.
• Nous créeons une FAQ française, pour la communauté francophone : essayez donc autant que possible d'éviter les anglicismes (sauf bien sûr si l'équivalent français serait moins explicite).
• Essayez un maximum de lier les Q/R les unes aux autres. Par exemple si vous parlez des bibliothèques de fenêtrage pour OpenGL, placez un petit "(voir "Quelle bibliothèque de fenêtrage utiliser ?")", par exemple. Pas besoin de mettre le lien par contre, c'est géré tout seul.
• Pareil pour les tutoriels ou autres ressources (surtout celles de developpez.com) : pensez à les citer lorsque c'est approprié.
• Bien que cela soit la plupart du temps évident, pensez à ajouter un tag indiquant la FAQ concernée dans les titres de vos messages. Si vous proposez beaucoup de Q/R, qui plus est pour une catégorie qui n'existe pas encore, vous pouvez également proposer une organisation en sous-parties pour les Q/R (si vous le souhaitez -- sinon il n'y a pas de problème pour que je m'en charge).

Ces quelques conseils ne sont bien sûr pas des consignes à appliquer à la lettre, ce sont simplement des petites choses qui permettront d'avoir des FAQs de qualité et appréciées par un large public

Si vous avez un site internet perso et/ou si vous voulez que le nom qui sera associé à vos contributions ne soit pas votre pseudo, indiquez-le moi (à la suite de l'un de vos posts ou par MP)

Encore un énorme merci à tous les bénévoles qui prennent du temps pour nous aider à enrichir nos bases de connaissances.