Modifications pour le document Documenter l’aide en ligne

Modifié par Doriane Bautista le 2025/09/17 16:01

Depuis la version 60.1
modifié par Doriane Bautista
sur 2025/09/11 16:30
Commentaire de modification : Il n'y a aucun commentaire pour cette version
À la version 61.1
modifié par Doriane Bautista
sur 2025/09/11 16:33
Commentaire de modification : Il n'y a aucun commentaire pour cette version

Résumé

Détails

Propriétés de la Page
Contenu
... ... @@ -37,19 +37,27 @@
37 37  (((
38 38  **Bonnes pratiques : **
39 39  
40 -* **Uniformisez la présentation** : adoptez une structure homogène pour toutes vos aides (ex. : définition, usage, remarques).
41 -* **Soyez clairs et concis** : rédigez des explications courtes et immédiatement compréhensibles.
42 -* **Employez le vocabulaire métier partagé** : utilisez les termes définis dans la charte de saisie de votre institution.
43 -* **Précisez le contexte d’utilisation** : indiquez si le champ ou le bloc est lié à un processus particulier (inventaire, récolement, prêt, dépôt, restauration).
44 -* **Ajoutez des exemples concrets** : illustrez les valeurs attendues afin d’éviter les ambiguïtés.
45 -* **Limitez les redondances** : ne recopiez pas intégralement l’aide du wiki, mais complétez-la ou adaptez-la selon vos besoins.
46 -* **Documentez aussi les blocs de champs** : expliquez leur rôle global en plus des champs qu’ils contiennent.
47 -* **Conservez une mémoire interne** : gardez une copie (Word, tableur, etc.) de vos aides personnalisées pour en assurer le suivi et la maintenance lors des mises à jour Flora.
48 -* **Vérifiez l’accessibilité** : testez l’ouverture des pop-up d’aide dans les navigateurs utilisés.
49 -* **Mettez à jour régulièrement** : adaptez vos contenus lorsque vos procédures internes ou règles métier évoluent.
40 +**Présentation et lisibilité**
41 +
42 +* Uniformisez la présentation : adoptez une structure homogène pour toutes vos aides (ex. : définition, usage, remarques).
43 +* Soyez clairs et concis : rédigez des explications courtes et immédiatement compréhensibles.
44 +* Employez le vocabulaire métier partagé : utilisez les termes définis dans la charte de saisie de votre institution.
45 +* Ajoutez des exemples concrets : illustrez les valeurs attendues afin d’éviter toute ambiguïté.
46 +
47 +**Contenu et cohérence métier**
48 +
49 +* Précisez le contexte d’utilisation : indiquez si le champ ou le bloc est lié à un processus particulier (inventaire, récolement, prêt, dépôt, restauration).
50 +* Limitez les redondances : n’intégrez que ce qui est pertinent, sans recopier inutilement l’aide du wiki.
51 +* Documentez aussi les blocs de champs : expliquez leur rôle global en plus des champs qu’ils contiennent.
52 +
53 +**Suivi et maintenance**
54 +
55 +* Conservez une mémoire interne : gardez une copie (Word, tableur, etc.) de vos aides personnalisées pour en assurer le suivi et la maintenance lors des mises à jour Flora.
56 +* Vérifiez l’accessibilité : testez l’ouverture des pop-up d’aide dans les navigateurs utilisés.
57 +* Mettez à jour régulièrement : adaptez vos contenus lorsque vos procédures internes ou règles métier évoluent.
50 50  )))
51 51  
52 -= Identifier le nom interne du champ ou du bloc =
60 += Identifier le nom interne du champ ou du bloc =
53 53  
54 54  Pour retrouver le fichier d’aide correspondant, vous devez d’abord identifier le nom interne du champ ou du bloc de champs. Pour cela :
55 55