Comment nous aider à vous aider - ou Comment poser une bonne question?

Avant de commencer…

Ce forum n’est pas un Helpdesk

La plupart des gens ici ne travaillent pas pour Jeedom SAS, à moins que cela soit spécifiquement indiqué dans leurs profils. Et même s’ils peuvent passer parfois sur le forum, ce n’est pas le moyen officiel d’obtenir du support. Les autres, nous offrons volontairement de notre temps libre pour vous aider. Certaines demandes peuvent ne pas recevoir de réponses et peut-être justement celle qui correspond à votre problème.

Il ne s’agit pas non plus d’un forum général sur l’informatique, c’est un forum sur Jeedom et la domotique en rapport à Jeedom seulement. Pas que nous soyons fermés aux autres solutions, il y a du bien partout (ce texte est justement adapté d’une autre solution), mais nous préférons nous concentrer sur Jeedom exclusivement. Toute question à propos de Jeedom est donc la bienvenue, cependant, nous ne pouvons vous aider sur tout, nous ne sommes pas Batman !

image


:one: La Recherche

Il n’est pas improbable que votre question ait déjà été posée, et déjà répondue. Si vous effectuez une Recherche sur le forum, vous pourriez trouver la réponse et vous faire gagner beaucoup de temps.

Cependant, il est possible que vous ne trouviez pas la réponse parfaite à votre question, mais cela vous guidera déjà pour commencer.

Lorsque vous écrivez un nouveau sujet, sur la partie droite (où le panneau de prévisualisation apparaît), vous verrez des suggestions de sujet. Elles sont basées sur votre titre, les tags et le contenu de votre sujet. Vérifiez les avant de poster.

Si vous trouvez un post qui résout votre problème, likez-le svp. Cela aidera les autres à voir que cette réponse a été utile et permet à la personne qui l’a écrite de savoir qu’elle a aidé des gens.

:two: Comment rechercher?

Essayez de rechercher uniquement la base de votre problème - le message d’erreur (sans les données spécifiques), le nom du plugin, du composant du core que vous utilisez (scénario, etc), l’action que vous voulez effectuer, etc

Quelques exemples de recherches classiques :

  • 502 bad gateway
  • client denied by server configuration: /var/www/html/vendor/phpunit
  • Class object not found plugin-tutu

:three: J’ai trouvé un sujet similaire, du moins je crois… mais il est déjà résolu (ou vieux) et j’ai toujours le problème. Dois-je poster dedans ?

La rêgle d’or c’est : non.

Ce que vous pouvez faire cependant, c’est poster votre question dans un nouveau sujet et mettre un lien vers le sujet que vous avez trouvé (voir :nine: Montrez votre avancement plus bas).

En évitant les énormes sujets avec des centaines de réponses, la recherche est facilitée, l’aide est plus efficace et on préserve la règle un sujet = une demande.

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

La documentation se trouve ici. Il y a quelques parties que tout le monde devrait lire :

Pensez à sélectionner la version du core sur la partie gauche.

Attention, Jeedom est en perpétuelle évolution. Si vous consultez un post dans le forum, sur le blog de quelqu’un, dans une video youtube ou un article qui est vieux de plusieurs mois, il peut contenir d’anciennes informations. Le mieux est de consulter cette documentation pour voir les dernières modifications.

N’oubliez pas, les plugins contributeurs (tiers) ont leur propre documentation. Vous pouvez la consulter via la page configuration de ceux-ci (lien en haut), dans la documentation ou via le market.


Préparez la question

:five: Utilisez la catégorie adéquate

Les catégories sont assez explicites, si vous avez un doute, restez dans « Discussions Générales ». Mais le mieux est de catégoriser correctement votre demande :wink:

:six: Utilisez les tags adéquats

Les tags (étiquettes) peuvent être attribués à votre sujet, il aidera le moteur de recherche a classer votre sujet et les autre utilisateurs à trouver de l’aide sur ce sujet plus facilement.

Ils indiquent le plugin ou le composant jeedom core pour lequel vous avez un problème. Si vous n’étiquetez pas correctement un sujet sur un plugin, il est probable que vous n’obteniez aucune réponse.

Attention cependant, si votre problème est en lien avec le matériel, il ne faut pas étiqueter le plugin, le développeur ne peut rien y faire.

:seven: Un titre explicite

Avoir un bon titre est essentiel. Il doit pouvoir résumer votre demande et donner directement l’indication sur le sujet de votre demande.

