L'outil concret pour documenter au fil de l'eau
Tenir un journal de bord
Mettre en place un journal de bord simple pour noter, à chaque séance, ce qui a été fait, décidé, et ce qu'il reste à faire.
Pré-requis :
Logiciels :
Machines/Outils :
C’est la mise en pratique concrète de Documenter au fil de l’eau et de Communiquer en équipe : un seul fichier, mis à jour à chaque séance de travail ou point de synchro, qui devient la mémoire écrite du projet.
Créez docs/journal.md (à côté de docs/objectifs.md et docs/etudes.md déjà présents dans le template). Ajoutez-le au menu du site en lui donnant un front matter comme les autres pages du template (layout: default, nav_order, title).
Chaque entrée répond à trois questions, en quelques lignes : ce qui a été fait, pourquoi (les décisions prises), ce qu’il reste à faire.
## 12/03
**Fait** : Remplacé le servomoteur par un moteur pas à pas + driver
A4988.
**Pourquoi** : le servo décroche au-delà de 200 g, mesuré au
dynamomètre.
**Reste à faire** : réécrire le code de contrôle moteur, commander un
driver de rechange (livraison 3 jours).
5 à 10 minutes en fin de séance suffisent. Une entrée courte et systématique vaut mieux qu’une entrée détaillée écrite une fois par mois.
| Symptôme | Cause probable | Solution |
|---|---|---|
| Le journal s’arrête après 2 semaines | Personne n’est explicitement chargé de le tenir à jour | Décidez d’un tour de rôle, ou d’un rappel systématique en fin de réunion |
| Les entrées sont toutes vagues (“on a avancé”) | Pas de gabarit suivi | Reprenez le format à 3 questions ci-dessus, systématiquement |
| Trop long à relire en fin de projet | Entrées jamais synthétisées | Voir la passe de synthèse finale dans Documenter au fil de l’eau |
Créez docs/journal.md maintenant et ajoutez une première entrée pour ce
que vous avez fait aujourd’hui, même bref.