• bg-blog

    Le Blog Wikifab

    Documenter un projet de DIY est compliqué et fastidieux. Notre mission est de réparer ça !

open source

Documenter signifie partager ses experiences et ses découvertes pour permettre à d’autres de ne pas faire les mêmes erreurs. Documenter renforce un projet puisqu’il se construit grâce aux contributions des autres, et plus seulement les nôtres.

Documenter c’est transformer l’expérience d’un individu (ou groupe d’individus) en savoir libre qui bénéficiera à n’importe qui, n’importe ou, n’importe quand.

Saurez-vous répondre à cette question…

À qui bénéficie un projet bien documenté ?

a) Vous même
b) Les autres
c) Le projet lui-même
d) Les 3 à la fois

Vous avez deviné… la réponse est d) Les 3 à la fois.

Comment la documentation VOUS aide ?

En rédigeant une documentation claire de votre projet, vous recevez le bénéfice immédiat de clarification et de formalisation de votre pensée. En effet, rédiger une documentation vous incite à filtrer et clarifier l’information communiquée aux autres. Ce processus fait généralement naitre de nouvelles interrogations ou solutions que vous n’auriez pas considérés jusque là.

Documenter apportera à votre Future Vous de nombreux bénéfices.

Aujourd’hui vous ne connaissez pas encore votre Future Vous, mais il y a fort à parier que vous aurez beaucoup de choses en commun avec lui. Future Vous sera certainement ravi de relire votre documentation un jour (que ce soit dans deux semaines, deux ans ou même vingt ans), Future Vous voudra se rappeler ce qui s’est passé ce jour pendant lequel vous avez fabriqué votre objet.

Car Future Vous n’a pas une aussi bonne mémoire que vous le pensez ! La mémoire de Future Vous aura besoin d’être rafraîchie sur ce qui s’est passé pour retrouver facilement les fichiers sur lesquels vous avez travaillé, les liens vers les ressources que vous avez utilisé et le tutoriel pour reproduire l’objet en suivant le processus original. En créant une documentation claire et complète de votre projet, vous simplifierez grandement la vie de Future Vous !

France_in_XXI_Century._Air_postman
Soyez sympa avec Future Vous, l’avenir n’est pas toujours ce que l’on croit !(Wikimedia Commons)

La documentation vous aide aussi car elle invite à la collaboration et au partage des idées et des besoins. Des facteurs qui vont motiver les contributeurs externes à vous aider.

Vous ne connaitrez sûrement jamais toutes les personnes qui sont intéressés pour travailler avec vous pour résoudre vos problèmes, mais grace à votre documentation vous les informez que vous travaillez sur le projet.

Ce qui nous amène à…

Comment la documentation aide LES AUTRES ?

Une documentation claire et facile à appréhender permettra à d’autres personnes de comprendre la problématique à laquelle vous cherchez à répondre, ce que vous avez essayé, jusqu’ou vous êtes allé et quelles sont les problèmes ou questions pertinentes que vous vous êtes déjà posés.

Avec ces informations, le lecteur comprendra en un instant si votre sujet l’intéresse et s’il peut vous apporter son aide; que ce soit en contribuant directement, en suggérant des idées, ou encore en parlant de vous sur les réseaux sociaux ou à des personnes compétente de son entourage.

Une bonne documentation est un gain de temps pour le lecteur (votre potentiel collaborateur).

Il est possible que votre experience aide les autres à voir leur propre projet d’un autre angle, ce qui leur permettra peut-être de résoudre les problèmes auxquels ils étaient confrontés. Ou peut-être verront-ils un lien entre vous/votre projet et d’autres personnes de leur réseau.

Sans une information présentée de façon utilisable, accessible et détaillée, ils ne pourront comprendre ce sur quoi vous travaillez, et encore moins vous aider ou emmener votre idée plus loin.

Comment la documentation aide LE PROJET LUI-MÊME ?

Vous êtes un être humain (Enfin j’imagine… Bonjour à tous les bots et mignons petits dauphins qui lisent ça aussi !).

Les êtres humain sont distrait, leurs centres d’intérêts évoluent, leurs contextes personnel et professionnel changent.

Ce n’est pas parce que vous postez un tutoriel sur Wikifab que vous dédierez votre vie à votre projet.
Et d’ailleurs vous ne devriez pas !
Votre projet et les découvertes qui gravitent autour seront plus pérennes si elles ne dépendent pas que d’une seule personne.

La documentation est la première étape pour vous libérer de la lourde charge qu’est votre responsabilité personnelle envers le projet. Elle permet à d’autres contributeurs de vous rejoindre dans votre rôle « d’intendant » du projet.

Elle est également un acte d’invitation et d’inclusivité (par opposition à exclusivité). En couchant sur papier vos travaux, vous invitez au dialogue et à l’échange. Vous montrez au monde que vous êtes ouvert aux contributions externes et que vous y accordez de l’importance.

Enfin, si vous vous faites renverser par un bus ou attaquer par un vilain dauphin, votre projet et vos idées perdureront.

dolphin
On n’est jamais trop prudent.. (CC-BY Ross Hawkes)

Une dernière chose – que vous n’avez peut-être pas en tête Si vous gardez l’information pour vous ou si vous ne partagez qu’une partie qu’à certaines personnes, vous perdez le potentiel collaboratif de la documentation. En rendant l’information publique (sous licence libre) n’importe qui pourra utiliser l’information ou la transmettre à d’autres qui en feront quelque chose d’utile.

La pérennité et la diffusion d’une bonne idée (en particulier si elle contribue à la sauvegarde de notre planète) dépendent des contributions de tous. Sur-protéger une idée ou ne la partager que « lorsqu’elle sera prête » peut compromettre sa survie !

Références

J’ai initialement posté cet article en anglais sur le forum de la communauté OSCEdays et, en tant que membre de la communauté Wikifab, je suis ravi de la partager ici.

-Sam Muirhead
@CameraLibre

Lire la suite

Aujourd’hui, la plupart des connaissances nécessaires à la fabrication d’un produit sont inaccessibles par leur complexité ou sont « protégées » par des brevets. En mettant à la disposition de tous les « recettes de fabrication » de votre produit, vous permettez aux citoyens de s’approprier certains secteurs économiques et de ne plus dépendre d’une industrie en particulier.

Nous avons réalisé cette vidéo qui expliquent les principes et enjeux de l’open source hardware en 2 minutes.


Parce que même si vous êtes le ou la meilleur(e) créateur(rice) du monde, partager votre recette de fabrication vous permettra d’améliorer votre propre produit et d’apprendre de nouvelles choses.

Les inventions de l’humanité appartiennent à tous et se nourrissent de tous ! C’est cela l’ambition de l’économie open source !

Lire la suite