Comment poser une question sur le forum

Si vous souhaitez poster dans un forum, c’est que vous avez un but. Généralement, celui-ci est d’obtenir de l’aide, vous débloquer sur un point ou lancer un débat, un échange.

Ici, on va considérer que vous cherchez de l’aide car c’est de loin la raison pour laquelle on commence à poster dans un forum.

Mais dans tous les cas, si vous postez dans un forum, vous avez un but et ce but implique d’échanger avec d’autres personnes. N’oubliez pas ce but lorsque vous écrivez. Votre but doit être clairement identifiable dès les premières phrases de votre message.

Demandez de l’aide

Vous avez un problème et vous souhaitez qu’on vous aide. La règle primordiale est « Aide-toi toi-même ». Vous devez partager toutes les informations dont vous disposez, toutes informations qui vous semble utiles. Soyez le plus informatif possible.

Vous avez des contraintes ? Alors présentez-les ! Présentez le contexte dans lequel vous rencontrez votre problème, si c’est un exercice, un problème que vous rencontrez chez vous, à votre travail.

Le lecteur doit disposer d’autant d’information que vous. Aidez-le à vous aider et par cela, vous vous aidez vous-même.

En particulier présentez votre problème initial en premier, pas un problème secondaire, pas votre solution. Si vous pensez avoir un début de solution, c’est très bien, mais présentez d’abord le problème initial avant de présenter votre solution et où vous rencontrez un problème.

Si vous demandez de l’aide alors c’est que vous rencontrez un vrai problème, présentez la difficulté que vous rencontrez. En particulier expliquez ce que vous avez déjà fait. C’est important car quelqu’un vous aidera peut-être, mais personne ne résoudra votre problème à votre place. Si vous ne montrez pas un peu d’engagement dans le problème alors ça sera perçu comme de l’impolitesse en demandant à résoudre un problème qui finalement n’est pas très important pour vous.

Souvenez-vous que personne ne vous doit de réponse mais qu'il y a certainement quelqu’un prêt à vous aider.

Exemples

Il manque un contexte, pourquoi calculer ça ? Il n’y a pas la présentation de ce qui a déjà été fait.

Ici, on a bien le contexte et même si rien n’a été fait, c’est énoncé clairement.

Pour poster sur un forum, il y a quelques règles.

De manière générale, on vous demandera de respecter la nétiquette qui est un ensemble de règles de bon-sens et de politesse. Soyez courtois. Vous vous adressez à des humains, on s’attend à ce que vous saluez et que vous remerciez.

À part cela, il n’y a pas de règles particulières mais le forum peut avoir ses propres règles. Si c’est le cas, alors elles seront toujours présentées dans un sujet épinglé du forum.

Voilà pour ce que vous devez respecter dans la forme. Mais ce n’est pas tout à fait tout.

Postez dans le bon forum

Si vous postez, c’est que vous souhaitez être lu. Alors autant être lu par les bonnes personnes, celles qui peuvent vous aider.

C’est en particulier pour ça que vous devez estimer si votre question est dans le bon forum où pas. Si vous vous trompez ce n’est pas catastrophique, mais vous peinerez plus à avoir une réponse avant d’être redirigé vers le bon forum.

Utilisez les outils à votre disposition

Le forum vous propose un ensemble d’outils pour améliorer la lisibilité de votre message. La plupart de ces outils sont disponibles depuis la barre d’outils au-dessus de votre message.

Certains outils sont plus utiles que d’autres. Utilisez avec parcimonie par exemple les emphases (gras et italique). Modifier l’alignement dans un message est généralement une mauvaise idée.

Poster un code

Si vous avez une question en programmation vous serez amené à poster un code. Si vous parlez d’un code alors postez le. Il n’y a aucune raison de ne pas le faire.

N’ayez pas peur qu’on vous vole votre idée, ou que quelqu’un retrouve que vous avez demandé de l’aide. Ce n’est pas le propos de ce billet mais ce sont des peurs infondées qui ne doivent pas vous empêcher de poster votre code.

Car s’il a un problème, une aide éventuelle ne peut pas le deviner. Sans le problème, personne ne peut vous aider.

Déjà, si vous avez une erreur alors postez là. Que ce soit une erreur du compilateur, d’exécution ou une sortie incohérente. Ensuite, si l’erreur indique une ligne, poster au minimum les lignes autours de cette ligne. Si vous postez une fonction, alors indiquer comment vous l’appelez.

Si votre code est de petite taille ou de taille raisonnable (moins de 200 ou 300 lignes environ) alors ne vous posez pas de question, postez tout votre code.

L’idéal quand vous postez un code est d’isoler le problème le plus possible. D’avoir un problème reproductible. Essayer au maximum de construire quelque chose qu’un lecteur puisse exécuter chez lui et qu’il puisse reproduire le problème.

Présentez votre code

Il y a des outils dans Markdown pour présenter votre code. En particulier dans la barre d’outils, il y a un bouton pour ça.

Le format pour présenter un code et que vous obtenez à partir du bouton de code est celui-ci :

```

```

Vous devez placer votre code entre les deux lignes de ```. Vous pouvez également préciser le langage que vous utilisez si ceci n’est pas évident et de manière à correctement adapter la coloration syntaxique.

Par exemple ceci :

```js
for(const i = 0; i < n; i++) {
  console.log("I love you !");
}
```

Remarquer que la première ligne de ``` est immédiatement suivie du nom du langage ici js.

Qui donnera :

for(const i = 0; i < n; i++) {
  console.log("I love you !");
}

Pour une explication plus complète, je vous renvoie vers le tutoriel Rédiger sur ZdS qui présente l’ensemble des fonctionnalités lié aux codes.

Poster une image

Tout d’abord, ne postez pas une image de code. Poster un code directement.

Ensuite, pour poster une image sur Zeste de Savoir, c’est très simple, il suffit de glisser déposer l’image la zone d’édition du message.

Poster une formule mathématique

ZMarkdown, le Markdown de Zeste de Savoir support $\LaTeX$ qui est un format créer pour bien présenter des mathématiques.

Je vous renvoie vers le tutoriel Rédiger sur ZdS qui explique comment s’intègre $\LaTeX$ dans ZMarkdown.

Si $\LaTeX$ vous est inconnue alors ne paniquez pas, essayez et si vous n’y arrivez pas alors écrivez de manière la plus claire selon vous.

Vous avez fini d’écrire votre message. Avant toute chose, vérifier que celui-ci se présente bien. Il y a plusieurs aperçus disponibles.
Vous pouvez utiliser l’aperçu de la barre des outils mais le plus efficace est d’utiliser le bouton « Aperçu ».

Relisez-vous avant d’envoyer votre message. Les erreurs d’orthographe accrochent l’œil et perdent le lecteur. Quelques erreurs ne sont pas graves, mais vos phrases doivent avoir du sens.

Sachez que si vous avez posté trop vite, il est toujours possible d’éditer votre message après coup grâce au bouton « Éditer ».