[Modération] Bien poster un topic dans le forum programmation

Tout d'abord, une vérification est de rigueur. Suis-je dans le forum approprié ?

En effet, chaque forum est là pour traiter une catégorie précise de questions.

Les gens qui savent des chosent sur le PHP par exemple trainent (voire glandent ) dans le forum PHP. Poster une question sur le PHP dans le forum programmation, c'est donc un bon moyen de poser la question là où les gens qui peuvent y répondre ne sont pas.

Les deux autres forums dans lesquels on expose souvent ses problèmes sont le forum Site Web et le forum Mapping.
Leurs catégories sont strictes, mais attention !



Je prendrais ici deux exemples :

• vous avez un problème d'ASP (si vous ne savez pas ce que c'est que l'ASP, ce n'est pas grave, et vous ne vous en porterez que mieux). Le seul langage dynamique proposé dans le forum site web est le PHP. Pourtant, une telle question a bien sa place dans le forum PHP. Précisez seulement dans le titre de votre topic que c'est de l'ASP comme cela : "[ASP] Titre du topic".
• Vous voulez apprendre le mapping FarCry. Pourtant les seuls catégories du forum Mapping sont Hl1 et Hl². Je ne vous fais pas un dessin , c'est quand même là qu'il faut aller. Pareil, vous mettrez comme titre "[FarCry] Titre du topic".

Vous remarquerez aussi que le forum programmation se divise en deux catégories.

La catégorie C/C++ et la catégorie Autres langages.

Il semble donc que le forum programmation soit orienté langages de programmation. Cependant, la programmation c'est aussi plein d'autres choses, et si vous avez une question qui ne porte pas sur un langage précis (l'exemple le plus simple est "dans quel langage puis-je faire ceci/cela efficacement ?"), vous pouvez la poser . Cependant, il faut faire attention à rester dans le cadre strict de la Programmation.

En cas d'erreur

Il arrive qu'on se trompe de catégorie, voire de forum, quand on poste un topic.

Il y a deux protections contre ces erreurs embêtantes : la prévention : ne pas créer un topic en état d'ébriété , et la guérison :



Ne vous inquiétez pas, même s'ils ont l'air méchants comme ça, ils prennent très bien ce genre de demandes.

De même, si vous voyez un topic qui n'est selon vous pas à la bonne place, vous pouvez aussi demander à un modérateur de le changer, cela aidera le posteur du topic à trouver le renseignements dont il a besoin.

Maintenant que je suis sûr d'être dans le bon forum, je peux poster ?



En effet, quand on a un problème, c'est souvent parce qu'il y a une raison; comme on n'est pas plus bête que la moyenne des gens (enfin ca dépend des cas hein ), d'autres personnes ont souvent le même problême que nous.

Trouver un topic déja existant

Comment trouver le topic en question ? Il suffit d'utiliser la fonction Recherche du forum :). Celle-ci se trouve dans le bas du menu de gauche.

Le mieux pour avoir la réponse rapidement à la question, c'est de choisir la recherche avancée et de préciser que l'on ne veut une recherche que dans le forum programmation.

Si un topic existe effectivement

Il suffit dans ce cas de trouver le topic créé par cette personne pour y prévenir qu'on a le même problème (et y apporter un complément d'information quand c'est possible (par exemple quand elle n'a pas lu ce magnifique tutorial )), et d'attendre des réponses.

Parfois même la réponse au problème a déja été donnée !

Si aucun topic n'existe

Si vous n'avez trouvé aucun topic posant la même question que vous, il est maintenant temps de créer votre topic.

Le titre, c'est l'information qui est accessible sans un seul clic aux lecteurs du forum programmation. Il est donc très important de le soigner : un titre clair amène les lecteurs à cliquer dessus, à entrer dans votre topic, et une fois dedans ils vont très probablement le lire. Par contre, si le titre est brouillon, il ne vont pas lire votre topic, donc tous les efforts de présentations que vous aurez fait seront inutiles.

Le mieux pour que les titres soient clairs, c'est d'adopter une convention. Voici la convention que je vous propose :
Citation : Convention pour les titres



Si vous savez dans lequel des deux vous programmez, mettez le. En effet, certains bugs sont dus au fait que l'on utilise des structures C++ et C par exemple, et si vous ne nous dites pas que l'on fait du C on vera juste un code C++ normal avec du C dedans.
Si vous ne savez pas lequel des deux vous employez, on ne va pas en faire un fromage , mettez [C/C++].

Voici un exemple de titre de topic qui me semble explicite :

Citation : Un titre de topic

Une fois que vous avez réfléchi à la formulation claire du titre, vous pouvez vous consacrer à l'écriture du message en lui-même.

L'environnement dans lequel vous programmez

Les informations sur l'environnement sont parfois utiles, mais elles sont facultatives.
Si on les met en début de topic bien qu'elles soient moins importantes que "ce que vous voulez faire", c'est parce qu'en général le lecteur se souvient mieux de ce qu'il a lu en dernier.

Vous pouvez déjà rappeler votre langage de programmation, ca ne fait pas de mal.

Ensuite, il peut être utile de préciser votre système d'exploitation.

Enfin, il est utile de préciser votre IDE. Si vous suivez le cours C/C++ il est précisé. Si vous ne savez pas ce que c'est, essayez de répondre à la place à la question suivante : avec quel programme faites-vous de la programmation ?

