Comment demander de l'aide

Tout d'abord une grosse erreur que font souvent les étudiants est de demander de l'aide sans donner les informations indispensables pour les aider et résoudre le problème.

Si vous demandez de l'aide, à un enseignant, un camarade ou sur Internet, il faut bannir les formules du type "ça ne marche pas", "ça ne s'affiche pas", non accompagnées d'un message d'erreur (le plus souvent au moins le message d'erreur des logs du serveur affichés en bas dans NetBeans) et d'une description précise de la situation et des étapes que vous avez suivies pour arriver au problème.

Si vous envoyez du code, la moindre des choses est de faciliter sa lecture en indentant correctement le code et en choisissant des noms de variables significatifs.

N'envoyez pas de capture d'écran, sauf pour présenter ce que voit l'utilisateur et si c'est important pour expliquer le problème. On ne peut pas faire de copier-coller sur des copies d'écran pour chercher une partie de ce que contient la copie d'écran. Par exemple, n'envoyez pas une capture d'écran d'une partie des logs du serveur d'application, envoyez tous les logs (en première approche, enlevez du log les parties qui n'ont évidemment rien à voir avec le problème). Quel est le meilleur pour votre bilan carbone, envoyer 3 lignes de texte ou bien envoyer une copie d'écran de 100 Ko pour ces 3 lignes ?

Si votre demande d'aide est publique (par exemple sur stackoverflow), attention à ne pas envoyer des informations sensibles (mots de passe par exemple).

Dans la description précise, il y a au moins

Pour la description de votre environnement de travail :

Les personnes qui souhaitent vous aider auront du mal à le faire si vous ne leur facilitez pas la vie. Elles vont devoir deviner où vous avez pu faire une erreur et seront obligées de vous reposer des questions ; la plupart ne le feront pas et elles ne vous aideront pas.

Si vous ne recevez aucune réponse à votre demande d'aide, il faut aller encore plus loin dans la description de votre problème. Le mieux est de joindre à votre demande d'aide un projet qui reproduit le problème (voir comment faire avec NetBeans) ou un lien vers un projet GitHub public. Le projet doit être élagué de tout ce qui n'a rien à voir avec le problème pour simplifier la vie des personnes qui pourront vous aider. Souvent cette étape de simplification du code vous fera comprendre vous-même quel est le problème et vous permettra de vous passer d'une aide extérieure. Là encore, n'oubliez-pas d'enlever du projet toutes les informations sensibles comme les mots de passe que vous utilisez vraiment dans votre projet.