Modifications pour le document Documenter l’aide en ligne

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

Depuis la version 76.1
modifié par Joséphine Ducruet
sur 2026/02/18 16:26
Commentaire de modification : Il n'y a aucun commentaire pour cette version
À la version 75.1
modifié par Joséphine Ducruet
sur 2026/02/18 16:23
Commentaire de modification : Il n'y a aucun commentaire pour cette version

Résumé

Détails

Propriétés de la Page
Contenu
... ... @@ -43,6 +43,7 @@
43 43  Cette **personnalisation est strictement locale** : elle s’applique uniquement à la base de données de l’institution qui l’a créée.
44 44  Elle ne modifie pas le contenu du wiki et n’a aucun impact sur les autres institutions.
45 45  
46 +
46 46  == Identifier le nom interne du champ ou du bloc ==
47 47  
48 48  Pour retrouver le fichier d’aide correspondant, vous devez d’abord identifier le nom interne du champ ou du bloc de champs.
... ... @@ -77,27 +77,54 @@
77 77  [[//Ouverture de l'éditeur//>>image:1757595726608-759.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
78 78  
79 79  
80 -== Rédiger l'aide en ligne ==
81 +== Rédiger et mettre en forme votre aide ==
81 81  
82 -L’éditeur fonctionne comme un traitement de texte (type Word) et vous permet d’appliquer différents outils :
83 +Une fois le champ ou le bloc trouvé, cliquez sur son nom pour ouvrir l’éditeur HTML.
83 83  
84 84  (((
85 -* **Mise en forme du texte** : gras, italique, souligné, exposant, indice.
86 -* **Organisation du contenu** : listes à puces, listes numérotées, retrait, alignement.
87 -* **Styles et formats** : titres, styles prédéfinis, choix de la police et de la taille.
88 -* **Tableaux et images** : insertion et gestion de tableaux, ajout d’images.
89 -* **Éléments enrichis** : caractères spéciaux, symboles.
90 -* **Outils pratiques** : correcteur orthographique, recherche/remplacement, annuler/rétablir, affichage du code source.
86 +1. **Saisir le contenu**
87 +
88 +* Tapez directement votre texte dans l’éditeur.
89 +* Vous pouvez aussi copier-coller l’aide issue du wiki et l’adapter à vos besoins internes.
90 +
91 +(% class="box successmessage" %)
92 +(((
93 +**Bonnes pratiques : **
94 +
95 +* Uniformisez la présentation : adoptez une structure homogène pour toutes vos aides (ex. : définition, usage, remarques).
96 +* Soyez clairs et concis : rédigez des explications courtes et immédiatement compréhensibles.
97 +* Employez le vocabulaire métier partagé : utilisez les termes définis dans la charte de saisie de votre institution.
98 +* Précisez le contexte : indiquez si le champ ou bloc est lié à un processus particulier (inventaire, récolement, prêt, dépôt, restauration).
99 +* Ajoutez des exemples concrets : illustrez les valeurs attendues pour éviter toute ambiguïté.
100 +* Limitez les redondances : n’intégrez que ce qui est pertinent, sans recopier inutilement l’aide du wiki.
101 +* Documentez aussi les blocs de champs : expliquez leur rôle global en plus des champs qu’ils contiennent.
91 91  )))
103 +)))
92 92  
93 -(% class="box warningmessage" %)
94 94  (((
106 +(% start="2" %)
107 +1. **Mettre en forme l’aide**
95 95  
109 +* L’éditeur fonctionne comme un traitement de texte (type Word) et vous permet d’appliquer différents outils :
110 +** **Mise en forme du texte** : gras, italique, souligné, exposant, indice.
111 +** **Organisation du contenu** : listes à puces, listes numérotées, retrait, alignement.
112 +** **Styles et formats** : titres, styles prédéfinis, choix de la police et de la taille.
113 +** **Tableaux et images** : insertion et gestion de tableaux, ajout d’images.
114 +** **Éléments enrichis** : caractères spéciaux, symboles.
115 +** **Outils pratiques** : correcteur orthographique, recherche/remplacement, annuler/rétablir, affichage du code source.
96 96  )))
97 97  
118 +(% class="box warningmessage" %)
119 +(((
120 +**Point d’attention : insérer des liens**
98 98  
122 +* 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.
123 +* Copiez-collez ensuite ce lien dans l’éditeur d’aide en ligne. Il sera reconnu correctement et restera actif.
124 +)))
125 +
99 99  (((
100 -== **Sauvegarder la personnalisation** ==
127 +(% start="3" %)
128 +1. **Sauvegarder la personnalisation**
101 101  
102 102  * Cliquez sur **Sauvegarder** pour enregistrer vos modifications.
103 103  * Dès la sauvegarde, l’aide en ligne du wiki disparaît : elle est remplacée par votre aide personnalisée.