Aide:Documenter
Pourquoi documenter?
les bonnes raisons et motivations :
- pour ne pas oublier après mes vacances
- cette information manquai
- 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 à soit/ 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
Fiche-idée papier ou scannée ?
télécharger la fiche en svg,pdf et png
Pendant : faire un journal de bord
Pas à pas, l'expérience avec les essais erreurs.
Le cahier de laboratoire ou journal de bord permet de se souvenir des étapes de recherches, de garder des traces pour soit-même et éventuellement d'autres personnes qui travailleront sur ce sujet.
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)
//medias supports//
Bonnes Pratiques/ Références/Mise en page
Affiche Licence
Media:Licences.pdf
Media:Licences pfc.svg
Media:Typos.zip