Modifications pour le document Documenter l’aide en ligne

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

Depuis la version 63.1
modifié par Doriane Bautista
sur 2025/09/11 16:36
Commentaire de modification : Il n'y a aucun commentaire pour cette version
À 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

Résumé

Détails

Propriétés de la Page
Contenu
... ... @@ -37,27 +37,19 @@
37 37  (((
38 38  **Bonnes pratiques : **
39 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.
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.
58 58  )))
59 59  
60 -= Identifier le nom interne du champ ou du bloc =
52 += 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 :
63 63  
... ... @@ -134,22 +134,14 @@
134 134  (((
135 135  **Bonnes pratiques : **
136 136  
137 -**Présentation et clarté**
138 -
139 -* Uniformisez la présentation : adoptez une structure homogène (définition, usage, remarques).
140 -* Soyez clairs et concis : rédigez des explications courtes et directement utiles.
141 -* Employez le vocabulaire métier partagé : utilisez les termes définis dans la charte de saisie de votre institution.
142 -
143 -**Contenu et cohérence**
144 -
145 -* Précisez le contexte : indiquez si le champ ou bloc est lié à un processus particulier (inventaire, récolement, prêt, dépôt, restauration).
146 -* Ajoutez des exemples concrets : illustrez les valeurs attendues pour éviter toute ambiguïté.
147 -* Limitez les redondances : n’intégrez que ce qui est pertinent, sans recopier inutilement l’aide du wiki.
148 -* Documentez aussi les blocs de champs : expliquez leur rôle global en plus des champs qu’ils contiennent.
149 -
150 -**Suivi et maintenance**
151 -
152 -* 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
129 +* **Uniformisez la présentation** : adoptez une structure homogène (définition, usage, remarques).
130 +* **Soyez clairs et concis** : rédigez des explications courtes et directement utiles.
131 +* **Employez le vocabulaire métier partagé** : utilisez les termes définis dans la charte de saisie de votre institution.
132 +* **Précisez le contexte** : indiquez si le champ ou bloc est lié à un processus particulier (inventaire, récolement, prêt, dépôt, restauration).
133 +* **Ajoutez des exemples concrets** : illustrez les valeurs attendues pour éviter toute ambiguïté.
134 +* **Limitez les redondances** : n’intégrez que ce qui est pertinent, sans recopier inutilement l’aide du wiki.
135 +* **Documentez aussi les blocs de champs** : expliquez leur rôle global en plus des champs qu’ils contiennent.
136 +* **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.
153 153  )))
154 154  
155 155  >(% class="small" %)L’exemple ci-dessous illustre le champ **Numéro d’inventaire** avec une aide en ligne enrichie :
... ... @@ -173,7 +173,7 @@
173 173  (% class="wikigeneratedid" id="H200B200B200B200B200B200B200B200B200B200B200B200B200B200B" %)
174 174  ​​​​​​​​​​​​​​
175 175  
176 -[[//Sauvegarder l'aide en ligne//>>image:1757597668258-471.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
160 +[[//Sauvegarde de l'aide en ligne//>>image:1757597668258-471.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
177 177  
178 178  
179 179  = Contrôler le rendu dans Flora =
... ... @@ -209,7 +209,7 @@
209 209  
210 210  **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.
211 211  
212 -[[//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"]]
196 +[[//Repérage nom interne du champ - survol//>>image:1757599364051-795.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
213 213  
214 214  
215 215  [[//Choix de **la source** et de la** table**//>>image:1757599467798-396.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]