Améliorer la page /documentation pour expliquer le standard

[laem]

Nosgestesclimat est de facto le standard de la simulation d'empreinte climat de consommation open source, car il n'en existe aucune autre activement développée.

Ici on a une belle inspiration graphique pour une page qui explique le principe et les avantages : https://projects.codesandbox.io

[laem]

Autre problème, on a très peu de variables exposées par défaut sur la page documentation.

Comme si le moteur limitait le nombre.

:heavy_check_mark: résolu

[Clemog]

Amélioré avec https://github.com/betagouv/publicodes/pull/250 ?

[Benjamin-Boisserie-ABC]

Qu'est-ce qui te semble pas adapté dans la documentation en ligne, précisément ? #1385

Pour quelqu'un qui se décide à creuser le fonctionnement NGC la page documentation n'est pas claire.

Le seul moyen de "naviguer" est de se rendre en fin de simulation et de cliquer "comprendre le calcul" mais parcourir tout le modèle prend un temps très long.

Mais si je comprends bien on va pouvoir grâce à un travail de mon-entreprise.fr améliorer fortement cette navigation. Cela répondra très certainement à une grande partie des remarques soulevées (notamment imbrication des variables filles et mères). A voir si on peut aller plus loin dans cette affichage (explications méthodo approfondies, limites, etc.) même si j'ai bien compris que c'est un gros boulot derrière.

Toutefois, je reste persuadé qu'un document téléchargeable dans un format plus classique bénéficiera à des types d'acteurs plus traditionnels et favorisera sa réappropriation/utilisation (institutionnels, bureau d'étude, futurs réutilisateurs mêmes)

[laem]

Ah oui je comprends mieux. Clairement la "page d'accueil" est mauvaise :+1:

Je reviens sur l'idée du téléchargement : j'ai l'impression que l'impression de patauger dans un gros truc serait également présente si on donnait à télécharger un tableur.

Pour le tableur, le seul outil de hiéarchisation de la donnée, c'est les onglets (par exemple un par catégorie : logement, transport, etc.), qui devraient donc être couverts par la future interface de publicodes.

Y en a-t-il d'autres ?

Si je suis pas favorable au téléchargement, outre le fait que c'est du boulot, c'est que :

• ça crééerait des "versions" en dur non à jour du modèle, les gens auraient modèleNGCv3.45.xlsx et nous feraient des remarques sur des versions obsolètes
• le tableur ne serait plus exécutable, donc ce serait compliqué de se rendre compte du modèle, sans le valeurs
• toutes les descriptions seraient difficile à afficher, pourtant elles sont importantes pour comprendre le modèle.

[Benjamin-Boisserie-ABC]

Ok je visualise mieux les problématiques qu'engendre le téléchargement et notamment le fait qu'une version en dure ne soit plus en accord avec la version actuelle.

Mais si je comprends bien, on peut envisager une clarification et hiérarchisation des variables et des règles via un travail de dev de votre côté.

Pour ce qui est de l'export Excel, j'ai peut être mal formulé ce que je voulais dire. Cela s'approche plus d'un recueil méthodologique. Probablement qu'il n'y aurait pas à détailler toutes les variables, on renverrait vers le site pour ça (qui sera amélioré). Mais ce recueil méthodo serait l'occasion d'expliquer la philosophie derrière l'outil et les choix faits pour certaines estimations (souvent résumés de manière très brèves dans la fonction "note" d'une variable). On trouverait ainsi :

• la philosophie de l'outil : modèle, action, fiches explicatives, sondage, guide de l'animation, profil type.
• le détail des postes en résumant les hypothèses d'importance : Ex : prenons le cas d'un futur modèle "maison secondaire" et considérons qu'on prend reprend la méthode que j'ai proposé. Cette méthode s'appuie sur des nombreuses hypothèses (pas de conso en parallèle entre maison secondaire et principale ; conso équivalente d'un logement à l'autre, résidence secondaire uniquement française, allocation uniquement aux utilisateurs réguliers) qu'il convient d'expliciter car à l'heure actuelle elles ne le sont pas.
• et en réalité il y a d'autres hypothèses qui comme dans l'exemple mis en avant, ne sont pas explicitées. La toute de suite je pense à :
  • alimentation : pourquoi on choisit une approche repas moyen et non un détail ;
  • consommation : pourquoi on opte pour un modèle posant une question sur l'effort de préservation de ces équipements et non l'âge des dits équipements
  • et probablement d'autres je pense notamment sur le volet action

Pour ce qui est du fait que ce document ne soit pas à jour, je comprends que ça soit problématique mais un message d'en-tête pourrait mentionner qu'il faut vérifier qu'il s'agit bien de la dernière version du modèle

Après j'entends que ça puisse être un travail fastidieux de mettre un tel doc à jour. Peut être y-a t'il meilleure solution?

[laem]

À mon avis il faut améliorer la /documentation, aussi bien en termes d'interface que de contenu. C'est trop coûteux de maintenir deux corps séparés de documentation.

Par exemple :

pourquoi on choisit une approche repas moyen et non un détail ;

Une super question pour la doc :+1:, par exemple cette page, complètement vide https://nosgestesclimat.fr/documentation/alimentation/déjeuner-et-dîner