Un bon titre veut dire :

  • Qu’il inclut une partie unique de l’erreur que vous obtenez
  • Si c’est le cas, qu’il fait référence à votre équipement domotique précisément (marque/ modèle)
  • Qu’il contient l’action que vous désirez faire.
  • Qu’il ne contient pas d’émotionnel.

Exemples:

  • Bon Comment planifier un scénario à une heure précise?
  • Mauvais problème de planification
  • Affreux Encore un problème - j’en ai marre, aidez-moi !
  • Bon Z-Wave - Impossible d’inclure le périphérique ZXX123 - Erreur 421
  • Mauvais ZXX123 pas découvert
  • Affreux Problème ZWave

Si vous ne voyez pas comment écrire un bon titre, laissez le pour la fin, quand vous avez écrit toute votre question, il sera plus simple de trouver un titre pour la résumer.


Contenu de la question

Avant de poster, merci de consulter et de suivre les recommandations du forum.

Encore une fois, évitez l’émotionnel, il ne peut que rebuter les gens à vous aider. Restez factuels.

De plus, ce forum étant à unique but d’entraide et de partage, les liens sponsorisés ou affiliés n’ont pas leur place ici.

:eight: Décrire le but, pas le problème

Il est facile de tomber dans le piège du problème XY. Si vous décrivez d’abord votre but, les autres peuvent comprendre ce à quoi vous essayez d’arriver.

:nine: Montrez votre avancement

Si vous arrivez avec une demande qui suggère que vous n’avez entrepris aucun effort, il est peu probable que vous receviez de l’aide de qualité, votre sujet pourrait même être ignoré. Expliquez ce que vous avez déjà tenté, vos recherches, vos essais, comme :

  • « Voici d’autres sujets que j’ai déjà consulté et testés », indiquez ce qui n’a pas fonctionné pour vous.
  • Décrivez ce que vous avez tenté, et quels ont été les résultats.

En montrant que vous avez essayé, cela démontrera que vous n’attendez juste pas que les gens travaillent pour vous, ça montrera votre motivation. Ce qui motivera les personnes à vous aider !

:one::zero: Indiquez le matériel et la version sur laquelle Jeedom tourne.

Dites nous si vous tournez sur un Raspberry et sa version, sur une VM, quel hyperviseur, une installation Docker, autre matériel. Ensuite indiquez aussi la version du core de Jeedom et la version de votre Debian (beaucoup de ces infos se retrouvent dans la page Santé de votre Jeedom).

Exemple:

  • Jeedom 3.14.15 sur un Rapsberry Pi 3b+ tournant sur un disque SSD sous Debian Stretch 9.5
  • Jeedom 4.44.7 tournant sur une VM proxmox en utilisant l’image Debian buster x64 10.1.1
  • Jeedom 3.14.15 sur un Docker Synology en utilisant l’image officielle de Jeedom
  • Jeedom 4.0.12 sur la Freebox delta, installé en utilisant le tuto du site http://www.tartempion-fait-de-la-domotique.fr

Rappelez-vous que des mots comme la dernière version, celle de ce matin, la version actuelle etc ne sont pas des numéro de version et changent dans le temps.

:one::one: Formatez correctement

L’affichage des logs ou du code que vous envoyez est important, il convient d’utiliser l’icone </> de l’éditeur afin de les afficher correctement, le formatage utilise le format Markdown .

Par exemple, ceci est facile à lire et claire :

[2020-08-13 21:16:45][DEBUG] : {"etat":{"valeur":"termine"},"graphe":{"decalage":0,"puissanceSouscrite":0,"periode":{"dateFin":"12/08/2020","dateDebut":"01/09/2019"},"data":[{"valeur":162.028,"ordre":0},{"valeur":193.57,"ordre":1},{"valeur":233.902,"ordre":2},{"valeur":254.518,"ordre":3},{"valeur":223.291,"ordre":4},{"valeur":210.546,"ordre":5},{"valeur":232.506,"ordre":6},{"valeur":210.026,"ordre":7},{"valeur":125.552,"ordre":8},{"valeur":164.113,"ordre":9},{"valeur":180.598,"ordre":10},{"valeur":60.52,"ordre":11}]}}

Cependant, ceci ne l’est pas :

