Modifications pour le document Documenter l’aide en ligne

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

Depuis la version 22.1
modifié par Doriane Bautista
sur 2025/09/11 14:21
Commentaire de modification : Il n'y a aucun commentaire pour cette version
À la version 25.1
modifié par Doriane Bautista
sur 2025/09/11 14:26
Commentaire de modification : Il n'y a aucun commentaire pour cette version

Résumé

Détails

Propriétés de la Page
Contenu
... ... @@ -31,7 +31,22 @@
31 31  )))
32 32  )))
33 33  
34 +(% class="box successmessage" %)
35 +(((
36 +**Bonnes pratiques : **
34 34  
38 +* **Uniformisez la présentation** : adoptez une structure homogène pour toutes vos aides (ex. : définition, usage, remarques).
39 +* **Soyez clairs et concis** : rédigez des explications courtes et immédiatement compréhensibles.
40 +* **Employez le vocabulaire métier partagé** : utilisez les termes définis dans la charte de saisie de votre institution.
41 +* **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).
42 +* **Ajoutez des exemples concrets** : illustrez les valeurs attendues afin d’éviter les ambiguïtés.
43 +* **Limitez les redondances** : ne recopiez pas intégralement l’aide du wiki, mais complétez-la ou adaptez-la selon vos besoins.
44 +* **Documentez aussi les blocs de champs** : expliquez leur rôle global en plus des champs qu’ils contiennent.
45 +* **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.
46 +* **Vérifiez l’accessibilité** : testez l’ouverture des pop-up d’aide dans les navigateurs utilisés.
47 +* **Mettez à jour régulièrement** : adaptez vos contenus lorsque vos procédures internes ou règles métier évoluent.
48 +)))
49 +
35 35  == Comportement par défaut ==
36 36  
37 37  Lors d'un appel au menu "Afficher aide" Flora recherche d'abord le fichier html correspondant sur votre applicatif. Si cette recherche est infructueuse, Flora interroge le wiki dans un second temps.