Modifications pour le document Documenter l’aide en ligne
Modifié par Doriane Bautista le 2025/09/17 16:01
Depuis la version 71.1
modifié par Doriane Bautista
sur 2025/09/17 16:01
sur 2025/09/17 16:01
Commentaire de modification :
Il n'y a aucun commentaire pour cette version
À la version 63.1
modifié par Doriane Bautista
sur 2025/09/11 16:36
sur 2025/09/11 16:36
Commentaire de modification :
Il n'y a aucun commentaire pour cette version
Résumé
-
Propriétés de la Page (1 modifications, 0 ajouts, 0 suppressions)
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 : ... ... @@ -85,11 +85,26 @@ 85 85 86 86 Une fois le champ ou le bloc trouvé, cliquez sur son nom pour ouvrir l’éditeur HTML. 87 87 112 +Vous pouvez saisir directement votre texte ou copier-coller l’aide du wiki avant de l’adapter à vos besoins internes. 113 + 114 +Cet éditeur fonctionne comme un traitement de texte (type Word) et propose de nombreuses options : 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. 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. 124 + 125 +(% class="box warningmessage" %) 88 88 ((( 89 - 1.**Saisirlecontenu**127 +**Point d’attention : insérer des liens** 90 90 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. 129 +* Pour créer un lien vers un document ou une ressource externe, copiez d’abord l’URL dans un document Word : elle devient un lien bleu cliquable. 130 +* Copiez-collez ensuite ce lien dans l’éditeur d’aide en ligne. Il sera reconnu correctement et restera actif. 131 +))) 93 93 94 94 (% class="box successmessage" %) 95 95 ((( ... ... @@ -97,8 +97,8 @@ 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édiatementcompréhensibles.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. 102 102 * Employez le vocabulaire métier partagé : utilisez les termes définis dans la charte de saisie de votre institution. 103 103 104 104 **Contenu et cohérence** ... ... @@ -107,47 +107,12 @@ 107 107 * Ajoutez des exemples concrets : illustrez les valeurs attendues pour éviter toute ambiguïté. 108 108 * Limitez les redondances : n’intégrez que ce qui est pertinent, sans recopier inutilement l’aide du wiki. 109 109 * Documentez aussi les blocs de champs : expliquez leur rôle global en plus des champs qu’ils contiennent. 110 -))) 111 -))) 112 112 113 -((( 114 -(% start="2" %) 115 -1. **Mettre en forme l’aide** 150 +**Suivi et maintenance** 116 116 117 -* L’éditeur fonctionne comme un traitement de texte (type Word) et vous permet d’appliquer différents outils : 118 -** **Mise en forme du texte** : gras, italique, souligné, exposant, indice. 119 -** **Organisation du contenu** : listes à puces, listes numérotées, retrait, alignement. 120 -** **Styles et formats** : titres, styles prédéfinis, choix de la police et de la taille. 121 -** **Tableaux et images** : insertion et gestion de tableaux, ajout d’images. 122 -** **Éléments enrichis** : caractères spéciaux, symboles. 123 -** **Outils pratiques** : correcteur orthographique, recherche/remplacement, annuler/rétablir, affichage du code source. 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 124 124 ))) 125 125 126 -(% class="box warningmessage" %) 127 -((( 128 -**Point d’attention : insérer des liens** 129 - 130 -* Pour créer un lien vers un document ou une ressource externe, copiez d’abord l’URL dans un document Word : elle devient un lien bleu cliquable. 131 -* Copiez-collez ensuite ce lien dans l’éditeur d’aide en ligne. Il sera reconnu correctement et restera actif. 132 -))) 133 - 134 -((( 135 -(% start="3" %) 136 -1. **Sauvegarder la personnalisation** 137 - 138 -* Cliquez sur **Sauvegarder** pour enregistrer vos modifications. 139 -* Dès la sauvegarde, l’aide en ligne du wiki disparaît : elle est remplacée par votre aide personnalisée. 140 -* Cette personnalisation ne s’applique que dans votre base institutionnelle et n’a aucun impact sur le wiki ni sur les autres musées. 141 -))) 142 - 143 -(% class="box successmessage" %) 144 -((( 145 -**Bonnes pratiques : ** 146 - 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. 149 -))) 150 - 151 151 >(% class="small" %)L’exemple ci-dessous illustre le champ **Numéro d’inventaire** avec une aide en ligne enrichie : 152 152 153 153 >(% class="small" %)un **tableau** décrivant les différentes règles d’attribution, ... ... @@ -205,7 +205,7 @@ 205 205 206 206 **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. 207 207 208 -[[//Repérage nom interne du champ - une infobulle apparait avec lesurvol duchamp//>>image:1757599364051-795.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]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"]] 209 209 210 210 211 211 [[//Choix de **la source** et de la** table**//>>image:1757599467798-396.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]