[Tutoriel] Aidez nous à vous aider ! Comment bien formuler votre demande d'aide

Bonjour,

Ce message est une traduction du post: How to help us help you - or How to ask a good question - Configuration - Home Assistant Community que l’on trouve sur le forum anglophone.

Un rappel en forme de tuto, à lire avant de poster une demande d’aide sur le forum, afin de maximiser vos chances d’obtenir la meilleure aide qui soit.


Préambule

Ce forum n’est pas un Service Après Vente

Les intervenants du forum ne travaillent pas pour Home Assistant, qui est un projet Open Source. ils sont tous là sur leur temps libre, dans le seul but de partager autour de sujets en lien avec Home assistant. Tous les sujets n’obtiendront pas forcément de réponse, et parfois les réponses ne vous aideront peut être pas à résoudre votre problème.

Ce n’est pas non plus un forum général sur la domotique, l’informatique ou la maison. C’est un forum dédié à Home Assistant et aux sujets qui s’y rapportent. Toute question sur Home Assistant, et sur l’utilisation de tout ce qui interagit avec Home Assistant, est la bienvenue ici. Cependant, il ne sera pas possible de vous aider à propos de tout ou n’importe quoi.


Avant de poster

:zero: Langue

Ce forum est un forum francophone. Pour des questions en anglais, il suffit d’aller sur le forum anglophone: https://community.home-assistant.io/ . Il peut d’ailleurs être utile d’y faire un tour avec divers outils différents de traduction disponibles pour y chercher des solutions.

Il existe d’autres forums de discussions dans d’autres langues si nécessaire.

:one: Recherche

Il est possible que votre problème ait déjà été soulevé par quelqu’un et même résolu. Utilisez la recherche sur le forum, vous pourriez trouver la réponse et vous épargner beaucoup de temps.

Vous n’y trouverez peut-être pas la réponse parfaite à votre question, mais cela pourrait vous rapprocher suffisamment pour commencer.

Si vous trouvez une publication qui résout votre problème, cliquez sur le cœur sous cette publication (liker). Cela aidera les autres à identifier cette publication comme utile, et informera l’auteur qu’il a aidé des gens.

Pensez à consulter le Portail HACF, il contient une liste d’articles rédigés par la communauté sur de nombreux sujets, un tutoriel détaillé s’y trouve peut être déjà.
Pour les nouveaux arrivants (mais aussi les autres), n’oubliez pas qu’il y a toute une section du portail dédiée aux premiers pas sur Home assistant !

:two: Comment chercher

Essayez de ne rechercher que le cœur de votre question, le message d’erreur (sans vos données spécifiques), le nom du composant ou de l’add-on, l’opération que vous souhaitez effectuer, etc.

Quelques exemples de recherches pour des scénarios courants :

  • hassio “no such image”
  • va et vient sans neutre
  • Z2M configuration

:three: J’ai trouvé un sujet similaire, mais il est déjà résolu et j’ai toujours un problème. Dois-je poster dedans ?

En règle générale – non.

Ce que vous pourriez faire, c’est poster votre question dans un nouveau sujet et y mettre un lien vers le sujet que vous avez trouvé (voir également 9 Montrez ce que vous avez fait ci-dessous).

:four: Avez-vous lu (et recherché dans) la documentation ?

La documentation est là (en anglais), et la liste des intégrations est ici.
Il y a quelques sections fortement recommandées que tout le monde devrait lire (utilisez les solutions de traduction évoquées ci dessus si nécessaire):

La documentation et les intégrations possèdent également des fonctions de recherche.

Attention, Home Assistant évolue rapidement. Si vous consultez une publication sur le forum, un article de blog, ou une vidéo YouTube qui date de plusieurs mois ou années, cela pourrait contenir des informations obsolètes. Si vous rencontrez des problèmes, il est bon de vérifier par rapport à la documentation actuelle.

N’oubliez pas, les add-ons ont aussi leur propre documentation. Dans de nombreux cas, elle sera intégrée à l’add-on, ou accessible via celui-ci, mais sinon vérifiez la page de l’add-on ou le dépôt GitHub pertinent (pour un add-on non-core, sur HACS par exemple).

Même si ce n’est pas vraiment de la documentation officielle, n’oubliez pas les articles disponibles en Français sur le Portail HACF, en particulier aussi la section débuter. Des dizaines de tutoriaux vous y attendent.


Le problème n’a pas été résolu, il est temps de poster votre demande d’aide.


