Documenter un projet

pour le partager sur un wiki entre pairs/collègues.

Les cas varient: il peut s'agir de documenter l'ensemble d'un projet complexe, ou de fournir le déroulé d'une animation avec ses supports pédagogiques, ou un tutoriel précis sur comment faire concrètement telle ou telle chose.

La motivation première peut-être très personnelle: documenter pour soi-même parce qu'on en aura besoin plus tard. Mais le faire sur un support collectif, partagé, peut servir à d'autres, dont certains peuvent également contribuer à compléter et améliorer le contenu (dans le fond, dans la forme, dans la mise à jour).

Il s'agit surtout d'être efficace, utile et compréhensible (y compris lorsque l'on documente pour "soi-même dans le futur". Voir Donner à voir, donner à comprendre, donner à faire (page Wiki).

Exemples

Sur ce wiki:

une fiche pratique, explicative, sur un seul sujet, qui permet de répondre rapidement à une question qui revient régulièrement >> Wordpress ou Wordpress.com ?
une liste de ressources avec des liens vers leurs sites/pages internet >> Médiation numérique: cartes et jeux sur table
5 fiches de présentations et explications, regroupées en 1 page, à destination des animateurs/éducateurs Jeunesse et des Promeneurs du Net >> Fiches réseaux sociaux
une fiche animation complète, comprenant public cible, objectifs pédagogiques, déroulé, supports... >> Stéphanoises remarquables
un tutoriel >> Fabriquer des pochoirs à partir d'une photo à la découpeuse laser
un retour d'expérience, partage de ressources, rédigé à la première personne >> Ressources pour des animations sur le thème sur le thème "Son et musique"
sur 4 pages organisées en onglets, la documentation d'une animation et les 3 tutoriels des logiciels utilisés >> Création de Jeux Vidéos
la documentation évolutive d'un projet complexe, en cours, permettant de comprendre et de suivre le projet en question >> A l'assaut de la Cité interdite

Version simple

Introduction > Donne le contexte au lecteur qui arrive sur la page.
Astuce de rédaction:Si on ne peut pas copier-coller le premier paragraphe dans un statut sur un réseau social, une newsletter... en ajoutant "Plus d'infos sur la page..." c'est que l'intro n'est pas bonne et ne décrit pas bien le contenu de la page.

Fiche projet

Projet :

Année :

Quoi ?

Pourquoi ?
Le contexte

Pourquoi ?
Les objectifs pédagogiques

Qualitatif
Quantitatif

Pourquoi ?

Compétences psychosociales

Pour qui ?
Le public

Typologie
Quantitatif

Par qui ?
Les acteurs

Avec qui ?
Les partenaires

Où ?

Lieux
Fixes / Itinérants

Quand ?

Début
Périodicité

Comment ?
La méthodologie

Qualitatif
Quantitatif

Combien ?
Les postes de dépenses

Évaluation

Quoi ?
Comment ?

Version (très) détaillée

Préconisée sur le wiki MoviLab:
1 Présentation du projet

1.1 Articles (revue de presse)
1.2 Résumé
1.3 Pourquoi se lancer dans ce projet ?
1.4 A savoir avant de se lancer

2 Comment faire ?

2.1 A faire avant
2.2 A faire pendant
2.3 A faire après

3 Mieux comprendre le projet

3.1 L’origine du projet et son histoire
3.2 Les détournements, étapes marquantes et évolutions du projet initial
3.3 Les freins, les problèmes non résolus, les défis
3.4 Les éléments facilitateurs
3.5 Conditions de réutilisation
3.6 Exemples concrets

4 Des ressources pour aller plus loin

4.1 Pour ne pas rester seul
4.2 Quelques ressources pratiques
4.3 Communication du projet
4.4 Retours d’expérience de ceux qui ont testé cette recette
4.5 Passer à l’échelle ?
4.6 Pages (wiki) liées

Pages liées

(page Wiki) Qu'est ce qu'un WIKI?
(page Wiki) Communication / Information
(page Wiki) Donner à voir, donner à comprendre, donner à faire
(page Wiki) Stratégie de communication digitale

Aide Communication Ressources Wiki