[2020-08-13 21:16:45][DEBUG] : {« etat »:{« valeur »:« termine »},« graphe »:{« decalage »:0,« puissanceSouscrite »:0,« periode »:{« dateFin »:« 12/08/2020 »,« dateDebut »:« 01/09/2019 »},« data »:[{« valeur »:162.028,« ordre »:0},{« valeur »:193.57,« ordre »:1},{« valeur »:233.902,« ordre »:2},{« valeur »:254.518,« ordre »:3},{« valeur »:223.291,« ordre »:4},{« valeur »:210.546,« ordre »:5},{« valeur »:232.506,« ordre »:6},{« valeur »:210.026,« ordre »:7},{« valeur »:125.552,« ordre »:8},{« valeur »:164.113,« ordre »:9},{« valeur »:180.598,« ordre »:10},{« valeur »:60.52,« ordre »:11}]}}

En résumé, vous pouvez cliquer sur l’icône </> de l’éditeur du forum ou entourer votre code par trois apostrophes inversées(```).

:one::two: Décrivez ce qui a changé

Si cela fonctionnait, alors dites nous ce qui a changé. Si vous avez modifié le scénario, mis à jour quelque chose (le core, le plugin, ajouté un périphérique, etc), nous avons besoin de le savoir. Ne dites pas juste le dernier changement, donnez tous les changements effectués.

Rappelez-vous également - seulement un changement à la fois, puis testez. Si vous modifiez plusieurs choses et que ça fonctionne, impossible de savoir ce qui a résolu le problème. Pire, peut-être une seule des modifications a résolu votre problème, mais l’autre en a peut-être créé un autre.

:one::three: Partagez-nous vos logs

Si quelques chose ne fonctionne pas, vérifiez les logs et vérifiez si vous voyez passer quelque chose de lié à votre problème. Lisez ces logs, il est possible que la résolution y soit indiquée. Dans Jeedom, les logs sont accessibles via l’interface dans Analyse > Logs. Évidemment, ce sont les logs en niveau « debug » qui nous intéressent ici. S’il y a un démon, redémarrez-le après avoir modifié le niveau de log et reproduisez votre problème.

Quelques logs intéressant à vérifier :

  • les logs du plugin concerné (log normal, dépendances, autre… mais tous commençant par l’id du plugin).
  • http.error (dans le cas d’une erreur 500 par ex)
  • cron_execution
  • update

etc

Au plus vous nous donnez d’informations, au plus il est probable que le problème puisse être identifié.

:one::four: Captures d’écran

Ne dit-on pas qu’une image vaut mieux qu’un long discours ?
Ajouter une capture d’écran peut aider grandement à la compréhension de votre problématique.

N’envoyez pas une capture d’écran pour tout ce qui touche à un log ou du code, préférez l’écrit.
Merci d’inclure uniquement des captures qui aideront vraiment.

:one::five: Relisez avant d’envoyer

Oui, relisez votre demande avant de l’envoyer. Assurez-vous de ne pas vous être perdus à mi-chemin, que tout a du sens, que le titre, les tags et la catégorie font toujours sens.

L’autre chose à veiller est d’utiliser les paragraphes, de la ponctuation et des espaces. Un mur de texte n’est agréable à lire pour personne.

:one::six: Dois-je tagger un développeur avec @ ?

De manière générale : non.

Cela est perçu comme de l’impolitesse, vous demandez expressément à quelqu’un de vous répondre. C’est différent si vous désirez le remercier évidemment :slight_smile:

Si néanmoins vous taggez quelqu’un, assurez-vous de rester polis et respectueux. Pas d’attaques personnelles, de piques, rappelez-vous que sur le forum, tout le monde est volontaire, personne ne doit vous aider. Même pour un plugin/service payant, dans ce cas, préférez le support officiel de celui-ci.

De la même manière, évitez les messages privés en demandant aux gens de vous aider. Cela vous fait passer pour quelqu’un d’exigeant et d’égoïste. En effet, les autres ne peuvent pas apprendre de votre résolution/problème si vous le gardez privé.

Nous avons la chance de profiter de la présence du développeur principal de la solution Jeedom sur le forum. Ce n’est pas une raison pour le mentionner dans vos demandes, il interviendra de lui-même s’il le juge nécessaire et nombres d’autres utilisateurs seront également en mesure de répondre à votre demande.


J’ai posté ma demande…

:one::seven: Attendez…

Oui, nous sommes une grosse communauté, mais la personne qui pourrait exactement vous aider n’est peut-être pas disponible pour l’instant. Cela peut prendre des heures, voir des jours pour avoir une réponse.

:one::eight: Oui mais ça fait des jours…

Si personne n’a rien répondu après quelques jours, relisez votre demande, vérifiez le titre, la catégorie, les tags, ou même le contenu de votre demande. Relisez ce guide pour voir si vous avez manqué quelque chose d’important.

Si vous pensez que tout est bon et non perfectible, alors considérez une relance. Mais ne le faite pas trop et trop rapidement, cela fera fuir les gens.

:one::nine: J’ai résolu !

Génial ! Répondez à votre propre demande en donnant tous les détails de résolution et utilisez le bouton de Solution afin d’indiquer votre réponse comme tel (voir point :two::one:))

Ne supprimez pas votre question, vous souhaitez aussi aider les autres, non ?

:two::zero: Les gens répondent mais je n’ai toujours pas de solution…

C’est parfois le cas. Il y a toujours des choses que les gens ne savent pas (parce que vous ne les avez pas dites, ou peut-être que vous ne saviez pas que vous deviez le dire, ou simplement car la limite de leur connaissances est atteinte)

Si une aide qui vous a été donnée a fait avancer les choses, faites le savoir. Cela encouragera les gens à continuer de vous aider. Si cela n’a pas fait avancer, dites le également et indiquez le résultat clair. Cela encouragera les réponses aussi.

:two::one: Une réponse a permis de résoudre mon problème !

Fantastique!

Maintenant, avant que vous partiez… prenez le temps de marquer cette réponse comme Solution en utilisant ce bouton caché derrière les petits points :
image
et cochez :
image image

N’oubliez pas tant que vous êtes là de cliquer sur le petit cœur sur la solution, c’est aussi une manière de dire merci.

:two::two: Soyez respectueux

Et lisez les conditions générales d’utilisation.

:four::two: En conclusion

Essayez :wink:

Et rappelez-vous, il n’y a aucune garantie que vous recevrez une réponse - personne n’est obligé de vous en fournir une sur ce forum. Ce que vous pouvez faire c’est écrire une demande claire et pertinente en donnant toutes les informations à votre disposition et plus si on vous demande. Montrez que vous essayez, faites preuve de bonne volonté, cela motivera les gens qui vous aident.

Vous pensez que quelqu’un devrait lire ce message ? faites-y référence en utilisant l’icone lien image ci-dessous

Nouveau : vous pouvez référencer directement un numéro en ajoutant #heading--16 (deux tirets !) derrière l’url

Annexe :a: Reference Utile : Liberté d’expression sur un forum privé

Nous sommes tous humains et chacun peut être dans une mauvaise journée, ou avoir passé du temps sur un problème bloquant, ou ressentir une frustration sur un sujet ou une réponse d’un autre utilisateur. Nous le comprenons, c’est normal, ça arrive à tout le monde !

Il donc est possible que les modérateurs doivent retirer ou modifier un ou des posts de ce forum, ou qu’un sujet soit clôturer avant que vous ayez eu le temps d’exprimer ce que vous ressentiez. De par leur rôle, les modérateurs sont garants de la cohésion, de l’ordre et sont en quelque sorte la police du forum.

Même si personne n’aime être repris ou corrigé, vous comprendrez que c’est parfois un mal nécessaire. Ce n’est pas par gaieté de cœur, juste par nécessité afin que le forum garde son but initial : répondre aux questions des utilisateurs. Et que ces réponses puissent en aider d’autres.

Concernant la modération (sur un forum privé avec inscription) et son assimilation à de la censure ou à une restriction de la liberté d’expression : voici un article intéressant :

https://www.aduf.org/viewtopic.php?p=1819740

Concernant l’idée de la liberté d’expression, elle ne s’applique pas à des espaces privés. Ceci signifie que sur un espace privé le propriétaire a le droit d’imposer ce qu’il veut aux personnes qui participent, tant que cela respecte la loi française (pas de discrimination raciale par exemple).

Ces espaces possèdent une charte que l’utilisateur accepte avant de poster sur ces espaces. Tant que la charte respecte la loi française, elle est en droit restreindre ce qui peut être dit. C’est un peu comme le fait de ne pas pouvoir entrer dans certaines boîtes de nuit si l’on porte des baskets. Sur un forum, on pourrait très bien refuser de publier tout sujet qui ne serait pas écrit sous forme de poème et qui ne parlerait pas de poisson rouge : ce ne serait pas en contradiction avec la loi sur la liberté d’expression.

Je rajouterais également que vous restez libre de vous exprimer à d’autres endroits. (C’est cela la liberté d’expression)

58 « J'aime »

Pour information :slight_smile:

3 « J'aime »