Au moment de poster, comment créer la bonne question

:five: Utilisez une catégorie pertinente

Les catégories sont assez explicites, utilisez les afin que vos messages arrivent au bon endroit. En l’occurrence « Entraide Home Assistant » pour une demande d’aide.

:six: Utilisez des balises pertinentes

Les balises sont ajoutées à un sujet pour aider à améliorer le moteur de recherche du forum, ainsi que pour donner un contexte supplémentaire aux personnes lisant votre question.
Les balises courantes incluent tutoriel, mqtt, templates, switch, etc.

:seven: Soignez votre titre

Avoir un bon titre de sujet est essentiel. Il devrait résumer votre publication de sorte que, sans même l’ouvrir, les lecteurs puissent avoir une bonne idée de ce dont il s’agit. Un bon sujet inclut généralement :

  • La partie unique de l’erreur que vous obtenez
  • Le nom de l’intégration ou la description de l’action
  • La description de ce avec quoi vous avez un problème
  • Un ton neutre (sans émotion)

Par exemple :

  • Bon Comment utiliser un minuteur dans une automatisation pour retarder une action ?
  • Mauvais Le minuteur ne fonctionne pas
  • Horrible Problème/Besoin d’aide
  • Horrible Automatisation KO
  • Bon Z2M - Impossible d’inclure le dispositif ZXX123
  • Mauvais ZXX123 non découvert
  • Horrible Problème Z2M

Si vous avez du mal à rédiger un bon titre de sujet, laissez-le pour la fin, une fois que vous aurez écrit toute la question, il sera plus facile d’écrire un titre qui résume votre problème.

Rédiger son message: comment poser correctement sa question

Rappel, nous sommes sur un forum public, restons courtois! L’ambiance du forum est positive et bienveillante, protégeons là!

Commencez par dire Bonjour par exemple…

:eight: Décrivez votre but, pas juste votre problème

Il est facile de tomber dans le piège du problème XY, dit autrement vous avez peut être pris le problème à l’envers, ou êtes parti sur une mauvaise piste.
Si vous prenez quelques phrases pour décrire votre objectif en premier plutôt que votre problème, les autres peuvent comprendre ce que vous essayez de réaliser, même si vous êtes parti sur une fausse piste, et vous proposer des solutions auxquelles vous n’aviez pas pensé.

:nine: Montrez ce que vous avez fait

Si vous arrivez avec une demande d’aide qui suggère que vous n’avez fait aucun effort, vous êtes moins susceptible d’obtenir une aide de qualité, et votre publication pourrait même être ignorée. Expliquez un peu ce que vous avez fait jusqu’à présent, comme :

  • Lien vers d’autres fils de discussion que vous avez trouvés et essayés, et expliquez pourquoi ils ne vous ont pas aidé
  • Décrivez ce que vous avez essayé et quels ont été les problèmes

Montrer que vous avez fait des efforts vous aidera à démontrer que vous ne cherchez pas simplement que les autres fassent tout le travail à votre place.

:one::zero: Dites-nous comment vous avez installé Home Assistant

Dites-nous si vous utilisez une image HAOS officielle, une installation Docker, une installation machine virtuelle, etc. Les informations souvent très utiles à connaître incluent :

  • Quel numéro de version de Home Assistant utilisez-vous ?
  • Comment vous l’avez installé. Si vous n’utilisez pas une installation basée sur HAOS, n’oubliez pas de nous indiquer le système d’exploitation
  • Tout code pertinent - correctement formaté

tout est expliqué dans le template des messages d’aide…

Souvenez vous que des mots comme dernière, actuelle, plus récente, etc., ne sont pas des numéros de version.

Cette suggestion s’applique également si vous avez un problème avec un addon ou un module complémentaire (par exemple obtenu avec HACS). A minima citez le module utilisé et si possible sa version…

:one::one: Formatez le code correctement

Lorsque vous partagez du code, partagez-le sous forme de texte et non d’image. Rappelez-vous que l’indentation (les espaces en début de ligne) est critique en YAML, et si vous collez simplement le code sur la page, il aura l’air moche et personne ne saura si le problème est dû à l’indentation.

Il est indispensable d’utiliser la touche balises </>.
Par exemple:

  • ceci est facile à lire et il est possible de voir si l’indentation est correcte :
