CodeS-SourceS
Rechercher un code, un tuto, une réponse

Charte de CommentCaMarche.net - Conseils d'écriture

Juillet 2017

Conseils d'écriture d'un message


Le langage utilisé sur le site se doit d'être un français compréhensible par tous (pas de langues étrangères, pas de SMS, ni d'abréviations)

Avant tout envoi d'un nouveau message, il est recommandé d'utiliser le moteur de recherche afin de vérifier si un problème équivalent n'a pas été posté auparavant.


Si aucun message concernant votre problème n'a pas été posté préalablement, il vous suffit de poster un nouveau message en choisissant le forum approprié.


Lorsque des utilisateurs répondent à votre message, il vous suffit de répondre à votre propre message pour continuer la discussion. Il vous est même possible de répondre à votre propre message au bout de plusieurs heures pour le faire remonter à la surface. Pour autant, n'exigez pas de réponse immédiate des autres utilisateurs, il s'agit une fois de plus de personnes volontaires et bénévoles, n'ayant pas forcément la réponse à votre problème.



Si aucun message concernant votre problème n'a été posté préalablement, il vous suffit de poster un nouveau message en choisissant le forum approprié.

Style


Les échanges sur un forum sont radicalement différents des échanges traditionnels dans la mesure où les messages sont textuels et souvent rédigés rapidement.

Ainsi, un message rédigé en majuscules « donne l'impression » d'une hausse de ton et est souvent interprété à tort comme signe d'énervement. Il en est de même pour un message suivi d'un grand nombre de caractères de ponctuation. Il est donc recommandé de faire un usage modéré de ce type d'artifice. Voici un exemple de message à éviter :

POUVEZ-VOUS ME DONNER LA REPONSE ?!?!?!???




Il est également demandé aux utilisateurs de s'appliquer lors de la rédaction de leur message en évitant au possible les abréviations (type SMS) et en vérifiant l'orthographe. Un message rédigé en langage abrégé ou difficile à lire compte tenu du nombre de fautes d'orthographe est susceptible d'être supprimé afin de garantir une qualité de lecture des échanges.

Etant donné que les messages postés sur le forum ne permettent pas toujours de refléter l'état d'esprit de celui qui rédige, il vous est possible (et généralement conseillé) d'utiliser des smileys, c'est-à-dire des caractères permettant d'indiquer à votre interlocuteur le ton de votre message.

Titre du message


Le titre du message est la première chose que les utilisateurs voient sur le forum. Un message au titre correctement rédigé aura donc plus de chance d'être lu et de recevoir des réponses. Le titre des messages doit donc contenir les mots-clés présentant votre problème et ne doit bien évidemment pas être rédigé avec uniquement des majuscules.


De cette manière, les titres ne comportant pas l'objet de la demande mais uniquement les mots suivants sont à proscrire :

Demande d'aide
Heeeelp !
PLEAASE !
SOS
Urgent
Aidez-moi

Description du problème


Lorsqu'un utilisateur poste un message concernant son problème, il connaît généralement le contexte de celui-ci.

Il est donc essentiel de décrire le problème de la façon la plus complète possible en précisant éventuellement l'environnement logiciel et matériel.

Le réglement de CodeS-SourceS


Voici la liste des langages de programmation traités sur CodeS-SourceS : ASM, ASP / ASP.NET, C / C++ / C++.NET, C# / .NET, ColdFusion, Delphi, Flash, Flex, Foxpro, Graph, IRC, Java, Javascript, PDA, PHP, Python, Regex, SQL, Visual Basic / VB.NET,

Règles pour poster un nouveau message sur le forum

  • Faites une recherche (forum / sources / tutoriels ) avant de poster une question.
    • 90% des questions posées quotidiennement sont déjà présentes et résolues.
  • Soyez poli : «bonjour» et «merci» sont des mots plus qu'appréciés.
  • Utilisez un langage correct : pas de langage SMS et on fait attention à l'orthographe.
  • Demandez une explication ou de l'aide sur un sujet précis, ne l'exigez pas!
    • N'oubliez pas que vous vous adressez à des membres bénévoles qui vont partager de leur temps et leurs connaissances afin de vous aider. Vous vous devez de garder cet esprit communautaire en tête ;-)
  • Ne posez qu'une question par topic.
  • Posez une question aussi précise que possible.
    • Répondre prend parfois beaucoup de temps. inutile d'en ajouter par des échanges n'étant que des reformulations. relisez-vous...
  • Précisez les détails du problème : contexte, langage, message d'erreur, etc.
  • Pensez à donner le bout de code qui pose problème et à préciser le langage utilisé.
    • C# n'est pas C++, VBA n'est pas VB6, etc... vérifiez le thème où vous postez.
  • Ne demandez pas un programme tout fait, demandez de l'aide sur un problème concret.
  • Dirigez-vous directement dans la recherche de sources pour les programmes complets. Inutile de demander du "code tout cuit", vous n'obtiendrez aucune réponse.
  • Ne posez pas de question en rapport avec virus, crack, hack, trojan etc... ainsi que TOUS sujets comportant ou faisant référence directement ou indirectement à la religion, la politique ou le sexe.
  • Pensez à laisser un petit message lorsqu'un problème est résolu et à cliquer sur le bouton «Mettre en résolu».
  • Votez pour la réponse qui vous a permi de résoudre votre problème, elle sera d'autant plus facile à retrouver pour un problème similaire.

Règles pour poster une nouvelle source ou autre contribution

  • Vérifier avant de poster ma source si une source équivalente n'est pas déjà présente et si ma source apporte réellement quelque chose.
    • C'est très souvent le cas. Certaines sources (calculatrices, convertisseurs, msgbox, démineur, chronomètres, et autres routines plus que nombreuses) seront directement supprimées.
  • Ne postez pas une source ne faisant qu'utiliser une ou deux fonctions standard du langage.
  • Mettre un titre explicite et on décrit correctement la source.
    • Toute source sans description sera supprimée. De même qu'une source avec un titre ne correspondant pas.
  • Ne postez pas de source en rapport avec virus, crack, hack, trojan etc... ainsi que TOUS sujets comportant ou faisant référence directement ou indirectement à la religion, la politique ou le sexe.
    • Il en va de même pour les commentaires ou les pièces jointes à vos sources.
  • N'utilisez pas de noms copyrightés tels que "Scrabble", "Monopoly", etc.
    • Ces sources seront supprimées pour éviter des problèmes juridiques.
  • Expliquez comment utiliser la source et joignez-y les ressources éventuelles.
  • Expliquez ce que fait la source.
    • A défaut de fournir un guide d'utilisateur (User-Guid), le développeur/lecteur doit pouvoir prendre facilement votre application en main sans regarder chaque ligne de code.
  • Mentionnez les bugs.
  • Utilisez un langage correct : pas de langage SMS, et on fait attention à l'orthographe.
  • Ne mettez pas de sources qui ne fonctionnent pas.
  • Ne mettez qu'un programme par source.
  • Ne fournissez pas un programme ou une ressource compilée. Une source sans code n'est pas une source!
  • Ne postez pas le travail d'autrui et citez les auteurs pour les morceaux de code publics.

A voir également

Ce document intitulé «  Charte de CommentCaMarche.net - Conseils d'écriture  » issu de CodeS-SourceS (codes-sources.commentcamarche.net) est mis à disposition sous les termes de la licence Creative Commons. Vous pouvez copier, modifier des copies de cette page, dans les conditions fixées par la licence, tant que cette note apparaît clairement.
Respect d'autrui
Charte d'utilisation de Codes Sources