Demander de l'aide / Signaler un problème

Sommaire
  1. Avant de demander de l'aide
  2. Collecte d'informations
  3. Formuler une demande d'aide
  4. Les listes de discussion
  5. Discussion relayée par Internet
  6. Faire un signalement sur la forge
  7. Quelques références

Les problèmes rencontrés ont fréquemment déjà trouvés une solution, il existe diverses sources d'informations à disposition :

  • les documentations ;

  • la FAQ des documentations ;

  • les archives des listes de diffusion.

Avant de demander de l'aide

  • Avez-vous consulté la documentation du projet ?

  • Avez-vous consulté la FAQ ?

  • Avez-vous consulté les archives des listes de discussion ?

  • Avez-vous effectué un reconfigure sur le serveur ?

  • Avez-vous répondu oui aux 4 questions listées ci-dessus ?

Collecte d'informations

Il faut collecter des informations permettant la compréhension et le contexte du problème rencontré. Par contre il faut trouver un juste milieu entre trop peu d'information et trop d'information.

Voici des informations qui selon le contexte vont être utile à la description du problème :

  • La version précise du module utilisé ainsi que le niveau des mises à jour (stable, candidat, développement) ;

  • Résultat de la commande de diagnostic diagnose (diagnose -L pour un diagnostic étendu) ;

  • Les différentes étapes permettant de reproduire le problème rencontré ;

  • Les extraits de fichiers de journalisation  ;

  • Toutes informations connexes ayant un rapport avec votre problème (les adaptations locales, patch, dictionnaires additionnels, logiciels supplémentaires, etc.) ;

  • Joindre des copier/coller et/ou des captures d'écran ;

  • Générer un rapport avec la commande gen_rpt ;

La commande gen_rpt permet de générer une archive incluant :

  • les fichiers de configuration EOLE du serveur ;
  • le diagnostic étendu ;
  • la liste des processus en cours sur le serveur ;
  • les règles de pare-feu appliquées sur le système ;
  • l'historique des commandes système  ;
  • la liste des paquets installés ;
  • plusieurs fichiers de journalisation ;
  • le rapport d'extraction (Module Scribe) ;
  • le rapport de sauvegarde (Module Scribe/Horus/Eclair).

L'archive nommée <module>-<numéro-etab>.tar.gz est enregistrée dans le répertoire courant au lancement de la commande.

Complément

Si une passerelle de courrier a été définie sur le serveur, l'archive pourra être directement envoyée à l'équipe EOLE (merci de ne pas en abuser) ou à l'adresse de votre choix.

Attention

Dans la collecte d'informations peuvent se trouver des informations sensibles, attention à leur diffusion sur des médias publics : IRC, liste de discussion, demande sur la forge…

Formuler une demande d'aide

Lorsque vous posez une question, gardez à l'esprit que ceux qui la liront n'auront que votre message pour se représenter votre demande. Essayez de donner une description précise du problème. Les informations précédemment collectées vous aiderons à fournir des détails.

Conseil

  • Écrivez dans un langage clair et concis, pas de langage SMS, soignez la grammaire et l'orthographe, cela permet d'éviter certains quiproquos ;

  • Soyez précis et explicite sur le contexte du problème ou de l'aide demandée.

    Ne dites pas Quand je clique sur la disquette ça marche pas. mais dites plutôt Dans LibreOffice, quand je clique sur l'icône en forme de disquette j'obtiens l'erreur suivante : "copiez le texte intégral de l'erreur ou faites une capture d'écran" ;

  • Décrivez les symptômes du problème, évitez les suppositions ou les interprétations.

    Préférez dire Le fond d'écran ne s'affiche pas plutôt que Un firewall doit sûrement bloquer mon fond d'écran ;

  • Décrivez la chronologie des événements et/ou des symptômes de votre problème ;

  • Décrivez le but à atteindre, le comportement attendu ;

  • Le volume d'information n'a rien avoir avec la précision des informations attendues ;

  • Ne dites jamais que votre problème est URGENT même si c'est le cas, personne n'aime se sentir contraint par le caractère urgent de la demande ;

  • Ne posez votre question qu'une seule fois, même si la réponse se fait attendre. Il est par exemple possible que la réponse nécessite des recherches et donc du temps.

Conseil

La Nétiquette décrit un certain nombre de règles lors de l'envoi de messages sur une liste de discussion, merci de les respecter.