Ce que vous voulez faire

Vous devez nous expliquer à quoi sert le programme que vous êtes en train de faire, ou que vous vous apprêtez à faire.

Tout d'abord, faite une description générale, et ensuite précisez le type d'entrée attendue et la sortie attendu du programmes.

Exemple :

Citation : description

Si vous ne conaissez pas l'entrée attendue et la sortie attendue de votre programme, c'est qu'il y a un problème. Vous devriez réfléchir à ce que vous êtes en train de faire.

Si c'est une fonction isolée dans un programme qui pose problème, vous devriez décrire votre programme en général (description + entrées/sorties), et ensuite décrire cette fonction :

Citation : autre description

Le bug

Si votre problème est un bug de votre code, à la compilation ou à l'execution (chose qu'il vous faudra préciser), vous devez indiquer le message d'erreur qui vous est donné, et la manière dont il faut procéder pour reproduire ce bug.

Votre code

Si vous avez un bug dans votre code, il faut nous le montrer pour que l'on puisse le résoudre.

Peut-on savoir quelle quantité de code montrer ?

Si vous ne montrez pas assez de code (ou pas du tout), vous allez 9 fois sur 10 ne pas montrer la ligne ou il y a le bug. Il n'y a rien de pire que quelqu'un qui montre des lignes justes en disant "ca plante".

Par contre, il faut aussi redouter l'effet inverse : si vous copiez/collez 450 lignes de code en nous disant "demerdez vous pour trouver l'erreur", il est peu probable (les programmeurs sont paresseux, c'est bien connu ) que quelqu'un prenne la peine de la chercher.

Cependant déterminer la taille exacte nécessaire est très difficale car on a souvent besoin de toute le bloc d'instruction dans lequel est l'erreur, et parfois des fonctions et des variables qui sont utilisées sans etre déclarées dans ce bloc.
De plus, quand vous débutez, il est très rare que vous sachiez localiser l'erreur. En général vous prenez la ligne indiquée dans le message d'erreur, et ce n'est pas du tout ça qui pose problème

Ce que l'on peut faire

Dans l'absolu, je préfère donc qu'on mette tout le code, mais il est alors nécessaire qu'il soit bien espacé, bien indenté, bien commenté, bien lisible, et plutôt court si possible. (Si vous ne conaissez pas ces notions de présentation du code, vous devriez vous documenter. Je vous propose un article de la wikipédia qui a le malheur d'être en anglais)



En effet, il arrive que le bug soit lié non pas au code, mais à l'extension employée.

La rédaction du message est un point qu'il ne faut pas négliger.

Voici quelques conseils :

• Jamais de SMS
• Relire avant de poster pour enlever les fautes d'orthographes
• La politesse est toujours un plus
• Remercier, c'est cool

J'insiste sur le second et le dernier point.

Se relire, c'est bien, ca enlève des fautes : un message pas en SMS mais mal orthographié peut être extrêmement pénible à lire. En plus, ca vous fait faire des progrès en francais (si c'est pas merveilleux ca )

Remercier les autres, c'est quelque chose selon moi de plus important que les "Bonjour" et "Merci par avance" dans le premier message. Ca permet de marquer clairement deux choses : la (les) personne(s) qu'on remercie a (ont) aidé, et le problème est résolu.

Ainsi, une personne ayant le même problème et qui passe deux semaines après sais que la solution donnée par untel(s) était bien la bonne.

Dans le cas (très improbable, si vous avez bien suivi tous mes conseils ) où votre message resterait sans réponse, ne paniquez pas. Vous devez vous demander plusieurs choses :


Si vous avez oublié des informations importantes, il est possible que personne ne puisse vous aidez. Si vous remarquez un oubli, éditez votre message pour rajouter les informations.

Si l'écriture est trop affreuse, ou si par exemple vous avez écrit 30 lignes sans saut de ligne ni ponctuation, personne ne veut répondre. Dans ce cas là éditez votre topic en reprenant le style.

Si vous avez créé votre topic il y a 5 minutes, ce n'est pas la peine de s'affoler : c'est un forum, donc les réponses mettent souvent une heure, parfois plus pour arriver. Si jamais vous avez créé il y a plusieurs jours, et que votre topic n'est plus sur la première page, vérifiez que son contenu est nickel (éditez ce qui ne va pas). Vous pouvez poster un message "UP", pour le faire remonter en première page.





Attention cependant à ne pas en mettre trop : si vous uppez deux-trois fois et que personne ne répond, il vous faudra vous résigner, et admettre que personne ne répondra. Pas la peine sans doute de UPper à nouveau, et pas la peine non plus de recréer un nouveau topic.

Voici un petit résumé de ce qu'on a vu au cours de ce tutorial.

Aller au bon endroit

Le bon forum

Choisir la bonne catégorie

Ne pas poser une question déja posée

Avoir un titre clair

Citation : Convention pour les titres

Donner les informations utiles

(les informations facultatives sont entre parenthèses)

• Langage (version)
• (Système d'exploitation (distribution) (version))
• (Outils de développement (version))
• Ce que vous voudriez que votre programme fasse
• Le message d'erreur / l'entrée qui fait tout foirer
• Votre code

Voici en bonus un petit squelette zcode qui me semble permettre d'ordonner au mieux ces informations :

Code : Zcode

Si on vous répond, remercier

Citation : exemple de remerciement