Écrire dans cette aide
L'aide que vous lisez est du markdown du dépôt : apps/ehr-lab/docs. Elle est lisible sur
GitHub, révisable en revue de code, et embarquée dans l'application par un générateur. Il n'y a
pas de seconde version — la source fait foi.
Où poser une page
L'arborescence croise PARA et Diátaxis :
apps/ehr-lab/docs/
areas/using/ ← se servir du banc (tutorials, how-to, reference, explanation)
areas/configuring/ ← le brancher, l'alimenter
resources/ ← le pourquoi, les références durables
Le choix Diátaxis n'est pas décoratif : un tutoriel fait faire un parcours complet, un how-to répond à un besoin précis, une référence se consulte, une explication donne le raisonnement. Mélanger les quatre dans une page est la façon la plus sûre de n'être lu par personne.
Le front-matter
---
title: Trancher les problèmes à la sortie
order: 40 # ordre dans son groupe
summary: Une phrase — affichée dans les listes et l'aide contextuelle.
context: problems, encounters # écrans depuis lesquels la page est proposée
expose: false # facultatif : garder la page hors de l'application
---
L'aide contextuelle
context: est la clé : c'est la page qui déclare où elle aide, pas l'écran qui liste ses
docs. Ajouter une page contextuelle ne touche donc aucun composant.
Les contextes existants : home, patients, problems, prescriptions, encounters,
labs, inbox, audit. Un écran affiche un bouton d'aide qui ouvre les pages déclarées pour
son contexte.
Régénérer
pnpm --filter ehr-lab docs:gen
Lancé automatiquement avant dev et build. Le résultat (src/lib/help-content.ts) est
versionné pour que l'image se construise sans dépendre de l'arbre de doc.
Les liens
Écrivez des liens relatifs entre fichiers .md : la source reste navigable sur GitHub, et
le générateur les réécrit en URL /help/… dans la copie embarquée. Un lien vers une page non
exposée est aplati en texte plutôt que de faire un 404.