Aide:Documenter : Différence entre versions

Version actuelle en date du 7 novembre 2017 à 17:00

La documentation : un principe fondateur des fablabs

Comme cela est indiqué dans la charte du MIT, le partage des connaissances et des savoirs-faire est un principe de base des fablabs : les usagers s'engagent à "contribuer à la documentation et à l'acquisition des connaissances".

Pourquoi documenter?

- Partager du savoir Dans l'esprit de la culture libre, et parce que vous avez certainement déjà profité de la documentation d'autres personnes, votre documentation permettra à d'autres usagers de refabriquer, améliorer ou adapter votre réalisation.

- Gagner du temps Documenter son projet et ses différentes étapes permet de se souvenir de ce que l'on a déjà fait et de ne pas refaire les mêmes erreurs.

- Avoir des retours Souvent au cours de l'élaboration d'un projet, on a besoin de l'aide d'autres usagers : une documentation détaillée leur permettra de bien le comprendre et donc de vous aider plus efficacement.

- Éviter de se blesser ou d'abîmer du matériel Une bonne documentation de l'utilisation des machines et des outils permet d'améliorer la sécurité dans les ateliers.

Que documenter ?

Sur ce wiki vous pouvez documenter vos travaux personnels ou collectifs (étapes, matériaux et machines utilisées, difficultés rencontrées, etc) mais aussi :

- contribuer aux [| pages d'utilisation des machines] (astuces, réglages, etc),

- partager des tutoriaux, des astuces techniques, des informations sur le fonctionnement de logiciels, sur le travail de certains matériaux,

- compléter les pages d'informations de la partie "À propos des fablabs".

De manière générale, n'hésitez pas à corriger ou améliorer le contenu déjà présent dans ce wiki.

Comment et quand documenter? Quelles informations mettre dans sa documentation ?

Avant : exposer son idée

Exposer son idée permet de se l'exprimer clairement à soi même, et facilite la communication du projet à d'autres personnes susceptibles de vous aider

Fiche-idée papier ou scannée ?

exemple from meuhlab:

version vierge:

télécharger la fiche en svg,pdf et png

Pendant : faire un journal de bord

Pas à pas, documenter l'expérience avec les essais ou les problèmes rencontrés et leurs résolutions.

Le cahier de laboratoire ou journal de bord permet de se souvenir des étapes de recherches, de garder des traces pour soi-même et éventuellement d'autres personnes qui travailleront sur ce sujet.

À la fin : présenter le projet finalisé

Raffiner le travail du journal de bord pour le rendre lisible et pour valoriser le projet. En gras : les éléments indispensables à mettre dans une documentation

• Titre du projet
• Une belle image
• Porteur du projet : lien vers page participants
• Date
• Licence : libre !
• Contexte
• Fichiers source principaux : liens
• Inspiration, source du projet
• Tags
• Avancement (Concept, Développement, Beta, Fini)
• Machines utilisées
• Ingrédients(matériaux, composants...)
• Fournisseurs, bons plans
• Logiciels
• Description (5 lignes, état de l'art, matériaux, galerie photos...)
• Réalisation (=> conception)

//medias supports//

Bonnes Pratiques/ Références/Mise en page

Dépliant : faire, documenter, partager

Ce dépliant tiré de cette page Media:DepliantVraimentLibre.svg

Il a été réalisé suite à une session de travail à Marseille en octobre 2014

Une nouvelle version est publiée ici : http://reso-nance.org/files/lfo/docfablab/ Version plus aboutie Fichier:Depliant.documentation.zip

Affiche Licence

Media:Licences.pdf
Media:Licences pfc.svg
Media:Typos.zip