Aide:Documenter : Différence entre versions

Version du 9 février 2017 à 10:41

La maquette du depliant tiré de cette page Media:DepliantVraimentLibre.svg

après 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

Retrouvez ci-dessous les bonnes pratiques pour documenter :

Pourquoi documenter?

les bonnes raisons et motivations :

• pour ne pas oublier après mes vacances
• cette information manquait
• 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
• parce 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?

Même le travail le plus simple peut être intéressant à documenter, ne serait-ce que pour apprendre à bien documenter.

Quand c'est utile à soi et 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 à 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

Affiche Licence

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

Liens Projets/présentations