Pourquoi documenter?

les bonnes raisons et motivations :

cette information manque
pour gagner du temps
pour partager les bons plans
pour éviter de casser du matos
pour éviter de se blesser
pour optimiser son projet
inviter aux réutilisations
avoir des retours et des avis d'autres gens
parc'que j'ai profité de la documentation d'autres personnes
pour ne pas refaire les mêmes erreurs
Rendre les choses plus accessibles
pour pouvoir refaire comme un carnet de bord
pour partager du savoir

à partir de quand documenter?

qu'est-ce qui vaut le coup?

"chaque petit chat est authentique" : même le travail le plus simple peut être intéressant à documenter, ne serai-ce que pour apprendre à bien documenter

Quand c'est utile à soi / aux autres

Que documenter?

un Projet
une page ressource
- sur une machine
- sur un logiciel
- sur un matériel
- politique
- culturelle
un atelier pédagogique

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 à soit même, et facilite la communication du projet à d'autres personnes susceptibles de vous aider

sur papier
sur le tableau
sur le forum
directement sur le wiki

Pendant : faire un journal de bord

Sur la page projet du wiki, créée à l'aide de la page Création_d'un_Projet

A 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)
liens web utiles

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

Vous pouvez vous baser sur la page Exemple de projet

Choix de Licence

Affiches

File:Affiche_documentation.zip

Liens Projets/présentations

Mediamatic
http://www.mediamatic.net/search/251345/en
Open Processing
http://www.openprocessing.org/
Instructables
http://www.instructables.com/
Hannah Perner-Wilson
http://www.plusea.at/?p=1855
http://kit-of-no-parts.at/
sa thèse au MIT sur la documentation pratique dans un environnement de fabrication libre
http://highlowtech.org/publications/hannahMSthesis.pdf (anglais)
David Mellis
http://web.media.mit.edu/~mellis/cellphone/
Little Bits
http://littlebits.cc/projects
Scratch
http://scratch.mit.edu/starter_projects/