Documenter
Étapes clés pour la documentation d'un projet
sources : PING en septembre 2014 - http://fablabo.net
Les étapes clés pour la documentation d'un projet
Pourquoi documenter
- pour s'en souvenir et gagner du temps
- pour ne pas refaire les mêmes erreurs
- pour partager du savoir (culture libre)
- parce que j'ai profité de la documentation d'autres personnes
- pour partager les bons plans
- pour avoir des retours, des avis, de l'aide
Quoi documenter ?
Même le travail le plus simple peut être intéressant à documenter, ne serait-ce que pour apprendre à
documenter, et partager des astuces.
Par exemple, un projet, un atelier pédagogique, une page ressource sur une machine, un logiciel, une
technique, un aspect culturel, ou ce qu'on veut.
Comment documenter ?
# Bien : expliquer ses idées
Présenter ses idées à l'oral et sur une feuille de papier permet de les clarifier pour soi-même, et facilite la
communication du projet auprès d'autres personnes susceptibles de vous aider.
# Mieux : tenir un journal de bord
Le journal de bord permet de se souvenir des étapes de recherches, en décrivant de façon minimale les
essais, les erreurs. Prendre des photos régulièrement aide aussi à conserver des traces du processus de
création.
# Encore mieux : finaliser la documentation
Quand le projet ou une partie du projet aboutissent, affiner la documentation et la rendre lisible permet
d'en créer une ressource utile à tous les niveaux de lecture, du débutant à la personne expérimentée.
Les systèmes de Wiki
Votre atelier utilise certainement un système de Wiki pour documenter vos travaux. Il existe plusieurs gestionnaires de contenu (CMS) sous forme de Wiki. On peut citer les plus célèbres :
- DokuWiki (qui fonctionne sans base SQL)
- MediaWiki (utilisé par wikipedia).
- LABSud utilise BOOKSTACK
Ces systèmes permettent aux contributeurs d’éditer aisément les pages ressources concernant les projets qu'ils souhaitent partager. L'objectif est de pouvoir retrouver des projets par types (matériaux utilisés, machines, logiciels). Dans ce but, nous essayons de concevoir des ontologies, autrement dit de pouvoir classer par propriétés ces diverses ressources afin d'améliorer la recherche de contenus par les internautes.
Plus d'informations :
http://fr.wikipedia.org/wiki/Liste_de_logiciels_wiki
Les licences
Il existe plusieurs types de licences pour partager et protéger vos documentations de projets.
On peut citer les Creative Commons et la licence GFDL.
Plus d'informations :
http://fr.wikipedia.org/wiki/Licence_de_documentation_libre_GNU
http://creativecommons.fr
http://fablabo.net/wiki/Aide:Licences
Pour info : Adafruit / Sparkfun / Arduino utilise une licence CC-BY-SA pour le matériel et la licence MIT pour le logiciel.