R&D LAB Méthode En service Conçu pour notre propre équipe

iiterate Handbook

Un sujet devenu manuel de formation bilingue avec attestation de suivi

Un sujet, un manuel : des leçons sourcées, un contrôle de compréhension et une attestation, en allemand et en anglais, suivies jusqu'au bout.

  • 2langues dans chaque leçon, commutables en direct
  • 3volets dans le lecteur : navigation, leçon, espace de travail
  • 5outils par leçon : notes, commentaires, liste, liens, signets
  • 1sujet par manuel
Page d'accueil de la bibliothèque de manuels : le titre One topic. One handbook. Tracked to completion., en dessous une série de cartes de chapitres, chacune avec numéro, titre, nombre de modules et de leçons et la mention Open ; en haut à droite, les commutateurs anglais, allemand et mode sombre

Page d'accueil de la bibliothèque avec une série de cinq chapitres sur la sécurité et la confiance, rédigés pour notre propre équipe. Leur contenu est interne et n'est pas décrit ici.

Pourquoi c'est publié

Nous vendons de l'IA et de la communication technique. Le manuel en est la preuve sur une tâche discrète : transformer une expertise dispersée en un matériel structuré, qui cite ses sources et dont le suivi peut être démontré. Le modèle de langage n'écrit pas dans le vide, il remplit une structure fixe où une source manquante apparaît comme une lacune. Si vous voulez structurer l'intégration, la formation interne ou la sensibilisation à la protection des données et à la sécurité de l'information, vous voyez ici comment nous l'avons construit pour notre propre équipe.

L'expertise réside dans les têtes, dans des jeux de diapositives et dans des pages wiki que personne ne peut jamais terminer. Une formation est un rendez-vous ; il en reste une liste de présence et les questions posées dans la salle. iiterate Handbook transforme un sujet complexe en manuel de formation interactif en allemand et en anglais. Tout commence par une mission et un cadrage : pour qui, à quelle profondeur, en quelles langues et en s'appuyant sur quelles normes et lois. Viennent ensuite la recherche des sources, des modules dans l'ordre d'apprentissage et des leçons à la structure fixe commune, un glossaire et un graphe de thèmes qui relie les notions récurrentes d'une leçon à l'autre, et un lecteur en trois volets avec notes, commentaires, signets et attestation de suivi. Un modèle de langage aide à rédiger et structurer les leçons ; le modèle de page exige des références dans le texte et une liste de sources, et les questions ouvertes des apprenants sont recueillies pour la révision suivante.

La décision

Une leçon n'est terminée qu'une fois attestée

Une page wiki ne sait pas si elle a été lue, et un jeu de diapositives indique rarement d'où viennent ses affirmations. C'est sans conséquence pour des connaissances générales et devient gênant dès qu'une organisation doit montrer que son équipe connaît une règle. La décision de départ a donc été de construire chaque leçon comme une unité suivie, et non comme une page.

Chaque leçon se termine par un court contrôle de compréhension portant sur son contenu. Ce n'est qu'une fois réussi que la leçon peut être attestée : un nom, la déclaration qu'elle a été lue et comprise, et la date. La barre de progression de l'en-tête compte les leçons attestées, pas les leçons ouvertes, et un bouton en exporte un tableau avec nom, manuel, module, leçon et date.

Là où une erreur a des conséquences, une liste de vérification s'ajoute. Si elle est marquée obligatoire, l'attestation reste bloquée tant que chaque point n'est pas coché. La même rigueur vaut pour les références : le modèle de page prévoit des citations directement dans la section et une liste de sources à la fin. Le modèle de langage remplit cette structure, et une section sans référence se remarque à la lecture comme une lacune au lieu de se perdre dans le texte.

Ce que ce n'est pas en fait partie. L'attestation est une déclaration personnelle avec un nom saisi, pas un contrôle derrière une connexion, et le contrôle est un court questionnaire à choix, pas un examen. Notes, progression et attestations résident dans le navigateur jusqu'à ce que quelqu'un les réécrive dans les fichiers du manuel. Il n'existe pas de gestion des utilisateurs pour de nombreux apprenants.

Personne ne peut terminer une page wiki. Une leçon, si.

Du sujet au manuel

