Modifications pour le document Documenter l’aide en ligne

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

Depuis la version 70.1
modifié par Doriane Bautista
sur 2025/09/17 16:00
Commentaire de modification : Il n'y a aucun commentaire pour cette version
À la version 68.1
modifié par Doriane Bautista
sur 2025/09/11 16:46
Commentaire de modification : Il n'y a aucun commentaire pour cette version

Résumé

Détails

Propriétés de la Page
Contenu
... ... @@ -33,6 +33,30 @@
33 33  )))
34 34  )))
35 35  
36 +(% class="box successmessage" %)
37 +(((
38 +**Bonnes pratiques : **
39 +
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.
58 +)))
59 +
36 36  = Identifier le nom interne du champ ou du bloc =
37 37  
38 38  Pour retrouver le fichier d’aide correspondant, vous devez d’abord identifier le nom interne du champ ou du bloc de champs. Pour cela :
... ... @@ -97,10 +97,9 @@
97 97  
98 98  **Présentation et clarté**
99 99  
100 -* Uniformisez la présentation : adoptez une structure homogène pour toutes vos aides (ex. : définition, usage, remarques).
101 -* Soyez clairs et concis : rédigez des explications courtes et immédiatement compréhensibles.
124 +* Uniformisez la présentation : adoptez une structure homogène (définition, usage, remarques).
125 +* Soyez clairs et concis : rédigez des explications courtes et directement utiles.
102 102  * Employez le vocabulaire métier partagé : utilisez les termes définis dans la charte de saisie de votre institution.
103 -* Ajoutez des exemples concrets : illustrez les valeurs attendues afin d’éviter toute ambiguïté.
104 104  
105 105  **Contenu et cohérence**
106 106  
... ... @@ -146,7 +146,6 @@
146 146  **Bonnes pratiques : **
147 147  
148 148  * 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.
149 -* Mettez à jour régulièrement : adaptez vos contenus lorsque vos procédures internes ou règles métier évoluent.
150 150  )))
151 151  
152 152  >(% class="small" %)L’exemple ci-dessous illustre le champ **Numéro d’inventaire** avec une aide en ligne enrichie :