[AIDE] J'ai un problème, je demande de l'aide

J’ai un problème et je demande de l’aide…

Cet article va vous aider à rédiger efficacement un message qui sera le plus compréhensible pour que la communauté puisse vous venir en aide.

Niveau requis

  • Débutant / Intermédiaire / Avancé

Matériels nécessaires / Matériels utilisés / Prérequis

  • votre problème
  • une connaissance succincte de votre installation

Avez-vous bien cherché

Êtes-vous sûr d’avoir bien cherché en utilisant les bons mots clés (voir l’article J’ai un problème, je cherche une solution), si c’est le cas, deux choix s’offrent à vous :

  • J’ai trouvé un fil de discussion qui parle de mon problème mais ne le résout pas

    Dans ce cas, dirigez vous vers le chapitre Rédiger un message.

  • Aucun fil de discussion ne parle de mon problème

    Vous allez donc en créer un avec Créer un fil de discussion.

Créer un fil de discussion

Un fil de discussion permettra de garder un historique des échanges entre vous et vos « dépanneurs ». Il permettra de suivre l’évolution de l’analyse de votre problème et les différents tests effectués.

Bien rédiger l’entête

L’entête est le résumé de votre problème. Il doit être clair et concis. C’est ce que les « dépanneurs » verront en premier et c’est ce qui les motivera à ouvrir votre fil de discussion pour vous aider.

Voici ce qu’il ne faut pas faire :

  • Erreur trop long

    Qu’est-ce que cette personne a bien pu vouloir dire :thinking:

  • Xiaomi Mi Band 3 4 et 5

    On ne cible pas le périmètre de la discussion, est-ce qu’il veut présenter son installation, est-ce qu’il a un problème avec son installation ? Quel est le problème ? Bref, ça vend pas du rêve :unamused:

Et voici de bonnes entêtes :

  • Déplacer docker vers un autre disque USB

    C’est clair, on sait à quoi s’attendre, et concis. Un expert en Docker sait qu’il peut être utile. :star_struck:

  • Activation de l’alarme sur indisponibilité d’un capteur

    Avec ce genre d’entête, il ne reste plus qu’à mettre le type de capteur dans le message et le problème est posé !

Bien choisir les étiquettes

Les « dépanneurs » ont tendance a lire les fils de discussions de sujets qu’ils maitrisent. Bien choisir les étiquettes dans lesquelles seront visible votre discussion est donc très important.

Le choix des étiquettes s’effectue en fonction des sujets que peut aborder votre problème.

Voyons quelques exemples :

  • Vous avez un problème sur l’installation de Home Assistant sur votre SSD. Votre SSD boote bien sur l’USB de votre Raspberry PI mais l’installation ne se fait pas.

    => Les étiquettes à ajouter seront installation, raspberry pi.

  • Vous essayez, tant bien que mal, d’installer un capteur Zigbee Xiaomi sur une carte personnalisée installée via HACS.

    => Les étiquettes à ajouter seront dans ce cas Zigbee, xiaomi, capteur/sensor, interface/lovelace, hacs, carte personnalisé/custom card.

Plus vous ajoutez d’étiquettes qui concernent votre problème, plus vous toucherez de bénévoles qui pourront vous aider.

Rédiger un message

Le message est ce qui va permettre aux « dépanneurs » de comprendre votre problème et d’amorcer la discussion avec vous pour le résoudre.

Un message trop succinct ne sert à rien et personne ne voudra y « mettre les pattes ».

  • « Ça marche pô !! :unamused: » n’a jamais fait avancé le smilblick !

A l’inverse une « tartine » de 3 pages est illisible, trop d’infos, tue l’info !

Partager ma configuration

Détailler sa configuration va permettre aux « dépanneurs » d’éliminer des questions qu’ils pourraient vous poser.

Que vois-tu dans les traces de Docker ?

=> Bah rien :thinking:, puisque je n’ai pas d’installation sous Docker :face_with_symbols_over_mouth:

Pour vous aider, allez dans la barre latérale, cliquez sur Configuration, puis Info et cliquez sur l’icône à droite de Santé du système et choisissez Pour Github.
Dans le 1er message de votre fil de discussion, collez le contenu du presse papier.

Le « dépanneur » pourra avoir une idée de votre installation. Rassurez vous, aucune donnée personnelles n’est visible dans cet export.

Les informations importantes à la résolution

Commencez par situer l’action :

  • expliquer ce que vous faisiez quand le problème est apparu.

    • Je suivais ce tutoriel et au chapitre …
    • Lorsque je redémarre Home Assistant via le bouton …

    Evidemment ce que vous faisiez en rapport avec Home Assistant, « j’ai mis l’eau des pâtes à chauffer » n’est pas utile :unamused: sauf si votre plaque de cuisson est connecté à Home Assistant :wink:.

  • qu’avez-vous vu qui diffère de d’habitude

    • Je n’arrive pas à me connecter à Home Assistant via mon navigateur et l’URL https://…
    • Mon capteur Xiaomi Aqara de mouvement n’est pas visible dans zigbee2mqtt lorsque j’active la détection.

Créer votre fil de discussion

Maintenant que vous avez bien lu les principes de création d’un fil de discussion, vous pouvez créer le votre soit :

Conclusion

Voilà vous avez les bases pour créer un fil de discussion et l’alimenter de messages pour que la communauté vous aide efficacement.

En espérant que nous vous aiderons à résoudre votre problème… :wink:

MAJ

  • 08/01/2021 : V1 @Sylvain_G Création du document
1 J'aime