Modifications pour le document Documenter l’aide en ligne

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

Depuis la version 62.1
modifié par Doriane Bautista
sur 2025/09/11 16:35
Commentaire de modification : Il n'y a aucun commentaire pour cette version
À la version 72.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 :
... ... @@ -109,19 +109,39 @@
109 109  
110 110  Une fois le champ ou le bloc trouvé, cliquez sur son nom pour ouvrir l’éditeur HTML.
111 111  
112 -Vous pouvez saisir directement votre texte ou copier-coller l’aide du wiki avant de l’adapter à vos besoins internes.
88 +(((
89 +1. **Saisir le contenu**
113 113  
114 -Cet éditeur fonctionne comme un traitement de texte (type Word) et propose de nombreuses options :
91 +* Tapez directement votre texte dans l’éditeur.
92 +* Vous pouvez aussi copier-coller l’aide issue du wiki et l’adapter à vos besoins internes.
115 115  
116 -* **Mise en forme du texte** : gras, italique, souligné, exposant, indice.
117 -* **Organisation du contenu** : listes à puces, listes numérotées, retrait, alignement.
118 -* **Styles et formats** : titres, styles prédéfinis, choix de la police et de la taille.
119 -* **Tableaux et images** : insertion et gestion de tableaux, ajout d’images.
120 -* **Éléments enrichis** : caractères spéciaux, symboles.
121 -* **Outils pratiques** : correcteur orthographique, recherche/remplacement, annuler/rétablir, affichage du code source.
94 +(% class="box successmessage" %)
95 +(((
96 +**Bonnes pratiques : **
122 122  
123 -Une fois votre saisie terminée, cliquez sur **Sauvegarder** pour enregistrer votre personnalisation. **Dès la sauvegarde, l’aide en ligne par défaut issue du wiki est remplacée par votre aide personnalisée** : celle-ci ne s’affichera que dans votre base de données institutionnelle et n’aura aucun impact sur le wiki ni sur les autres musées.
98 +* Uniformisez la présentation : adoptez une structure homogène pour toutes vos aides (ex. : définition, usage, remarques).
99 +* Soyez clairs et concis : rédigez des explications courtes et immédiatement compréhensibles.
100 +* Employez le vocabulaire métier partagé : utilisez les termes définis dans la charte de saisie de votre institution.
101 +* Précisez le contexte : indiquez si le champ ou bloc est lié à un processus particulier (inventaire, récolement, prêt, dépôt, restauration).
102 +* Ajoutez des exemples concrets : illustrez les valeurs attendues pour éviter toute ambiguïté.
103 +* Limitez les redondances : n’intégrez que ce qui est pertinent, sans recopier inutilement l’aide du wiki.
104 +* Documentez aussi les blocs de champs : expliquez leur rôle global en plus des champs qu’ils contiennent.
105 +)))
106 +)))
124 124  
108 +(((
109 +(% start="2" %)
110 +1. **Mettre en forme l’aide**
111 +
112 +* L’éditeur fonctionne comme un traitement de texte (type Word) et vous permet d’appliquer différents outils :
113 +** **Mise en forme du texte** : gras, italique, souligné, exposant, indice.
114 +** **Organisation du contenu** : listes à puces, listes numérotées, retrait, alignement.
115 +** **Styles et formats** : titres, styles prédéfinis, choix de la police et de la taille.
116 +** **Tableaux et images** : insertion et gestion de tableaux, ajout d’images.
117 +** **Éléments enrichis** : caractères spéciaux, symboles.
118 +** **Outils pratiques** : correcteur orthographique, recherche/remplacement, annuler/rétablir, affichage du code source.
119 +)))
120 +
125 125  (% class="box warningmessage" %)
126 126  (((
127 127  **Point d’attention : insérer des liens**
... ... @@ -130,26 +130,21 @@
130 130  * Copiez-collez ensuite ce lien dans l’éditeur d’aide en ligne. Il sera reconnu correctement et restera actif.
131 131  )))
132 132  
129 +(((
130 +(% start="3" %)
131 +1. **Sauvegarder la personnalisation**
132 +
133 +* Cliquez sur **Sauvegarder** pour enregistrer vos modifications.
134 +* Dès la sauvegarde, l’aide en ligne du wiki disparaît : elle est remplacée par votre aide personnalisée.
135 +* Cette personnalisation ne s’applique que dans votre base institutionnelle et n’a aucun impact sur le wiki ni sur les autres musées.
136 +)))
137 +
133 133  (% class="box successmessage" %)
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
142 +* 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.
143 +* Mettez à jour régulièrement : adaptez vos contenus lorsque vos procédures internes ou règles métier évoluent.
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 -[[//Sauvegarde de l'aide en ligne//>>image:1757597668258-471.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
167 +[[//Sauvegarder 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//>>image:1757599364051-795.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
203 +[[//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"]]
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"]]