# Turn off lights when everybody leaves the house
  - alias: 'Rule 2 - Away Mode'
    trigger:
      platform: state
      entity_id: group.all_devices
      to: 'not_home'
    action:
      service: light.turn_off
      entity_id: group.all_lights
  • ceci, ne l’est pas alors qu’il s’agit exactement du même texte, mais copié sans les balises ``` :

Turn off lights when everybody leaves the house

  • alias: ‹ Rule 2 - Away Mode ›
    trigger:
    platform: state
    entity_id: group.all_devices
    to: ‹ not_home ›
    action:
    service: light.turn_off
    entity_id: group.all_lights

En bref, utilisez le bouton </> dans la barre d’outils de l’éditeur (il peut être caché, si c’est le cas, cliquez sur le + à droite) ou encadrez votre bloc avec trois accents graves (```).

:one::two: Décrivez ce que vous avez changé

Si cela fonctionnait auparavant, dites-nous ce qui a changé depuis. Si vous avez modifié une automatisation, mis à jour quelque chose (une intégration personnalisée, un add-on, Home Assistant lui-même, etc.), dites le. Ne mentionnez pas seulement le dernier changement, dites tous les changements.

N’oubliez pas non plus – ne changez qu’une seule chose à la fois, puis testez. Si vous changez plusieurs choses et que cela fonctionne maintenant, vous ne savez pas ce qui a résolu le problème. Pire encore, l’une de ces choses l’a peut-être résolu, mais l’une d’entre elles a peut-être introduit un nouveau problème.

:one::three: Partagez les journaux (logs)

Si quelque chose ne fonctionne pas, vérifiez les journaux (log) et voyez si des éléments y sont enregistrés. Le journal de Home Assistant est disponible dans l’interface utilisateur, bien que les informations sur les composants personnalisés n’apparaissent que dans le fichier journal sur disque, ou vous pouvez les vérifier en utilisant la ligne de commandeha core logs. Gardez à l’esprit que l’interface utilisateur ne montrera que les erreurs, et d’autres entrées peuvent être utiles et pertinentes. D’autres sources comprendront :

  • Fichier journal de Home Assistant homeassistant.log
  • Journal du Superviseur
  • Journaux des add-ons

Pour les automatisations et les scripts, assurez-vous d’inclure la trace de débogage. Télécharger et partager le fichier .json de la trace est un moyen efficace de fournir des informations sur la conception de votre automatisation et ce qui échoue.

Plus vous en dites, plus il est probable que le problème puisse être identifié.

:one::four: Captures d’écran

Parfois, une image vaut mille mots, et inclure une capture d’écran peut aider. Ne le faites pas pour tout ce que vous pouvez copier et coller de votre configuration, YAML, code ou journaux (voir au dessus en particulier les balises </>). Veuillez inclure uniquement des captures d’écran qui sont réellement utiles.

:one::five: Relisez avant de poster

Oui, relisez votre propre publication avant de la poster. Assurez-vous que vous n’avez pas perdu le fil en cours de route, que cela a toujours du sens et que le sujet, les balises et la catégorie ont toujours du sens.

Utilisez les paragraphes, la ponctuation et les espaces blancs. Un mur de texte est plus difficile à lire qu’un message aéré.

C’est le bon moment pour vérifier, modifier ou écrire votre titre…

:one::six: Dois-je taguer des personnes ?

Généralement, non.

Cela donne l’impression d’être impoli, vous exigez que quelqu’un vous réponde. C’est différent si vous remerciez quelqu’un, évidemment.

Si vous taguez quelqu’un, restez poli et respectueux. Rappelez-vous que tout le monde est bénévole, et que personne n’est obligé de vous aider.

De même, veuillez ne pas envoyer de MP (message privé) aux gens pour demander de l’aide. En plus de paraitre exigeant, cela signifie que les autres ne peuvent pas apprendre de ce que vous faites. Votre demande d’aide, surtout si elle est bien formulée, profitera sans doute à ceux qui auront le même problème (alors qu’un message privé restera privé et non accessible aux autres).


Après avoir posté…

:one::seven: Attendez…

Oui, la communauté est très active, mais ceux qui peuvent vous aider ne sont peut-être pas disponibles. Plusieurs heures, voire un jour ou deux, peuvent être nécessaires pour obtenir une réponse.

:one::eight: Mais ça fait des jours…

Si personne n’a répondu après quelques jours, relisez et voyez si le titre, la catégorie, les balises, ou même la publication elle-même nécessitent une attention particulière. Relisez ce guide et voyez si vous avez manqué quelque chose d’important. Le titre peut sans doute être repris pour attirer les gens les plus susceptibles de répondre.

