En résumé
Le wiki est la documentation de l’équipe, rangée en arborescence de pages écrites en Markdown. Il sert à consigner ce qui ne tient ni dans le code ni dans les données : conventions, protocoles, dictionnaires de variables, comptes rendus. Des modèles évitent la page blanche, et une page peut être marquée vérifiée pour distinguer ce qui fait foi.
À quoi sert un wiki dans Linkr
Un entrepôt de données s’accompagne toujours d’un savoir qui ne s’y trouve pas. Pourquoi telle variable est inexploitable avant 2019. Comment le service définit une réadmission. Quelle procédure suivre avant de publier.
Ce savoir circule d’ordinaire par oral, par courriel, ou dans un document que personne ne retrouve. Le wiki lui donne un endroit, à côté des données qu’il décrit plutôt que dans un outil séparé.
L’arborescence
Les pages s’organisent en arbre : une page peut contenir des sous-pages, qui peuvent elles-mêmes en contenir. C’est ce qui permet de garder un wiki lisible quand il grandit — un chapitre par grand sujet, le détail en dessous.
Chaque page reçoit une icône, qui aide à repérer d’un coup d’œil la nature d’une section dans l’arbre. Un clic droit sur une page propose Nouvelle sous-page, Renommer, Changer l’icône et Supprimer la page.
Dictionnaire des variables
Une ligne par variable exploitée dans les études du service.
| Variable | Table source | Unité | Remarque |
|---|---|---|---|
| Lactate | measurement | mmol/L | Fiable depuis 2019 |
| FiO₂ | measurement | % | Saisie horaire |
| Noradrénaline | drug_exposure | µg/kg/min | — |
Note
Toute nouvelle variable passe par une revue avant d'être ajoutée ici.
Chercher plutôt que naviguer
Au-delà de quelques dizaines de pages, on ne parcourt plus l’arbre : on cherche. Ctrl + K ouvre la recherche depuis n’importe où dans le wiki.
Les modèles
La fenêtre Nouvelle page propose un modèle, qui pose d’emblée une structure adaptée au type de document :
- Procédure (SOP) — une marche à suivre, étape par étape.
- Dictionnaire de données — la description des variables d’une source.
- Onboarding — ce qu’un nouvel arrivant doit lire en premier.
- Notes de réunion, FAQ, Protocole d’étude, Article — ou une page vide si rien ne convient.
Nouvelle page
- ##Purpose
- ##Scope
- ##Responsibilities
- ##Procedure
- ##Revision history
L’intérêt n’est pas de gagner quelques minutes de mise en forme, mais d’obtenir des documents comparables : deux procédures écrites à six mois d’intervalle se ressemblent, donc se lisent plus vite.
Écrire une page
Modifier ouvre l’éditeur : le Markdown à gauche, le rendu à droite. Au-delà du texte courant, la barre d’outils insère quelques blocs utiles :
- des encadrés — note, conseil, avertissement — et des blocs repliables pour ranger un détail sans l’effacer ;
- une table des matières générée à partir des titres (
[[toc]]) ; - un lien vers une autre page du wiki par son nom (
[[Nom de la page]]) ; - des diagrammes Mermaid — organigramme, séquence, Gantt.
Les pièces jointes — une image, un PDF — s’ajoutent depuis le bouton du même nom, en haut de la page.
Chaque page affiche la date de sa dernière mise à jour — souvent la première chose à regarder avant de faire confiance à une documentation.
Les pages vérifiées
Une page de wiki vieillit. Celui qui la lit ne sait pas toujours si elle décrit encore la réalité.
Une page peut donc être marquée vérifiée — bouton Vérifier, en haut de la page : quelqu’un l’a relue et en confirme le contenu. C’est une distinction utile entre une note écrite au fil de l’eau et une page qui fait référence.
Un usage typique
Le dictionnaire des variables de l’entrepôt est marqué vérifié après chaque revue annuelle. Les notes de réunion, elles, ne le sont jamais — elles datent leur propre contenu.
Pour aller plus loin
- Vue d’ensemble — ce que l’espace de travail regroupe autour du wiki.
- Catalogue de données — pour documenter les variables elles-mêmes, plutôt que les procédures.