Modifications pour le document Documenter l’aide en ligne

Modifié par Joséphine Ducruet le 2026/02/18 16:34

Depuis la version 73.1
modifié par Joséphine Ducruet
sur 2026/02/11 14:47
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
Auteur du document
... ... @@ -1,1 +1,1 @@
1 -XWiki.JDT
1 +XWiki.DBA
Contenu
... ... @@ -1,5 +3,3 @@
1 -**PAGE EN COURS DE REDACTION**
2 -
3 3  (% class="mark small" %)**Version 4.5.54 et ultérieures**
4 4  
5 5  |(% style="width:840px" %)(((
... ... @@ -35,6 +35,30 @@
35 35  )))
36 36  )))
37 37  
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 +
38 38  = Identifier le nom interne du champ ou du bloc =
39 39  
40 40  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,9 +97,14 @@
97 97  (((
98 98  **Bonnes pratiques : **
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.
122 +**Présentation et clarté**
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.
102 102  * Employez le vocabulaire métier partagé : utilisez les termes définis dans la charte de saisie de votre institution.
127 +
128 +**Contenu et cohérence**
129 +
103 103  * Précisez le contexte : indiquez si le champ ou bloc est lié à un processus particulier (inventaire, récolement, prêt, dépôt, restauration).
104 104  * Ajoutez des exemples concrets : illustrez les valeurs attendues pour éviter toute ambiguïté.
105 105  * Limitez les redondances : n’intégrez que ce qui est pertinent, sans recopier inutilement l’aide du wiki.
... ... @@ -142,7 +142,6 @@
142 142  **Bonnes pratiques : **
143 143  
144 144  * 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.
145 -* Mettez à jour régulièrement : adaptez vos contenus lorsque vos procédures internes ou règles métier évoluent.
146 146  )))
147 147  
148 148  >(% class="small" %)L’exemple ci-dessous illustre le champ **Numéro d’inventaire** avec une aide en ligne enrichie :
... ... @@ -164,7 +164,7 @@
164 164  [[//Saisie et mise en forme des données//>>image:1757596818102-351.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
165 165  
166 166  (% class="wikigeneratedid" id="H200B200B200B200B200B200B200B200B200B200B200B200B200B200B" %)
167 -​​​​​​​
193 +​​​​​​​​​​​​​​
168 168  
169 169  [[//Sauvegarder l'aide en ligne//>>image:1757597668258-471.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
170 170