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.