Tenir un journal de bord

L'outil concret pour documenter au fil de l'eau

Tenir un journal de bord

Tenir un journal de bord personnel dans le template du projet, une page par séance de travail, pour noter ce qui a été fait, décidé, et ce qu'il reste à faire.

Durée :
Difficulté :

Pré-requis :

Logiciels :

Machines/Outils :

Documentation réalisée à 60% 60
Créée par :  Adrien Bracq

À quoi sert ce tutoriel

C’est la mise en pratique concrète de Documenter au fil de l’eau et de Communiquer en équipe : une page par séance de travail, qui devient la mémoire écrite du projet.

Comment le template organise le journal

Chaque membre de l’équipe tient son propre journal : une page par séance, que la séance ait lieu pendant les créneaux prévus ou en dehors. Le dossier docs/journal/ du template est organisé ainsi :

docs/journal/
├── index.md              page « Journal de bord » (consignes)
├── _modele-seance.md     modèle à copier (invisible sur le site)
├── etudiant-1/
│   ├── index.md          page de l'étudiant 1
│   └── 2026-09-23.md     une séance
└── etudiant-2/
    └── index.md          page de l'étudiant 2

Le menu du site affiche « Journal de bord », puis un sous-menu par étudiant, puis une page par séance dans l’ordre chronologique.

Préparer son journal (une seule fois)

Étape 1 : Renommer votre dossier (facultatif)

Dans docs/journal/, vous pouvez renommer le dossier etudiant-1 avec votre prénom (par exemple alice), sans accent ni espace : c’est plus clair pour retrouver vos fichiers. Si votre équipe compte plus de deux personnes, dupliquez un dossier étudiant pour chaque membre supplémentaire.

Étape 2 : Mettre votre nom sur votre page

Ouvrez docs/journal/alice/index.md et remplacez « Étudiant 1 » par votre prénom et votre nom dans le titre :

---
layout: default
title: Alice Martin
parent: Journal de bord
has_children: true
---

Supprimez ensuite le bloc À modifier qui suit l’en-tête.

  Le titre est le lien entre votre page et vos séances

Le champ parent de chacune de vos séances doit être exactement le title de cette page (ici Alice Martin). S’il diffère d’une lettre, vos séances n’apparaissent pas sous votre nom dans le menu.

Ajouter une séance (à chaque séance)

Étape 1 : Copier le modèle

Copiez docs/journal/_modele-seance.md dans votre dossier et renommez la copie avec la date du jour au format AAAA-MM-JJ (par exemple 2026-09-23.md). Le nom du fichier commence par la date : les séances s’affichent ainsi dans l’ordre chronologique.

Étape 2 : Remplir l'en-tête

Modifiez l’en-tête de la copie :

---
layout: default
title: "2026-09-23 : découpe laser du boîtier"
parent: Alice Martin
grand_parent: Journal de bord
---
  • title : la date, puis le sujet de la séance.
  • parent : le titre de votre page étudiant, exactement.

Supprimez aussi le commentaire HTML (<!-- ... -->) en haut du fichier : c’est une consigne du modèle.

Étape 3 : Remplir les trois rubriques

Renseignez le type de séance (planifiée ou hors créneau), sa durée, puis les trois rubriques : Fait, Pourquoi, Reste à faire. Voir le format ci-dessous.

Le format d’une séance

Chaque page répond à trois questions, en quelques lignes : ce qui a été fait, pourquoi (les décisions prises), ce qu’il reste à faire. Voici la page d’exemple du template :

Copier l'exemple de séance (Markdown) 
# 2026-09-23 : découpe laser du boîtier

**Séance :** planifiée · **Durée :** 2 h

## Fait

Découpe du boîtier en contreplaqué 3 mm. Premier assemblage à blanc.

## Pourquoi

Les encoches étaient trop serrées : ajout d'une compensation de 0,1 mm dans le
fichier de découpe (réglage mesuré sur une chute).

## Reste à faire

- Redécouper la face avant avec la compensation.
- Demander à l'équipe électronique l'emplacement définitif du connecteur USB.
  Court, mais régulier

5 à 10 minutes en fin de séance suffisent. Une page courte et systématique vaut mieux qu’une page détaillée écrite une fois par mois. « Pourquoi » est la rubrique la plus précieuse : c’est elle qu’une prochaine équipe cherchera.

Quand écrire une séance

  • À la fin de chaque séance de travail, même courte, y compris en dehors des créneaux prévus.
  • À la fin de chaque point de synchro d’équipe, avec les décisions prises (voir Communiquer en équipe).
  • Dès qu’un choix technique important est fait (en plus, si le choix est significatif, du format détaillé vu dans Tracer ses choix techniques).

Résolution de problèmes

Symptôme Cause probable Solution
Mes séances n’apparaissent pas sous mon nom dans le menu Le parent d’une séance ne correspond pas exactement au title de votre page Recopiez le titre de votre page étudiant dans le parent de chaque séance
Les séances ne sont pas dans l’ordre Le titre ne commence pas par la date AAAA-MM-JJ Renommez le titre et le fichier avec la date en tête
Le modèle _modele-seance.md n’apparaît pas dans le menu C’est normal : son nom commence par « _ », il est invisible sur le site Copiez-le, ne le modifiez pas
Le journal s’arrête après 2 semaines Personne ne s’en occupe explicitement Décidez d’un rappel systématique en fin de réunion
Trop long à relire en fin de projet Séances jamais synthétisées Voir la passe de synthèse finale dans Documenter au fil de l’eau

Exercice

Préparez votre page étudiant (dossier et titre), supprimez la séance d’exemple 2026-09-23.md, puis créez votre première séance avec ce que vous avez fait aujourd’hui, même bref.

Contents