Bel exemple de la Charrette : https://charrette.bike/pdf/documentation.pdf
1 « J'aime »
chez nous il y a eu des arbitrages sur la doc. Pour qu’elle soit le plus évolutive et participative possible des outils type git / readthedocs sont testés. Mais par conséquent c’est pas aussi beau que Veloma (charrette) qui a missionné une graphiste. Dilemme 
On pourrait aussi décider de sortie une belle doc de temps en temps, qui serait une photographie de la doc à un moment précis, joyeusement mise en page (ce que fait par exemple l’association tripalium avec ses guides de construction d’éoliennes)
1 « J'aime »
Dans mon univers d’imprimantes 3D, voici ce avec quoi nous travaillons, c’est parfait !
1 « J'aime »
Ca n’est pas très sexy, c’est un prototype issu d’un projet Européen, mais ça a le mérite d’exister.
Se poser la question de la documentation, c’est aussi se poser la question de l’ouverture et donc du niveau d’information que l’on délivre et pourquoi. Souhaite t on permettre la duplication, la réutilisation, l’enrichissement de la conception ?
Le template ne donne pas la réponse à ces questions, mais juste explore TOUTES les informations pertinentes à fournir dans un idéal d’open-source total (définition de l’OSHWA : study, make, replicate, sell).
2 « J'aime »
En effet, sujet majeur dont nous devrions avoir un petit atelier du jeudi matin dédié ! qu’en pensez vous @psl3d @constance-rfflabs @Vehicule_Techno @pierre_vspt
1 « J'aime »
Oui le sujet de la documentation est pas évident. Sur le vhélio on est parti sur git + le format Myst (une sorte de Markdown augmenté qui est utilisé notamment par Readthedoc).
Personnellement, je trouve ça super, mais je me rends compte que ça ajoute un niveau de complexité non négligeable pour les néophytes.
L’idée était de pouvoir permettre à tout le monde de contribuer à la doc en toute autonomie (via le mécanisme de « Pull Request »), en pratique, c’est finalement les personnes qui maîtrise l’outil technique qui devait centraliser les modifs et les faire elles-mêmes.
De plus, le rendu PDF a été difficile à bien calibrer, ces documentations étant plutôt faites pour du rendu HTML.
Nous sommes arrivé à quelque chose de plutôt joli (pas autant que Veloma bien sûr) et ça pourrait être intéressant de vous partager notre expérience.
Je pense qu’il sera important de bien documenter aussi la procédure qui permet de contribuer à la doc, pour l’instant c’est encore trop compliqué.
Dispo un jeudi matin si vous voulez (faudra que je prévienne le boulot).
Bonne journée,
Andréas
3 « J'aime »
Merci pour ces retours très riches ! Ce sujet est le coeur du réacteur si on veut avoir 5% de personne capable de documenter dans chaque communauté/projet
Cc @jaime
1 « J'aime »
Viens d’organiser l’Atelier du 20 avril sur ce sujet ! Faites circuler l’info
https://wiki.lafabriquedesmobilites.fr/wiki/Atelier_XD_58_documentation
en espérant avoir les équipes de Vhélio, Charette cc @veloma @Vehicule_Techno
1 « J'aime »
Super, je note la date !
Ce guide vient d’être rédigé pour la documentation de vos projets Guide de documentation pour l'extrême Défi — Communauté de la Fabrique des Mobilités
le CERN vient de mettre à jour sa plateforme pour héberger des projets open source Hardware : CERN’s new Open Source Program Office | CERN
pour Vhélio et Mosquito ? cc @marcl73 @Vehicule_Techno
1 « J'aime »
un tuto pour fabriquer un pédalier générateur.en licence creative commons CERN weakly reciropal. Le tuto est réalisé avec le low tech lab de Concarneau. Le pédalier a été testé pendant qlq mois dans le désert mexicain.Un reportage sur Arte montre les différentes étapes.
https://wiki.lowtechlab.org/wiki/Pédalier_générateur
2 « J'aime »
On étoffe nos ressources pour le vhélio. La documentation ne suffit pas, certaines personnes ont besoin d’éléments visuels, de conseils annexes…
On a cette page wiki qui répond à beaucoup de questions récurrentes : S'approprier le projet vhélio — Wiki vhélio
Et on a désormais ces vidéos, ça redit des mêmes choses mais en vidéo, et on peut visuellement se représenter un atelier d’assemblage : https://www.youtube.com/@vhelio8311/streams
Et enfin un timelapse « assemblage de 3 vhélios », on ne voit pas tous les ateliers annexes mais ça donne aussi une idée de l’orga de l’espace https://www.youtube.com/watch?v=hQUqz2tM1wQ
1 « J'aime »
Un projet en cours de développement intéressant pour les projets utilisant FreeCAD:
OSH Automated Documentation Il s’agit d’un « Workbench » qui permet de générer un beau PDF imprimable avec des vues pour les étapes de montage.
2 « J'aime »
super,
ça pourrait grandement nous servir (vhélio).
Jusqu’à présent on utilise un workbench « fait maison » par un de nos bénévoles (démo ici).
2 « J'aime »
Nous allons bientot diffuser des tutos de fabrications de cadre du #tripalette - le tricycle charge lourde.
ca me pose qlq questions,
Quels sont les meilleurs moyens pour difuser au plus grand nombre? (forum, journaux,…)
Comment les usagers peuvent il bien s’approprier un outil comme un git et contribuer ?
merci d’avance pour vos tuyaux
2 « J'aime »
génial ! je pense que Vhélio a réalisé un super boulot et notamment la mise à jour automatique de guide de montage quand la CAO est modifiée. Vhélio utilise FreeCAD je crois. cc @marcl73
voici le tutoriel pour la fabrication du tricycle tripalette en creative commun open hardware:
nous avons ouvert un git pour le tricycle ici : https://framagit.org/Veloma/tripalette qui diffuse les plans et les méthodes, en particulier la fabrication du cadre!
Le fichier est disponible à l’impression en 12Mo sur le git, pour bien voir les détails. un autre version est aussi disponible sur le site de veloma: https://veloma.org/2024/06/06/tutoriel-fabrication-cadre-tricycle/
4 « J'aime »
Effectivement je trouve qu’il y a eu un super travail des bénévoles du projet sur la doc mais on n’est pas à ce niveau d’idéal (= MAJ automatique suite à modif dans la 3D)
On n’est pas encore satisfait du fonctionnement de nos MAJ.
-
Les + :
. la dernière version de travail du guide de montage est accessible au plus grand nombre via cette page Guide de montage — Vhéliotech
. n’importe quel adhérent de notre asso peut facilement détailler une amélioration sur le vhélio via un outil dédié. -
Le gros - :
l’édition finale des fichiers de la doc est encore réservée à quelques personnes initiées.
La version courte : on se demande encore comment faire de l’open hardware de manière collaborative et large sans reposer sur un noyau d’initiés sachant manipuler git.
La version longue (cliquez si vous êtes vraiment curieux sur nos méthodes)
La documentation est composée de nombreux fichiers : plans électriques, fichiers 3D, guide de montage, notice d’usage, nomenclature etc.
Seuls les fichiers 3D et le guide de montage sont éditables dans un logiciel collaboratif (= git.vhelio.org).
Les autres sont stockés sur notre serveurs et édités un à un avec numéros de version.
Seules 2-3 personnes vont en pratique proposer des modifs via git pour le guide de montage, et quasi toute la 3D est proposée sur git par une seule personne. Là on n’est pas très résilients !
A contrario on a beaucoup de personnes qui participent à faire des propositions de modifs sur des ateliers, via notre forum ou en interne dans l’asso. Pour collecter toute cette matière ça a longtemps été bordélique, avec des fichiers retours d’expérience qui s’accumulaient un peu partout dans notre serveur.
Depuis peu on utilise un logiciel de gestion de tâches, bien plus accessible, ça s’appelle redmine : redmine.vhelio.org
ça sert à planifier toute tâche qu’on ne peut pas réaliser tout de suite. Tous nos adhérents y ont accès, et on y retrouve plein de groupes de projets. Donc si on l’applique à la mise à jour du guide de montage, si je veux consigner 3 améliorations récoltées pendant un atelier je me connecte sur l’appli redmine, et je détaille 3 tâches avec photos /dessins si possible dans un projet MAJ doc / MAJ guide de montage. Les 2-3 adeptes de git iront piocher dedans pour faire les MAJ quand ils auront du temps à y consacrer.
Ensuite un autre logiciel (readthedoc), permet d’afficher dans une page web publique toutes les versions du guide de montage validées sur git : documentation.vhelio.org
Mais une validation dans git n’est gérée que par les 2-3 adhérents qui s’y trouvent, c’est pourquoi la version en cours « main » s’affiche avec un avertissement, elle n’a pas réellement été validée par l’asso (on leur fait totalement confiance, mais ça enfreint notre idéal de gouvernance)
Pour qu’une version de la doc soit numérotée et validée pour publication dans notre espace documentation, ça doit reposer sur une relecture plus collective par nos adhérents, et ça on n’arrive pas à le faire plus d’une fois par an, et c’est encore à l’ancienne avec des pdf/doc annotés !
note : quand on est adhérent à l’asso Vélo Solaire Pour Tous on obtient un identifiant unique pour utiliser tous ces outils, et ils sont tous accessibles depuis le tableau de bord nextcloud qui est la porte d’entrée de notre environnement numérique.
2 « J'aime »