http://fr.wikipedia.org/wiki/Nétiquette

Vous trouverez le développement intégral des différents points évoqués ci-dessus dans le document présent à cette adresse : http://www.gnurou.org/writing/smartquestionsfr

Les listes de discussion

Les listes de diffusions sont un espace d'échange qui est source d'aide et d'informations. Chaque module EOLE possède sa propre liste. Pour échanger sur les listes il faut préalablement être inscrit.

http://eole.orion.education.fr/listes

La liste de diffusion est un bon endroit pour poser votre question. Cependant la quantité des messages et leur contenu demande une certaine organisation de tous afin que les échanges restent cohérents, efficaces et cordiaux.

Conseil

Voici quelques points à suivre lors de l'envoie d'un message :

  • Utilisez un sujet le plus explicite et le plus adapté possible ;

  • Envoyez vos messages dans des formats lisibles par tous les clients de messagerie : le texte brut est très apprécié, le HTML et les images animées beaucoup moins ;

  • Si votre courrier comporte une énorme pièce jointe, préférez utiliser la compression ou l'utilisation d'un dépôt de fichiers externe ;

  • Ne postez jamais d'informations confidentielles sur une liste de diffusion ;

  • Nouveau sujet est équivalent à un nouveau fil de discussion. N'utilisez pas la fonction Répondre à un ancien message en en modifiant l'objet pour lancer un nouveau sujet. Créez vraiment un Nouveau message. Sinon, en classant par fils de discussion votre message sera confondu avec un autre sujet et risque de ne pas être vu.

  • Laissez l'historique de la conversation dans votre réponse, pour ceux qui vous aide et qui n'ont pas votre problème en tête cela constitue un aide-mémoire et permet de se replacer rapidement dans le contexte.

  • N'activer pas de répondeur (message d'absence) sur une liste de discussion ;

  • N'écrivez pas en privée aux membres de l'équipe, préférez exposer vos remarques publiquement pour le bénéfice de tous ;

  • Pour écrire à la liste n'utilisez pas un ancien message pour en modifier le sujet, le fil de discussion serait endommagé, il faut ouvrir un nouveau fil de discussion avec un sujet parlant.

Discussion relayée par Internet

Internet Relay Chat ou IRC sert à la communication instantanée principalement sous la forme de discussions en groupe par l'intermédiaire de canaux de discussion, mais peut aussi être utilisé pour de la communication de un à un.

Vous pouvez nous rejoindre sur le canal #eole hébergé sur irc://irc.oftc.net:6667 ou grâce à l'interface https://webchat.oftc.net.

Conseil

  • Il est demandé de mettre son nom réel dans les paramètres du client. ;

  • La Nétiquette décrit un certain nombre de règles lors de l'envoi de messages sur une liste de discussion, merci de les respecter.

    http://fr.wikipedia.org/wiki/Nétiquette

Remarque

Le Pôle de Compétences Logiciels Libres utilisait Freenode depuis 2008 comme réseau IRC.

Suite aux changements des conditions d'usages de Freenode, la gestion du canal #eole nous a été enlevé sans préavis. Vous avez pu constater que les lignes d'accueil ont disparu. Maintenant, les utilisateurs doivent créer un compte (SSO) pour accéder à notre canal.

Faire un signalement sur la forge

Il est possible de faire des remonter aux travers des différents listes de discussion du projet EOLE mais pour une bonne prise en charge il vous sera demandé de saisir une demande dans la forge.

Il est possible de demander des évolutions, de l'aide ou de signaler des erreurs directement sur la forge à l'adresse suivante : http://dev-eole.ac-dijon.fr/projects/modules-eole/issues/new

Truc & astuce

Pour se faire il est recommandé de regarder avant si la demande n'existe pas déjà à l'adresse :

http://dev-eole.ac-dijon.fr/projects/modules-eole/issues

Conseil

Lorsque vous renseignez un signalement, veillez à suivre ces quelques recommandations :

  • Soyez clairs, donnez des explications claires de façon à ce que d'autres puissent reproduire le dysfonctionnement ;

  • Séparez clairement les faits des suppositions ;

  • S'il n'ont rien à voir, faites un signalement par dysfonctionnement rencontré ;

  • Si vous avez des informations susceptibles d'aider à résoudre le problème ou si vous avez la solution, n'hésitez pas à les joindre à votre demande.

Quelques références