Si vous pensez que tout est aussi bon que possible, alors vous pouvez envisager de le faire remonter en postant une réponse pour le rendre plus visible. Faire cela trop souvent, ou trop rapidement, peut vous faire paraître exigeant, et cela éloignera les gens.

Si vous avez tenté d’autres choses pour résoudre le problème dans l’intervalle mais qu’elles n’ont pas marché, dites le (voir point 9 ci dessus)…

:one::nine: J’ai résolu le problème !

Génial.

Mais afin de bénéficier à tous, prenez le temps de répondre à votre publication avec les détails de la façon dont vous avez résolu le problème. Puis utilisez l’option pour marquer cette réponse comme la solution (voir 21 ci-dessous).

Ne supprimez pas votre question, pensez que d’autres peuvent être confrontés au même souci que vous, c’est votre manière de contribuer, c’est un mini tuto que vous êtes en train de faire, qui servira sans doute à d’autres (à l’étape 1, recherche, de ce tutoriel). La solution apparaitra alors en raccourci sous le premier message décrivant le problème pour permettre à quiconque ayant le même problème de trouver rapidement le message permettant de le résoudre, quelle que soit la longueur de la file de messages.

:two::zero: Des membres répondent, mais je n’ai pas la réponse

C’est fréquent. Il y aura toujours des choses que les membres ne savent pas (parce que vous ne leur avez pas dit, et peut-être même que vous ne saviez pas qu’il fallait le dire, ou parce que cela dépasse les limites de leurs connaissances).

Si quelque chose que les membres ont dit vous a fait avancer, faites-le leur savoir. Cela encouragera à continuer de vous aider.

Si ce n’est pas le cas, faites savoir aux gens que vous avez essayé leur suggestion, et ce qui s’est passé. Encore une fois, cela encourage à continuer de vous aider.

Soyez ouverts, et essayez les suggestions des membres, envoyez les informations supplémentaires demandées, faites les tests.

Si vous ne comprenez pas les réponses qui vous sont faites, soyez franc et respectueux… « Je ne sais pas où trouver cette information », « Où puis-je trouver cet élément de configuration », « Comment créer un sensor template? » etc…

:two::one: La réponse de quelqu’un a résolu le problème !

Fantastique ! Maintenant, avant de partir… prenez le temps de marquer ce message comme la réponse, vous le faites en sélectionnant la case à cocher sous le message qui vous a aidé:
image

Vous pouvez aussi cliquer sur le cœur pour liker cette publication et d’autres, en guise de remerciement aux auteurs…

Ne vous attribuez la solution que si vous avez trouvé ça tout seul (voir #19 ci dessus).

La solution apparaitra en raccourci sous le premier message pour permettre à quiconque ayant le même problème de trouver rapidement le message permettant de le résoudre, quelle que soit la longueur de la file de messages.

:two::two: Soyez respectueux

Les modérateurs veillent, mais autant leur faciliter le travail… Préservons l’ambiance de ce forum. Petit rappel, personne ici n’est obligé de vous répondre, souvenez vous en…

:two::three: N’utilisez pas ChatGPT ou tout autre IA pour aider les autres

N’utilisez pas ChatGPT, ou des outils similaires, pour générer des réponses à des demandes d’aide sans les avoir testées. Ces outils produisent souvent des résultats qui semblent bons mais qui sont incomplets, trompeurs ou tout simplement faux.

:two::four: Cela parait trop simple, ça ne peut pas fonctionner, n’est-ce pas ?

Essayez :slightly_smiling_face:

Rappelez-vous, il n’y a jamais de garantie que vous obtiendrez une réponse – personne n’est tenu d’en fournir une. Ce que vous pouvez faire, cependant, c’est fournir une publication avec des informations de soutien pertinentes, qui montre que vous faites des efforts. Cela encouragera les gens à vous aider. Ayez confiance, cette communauté est formidable!

:two::five: Et si on inversait les rôles ?

Pourquoi ne pas à votre tour partager ce que vous avez appris? Vous remarquez une demande d’aide qui ressemble à un sujet que désormais vous connaissez? Vous connaissez un message, un tuto qui vous a aidé dans cette situation ? A votre tour d’aider!
Essayez :slightly_smiling_face: vous verrez, ça marche…

7 « J'aime »

Salut @BBE,
bonne initiative, j’ai épinglé le sujet dans la section entraide.

1 « J'aime »

Merci BBE pour cet aide mémoire.

1 « J'aime »