Six étapes, et la rédaction ne commence qu'à la cinquième

  1. 01 Cadrage On consigne à qui s'adresse le manuel, quels rôles existent, quelle profondeur viser, en quelles langues, quels sujets connexes en font partie, où des listes obligatoires sont nécessaires et quelles normes et lois sont citées. Il en résulte une proposition de modules et de leçons, validée avant toute rédaction.
  2. 02 Mission Une courte mission décrit ce que les apprenants doivent savoir faire à la fin, pourquoi cela compte pour eux, d'où ils partent et à quoi l'on reconnaît que l'objectif est atteint. Chaque leçon s'y rapporte.
  3. 03 Sources La recherche aboutit dans un tableau de sources avec niveau de confiance et usage. Les vidéos peuvent être transcrites à partir de leurs sous-titres, et les documents fournis approfondissent les modules correspondants.
  4. 04 Structure Les modules suivent l'ordre d'apprentissage, car les suivants s'appuient sur les précédents. Chaque leçon traite exactement un point bien délimité et nomme les thèmes récurrents qu'elle aborde.
  5. 05 Leçons Un modèle de langage rédige chaque leçon selon la structure fixe, allemand et anglais dans le même fichier. La leçon est une page HTML autonome, que l'on peut aussi ouvrir et imprimer hors du lecteur.
  6. 06 Construire Un script lit toutes les leçons, calcule la progression et le graphe de thèmes et génère le lecteur sous forme de fichier unique. La page d'accueil de la bibliothèque est régénérée à chaque fois.

Ce que contient chaque leçon

01 Promesse et pertinence Une phrase sur ce que l'on sait faire après la leçon, et une section expliquant pourquoi cela compte, rattachée à la mission du manuel.
02 Sections d'enseignement référencées Plusieurs sections où chaque affirmation non évidente porte une référence. Des notes en marge les accompagnent avec parcimonie : à gauche ce qu'il faut savoir, à droite ce qu'il faut faire.
03 Exemple détaillé Un exemple concret, complété pour les sujets techniques par des blocs de code, des tableaux de configuration, des comparaisons de code non sécurisé et sécurisé ou des procédures numérotées.
04 Liste de vérification Pour les tâches sensibles, une liste en marge. Si elle est marquée obligatoire, elle bloque l'attestation jusqu'à ce que tout soit coché.
05 Exercice, aide-mémoire, renvois Un exercice, un résumé à consulter et des renvois vers les leçons qui traitent la même notion dans un autre contexte.
06 Sources, contrôle, attestation La liste des sources de la leçon, le contrôle de compréhension et l'attestation avec nom et date, qui compte dans la progression.

Le lecteur en trois volets

Lecteur de manuel : en haut titre, progression et onglets de chapitres ; à gauche la liste des leçons par module avec cases à cocher ; au centre la leçon OWASP Top 10 (Web) avec son objectif et une barre d'outils avec édition, focus, impression, ouverture dans un nouvel onglet et le bouton Attest & complete ; à droite les onglets Notes, Comments, Checklist, Links et Marks avec un champ de notes vide ; en bas Sync to store, Record et couleurs d'accent
Une leçon sur l'OWASP Top 10, un savoir général. La progression indique 0 sur 25, car aucune leçon n'est attestée dans cette capture.

À gauche, les leçons par module, avec une recherche et un second onglet pour le glossaire. La leçon s'affiche au centre, et à droite se trouve l'espace de travail propre à cette leçon : des notes qui s'enregistrent seules, des commentaires que l'on peut ancrer à un passage surligné, une liste personnelle, les sources de la leçon avec vos propres liens, et les signets posés. Un signet n'est créé que si quelqu'un enregistre explicitement un texte surligné.

Le mode focus masque les deux volets latéraux, et l'impression ne produit que la leçon, jamais la navigation. En mode édition, on peut modifier le texte et les notes en marge, surligner des passages et déplacer des notes ; ces modifications intègrent le fichier de la leçon lors de la réécriture. La barre du bas compte les modifications qui ne résident encore que dans le navigateur, deux dans cette capture.

Les notions récurrentes relient les leçons

Chaque leçon nomme les thèmes qu'elle aborde. À la construction, ils forment un graphe de thèmes : un thème est un terme du glossaire ou une notion citée par au moins deux leçons, et il est relié à chaque leçon où il apparaît. Les entrées du glossaire apprennent automatiquement dans quelles leçons elles figurent, même si personne n'y a pensé en rédigeant.

