Modifications pour le document Documenter l’aide en ligne

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

Depuis la version 66.1
modifié par Doriane Bautista
sur 2025/09/11 16:42
Commentaire de modification : Il n'y a aucun commentaire pour cette version
À la version 71.1
modifié par Doriane Bautista
sur 2025/09/17 16:01
Commentaire de modification : Il n'y a aucun commentaire pour cette version

Résumé

Détails

Propriétés de la Page
Contenu
... ... @@ -33,30 +33,6 @@
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 -
60 60  = Identifier le nom interne du champ ou du bloc =
61 61  
62 62  Pour retrouver le fichier d’aide correspondant, vous devez d’abord identifier le nom interne du champ ou du bloc de champs. Pour cela :
... ... @@ -121,8 +121,8 @@
121 121  
122 122  **Présentation et clarté**
123 123  
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.
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.
126 126  * Employez le vocabulaire métier partagé : utilisez les termes définis dans la charte de saisie de votre institution.
127 127  
128 128  **Contenu et cohérence**
... ... @@ -168,7 +168,8 @@
168 168  (((
169 169  **Bonnes pratiques : **
170 170  
171 -* 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
147 +* 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.
148 +* Mettez à jour régulièrement : adaptez vos contenus lorsque vos procédures internes ou règles métier évoluent.
172 172  )))
173 173  
174 174  >(% class="small" %)L’exemple ci-dessous illustre le champ **Numéro d’inventaire** avec une aide en ligne enrichie :
... ... @@ -228,7 +228,7 @@
228 228  
229 229  **Résultat :** l’aide en ligne personnalisée disparaît et l’aide générique du wiki réapparaît automatiquement pour ce champ ou ce bloc.
230 230  
231 -[[//Repérage nom interne du champ - survol d'un champ//>>image:1757599364051-795.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
208 +[[//Repérage nom interne du champ - une infobulle apparait avec le survol du champ//>>image:1757599364051-795.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
232 232  
233 233  
234 234  [[//Choix de **la source** et de la** table**//>>image:1757599467798-396.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]