Dans le lecteur, le glossaire se trouve à gauche de la leçon, chaque terme avec une définition dans les deux langues et des renvois vers les leçons qui l'emploient. La vue d'ensemble montre les mêmes liens sous forme de graphe : les thèmes en carrés, les leçons en points de la couleur de leur module, avec filtres, recherche et un clic qui ouvre la leçon.

Cela ne fonctionne que si une même chose porte partout le même nom. Les thèmes d'une série sont donc nommés une fois et réutilisés mot pour mot dans tous les chapitres ; deux noms différents pour la même chose donnent deux thèmes.

Lecteur avec l'onglet Glossary ouvert à gauche : les termes TLS, WAF et Key management, chacun marqué recurs, avec une définition et des renvois vers des leçons ; au centre la leçon OWASP Top 10 (Web)
Le glossaire à côté de la leçon. Chaque terme porte des renvois vers les leçons où il apparaît ; le graphe de la vue d'ensemble n'est pas montré ici.

Ce qui change par rapport à un support de formation

Support de formation habituel

  • Des diapositives sans sources, ou avec une liste finale que personne ne sait rattacher à une affirmation.
  • Une seule langue, ou deux versions qui divergent davantage à chaque modification.
  • Une liste de présence comme preuve, mais rien sur qui a étudié quoi.
  • Des questions posées pendant la séance, perdues une fois la séance terminée.
  • Des corrections qui finissent dans une copie et jamais dans l'original.

Manuel

  • Des références dans la section et une liste de sources par leçon.
  • Allemand et anglais dans le même fichier de leçon, commutables dans le lecteur.
  • Une attestation par leçon avec nom et date, après un contrôle de compréhension, exportable en tableau.
  • Les questions ouvertes par leçon, rassemblées dans une liste pour la révision suivante.
  • Des modifications du texte réécrites dans le fichier de la leçon, et donc valables pour tous.

Bibliothèque

Des séries et des chapitres plutôt que des manuels isolés

Un sujet reste un manuel. Lorsque plusieurs sujets vont ensemble, ils sont reliés comme chapitres ordonnés d'une série, sans que l'un écrase l'autre. Chaque manuel d'une série reçoit sous son en-tête une barre de chapitres qui mène aux autres chapitres, et la page d'accueil de la bibliothèque présente chaque série comme une suite de cartes de chapitres avec couleur, volume et progression, ainsi que les manuels isolés et un court guide interactif.

Qu'un chapitre soit déjà construit ou seulement prévu n'est consigné nulle part comme un statut entretenu. C'est déduit à la construction, selon qu'un lecteur existe ou non pour ce chapitre. Un chapitre prévu apparaît donc comme prévu jusqu'à ce qu'il soit réellement construit, et ne peut passer par erreur pour disponible.

La bibliothèque montrée contient une série en plusieurs parties sur la sécurité et la confiance, rédigée pour notre propre équipe. Cet article n'en montre qu'une leçon, consacrée à un savoir général.

Où cela s'applique

  • Intégration de nouveaux collaborateurs aux méthodes de travail, outils et règles internes.
  • Information des partenaires et prestataires sur les conditions dans lesquelles ils travaillent avec des données ou des systèmes.
  • Sensibilisation à la protection des données et à la sécurité de l'information lorsqu'il faut consigner qui a attesté quelle leçon.
  • Transmission d'un projet logiciel à l'équipe qui l'exploitera, avec des leçons sur son architecture et ses procédures.
  • Supports d'accompagnement d'ateliers qui restent utilisables comme référence après la séance.

Crédits images : toutes les images sont des captures de notre propre application. L'OWASP Top 10 est un projet de l'OWASP Foundation ; la leçon montrée est notre propre support pédagogique à son sujet.

Pourquoi c'est publié

Ce que cela signifie pour votre projet

Plus du laboratoire

Chez vous, le savoir réside-t-il dans des têtes et des diapositives que chaque nouvelle personne doit redemander ? C'est précisément à cela que sert un pilote.

Nous contacter

Grace Hopper

“La phrase la plus nuisible de la langue est : on a toujours fait comme ça.”