Modifications pour le document Documenter l’aide en ligne

Résumé

• Propriétés de la Page (3 modifications, 0 ajouts, 0 suppressions)

Détails

Propriétés de la Page

Titre

...	...	@@ -1,1 +1,1 @@
1		-Modifier l’aide en ligne
	1	+Documenter l’aide en ligne

Auteur du document

...	...	@@ -1,1 +1,1 @@
1		-XWiki.JDT
	1	+XWiki.DBA

Contenu

...	...	@@ -1,38 +1,52 @@
1		-{{box title="**Sommaire**"}}
2		-{{toc/}}
3		-{{/box}}
	1	+(% class="mark small" %)**Version 4.5.54 et ultérieures**
4	4
5		-= Définition =
	3	+|(% style="width:840px" %)(((
	4	+(% class="box" %)
	5	+(((
	6	+Dans Flora, chaque **champ ou bloc de champ** est accompagné d’une **aide en ligne **accessible directement depuis une **grille de saisie**. Par défaut, l’aide affichée provient du wiki.
6	6
7		-Chaque champ des différentes tables de Flora peut être documenté. Pour beaucoup de champs, cette aide n'est pas nécessaire car leur libellé suffit à en comprendre le sens et l'usage. Mais pour d'autres, il est nécessaire d'en expliquer le type de contenu, dans quelles fonctions ou processus ils interviennent ou même de donner accès à des ressources externes définissant des problématiques métiers très précises. C'est le cas par exemple des champs spécifiques aux musées et documentés sur la base Joconde du Ministère de la Culture.
	8	+Elle peut toutefois être personnalisée : chaque institution a la possibilité de** rédiger sa propre aide en ligne** afin d’adapter les consignes à ses besoins internes et à sa charte de saisie.
	9	+)))
8	8
9		-Decalog a mis en place un nombre important de ces aides en ligne, désormais présentes sur ce wiki. Ce travail, toujours perfectible, est en perpétuelle progression.
	11	+(((
	12	+= A quoi sert l'aide en ligne dans Flora ? =
10	10
11		-Par ailleurs, l'institution utilisatrice de Flora peut être amenée à redéfinir ou préciser, selon ses besoins internes, ces aides. Cela peut être fait dans le cadre d'une charte de saisie, par exemple.
	14	+L’aide en ligne **accompagne** les utilisateurs dans la **compréhension** et l’**usage **des **champs et blocs de champs **présents dans toutes les tables de Flora. Elle permet d’assurer une saisie cohérente et conforme aux pratiques définies par l’institution.
12	12
13		-L'accès à ces aides se fait champ par champ, par un simple clic droit sur le libellé du champ, via le menu "Afficher aide" :
	16	+**Lorsqu’un musée crée une** **aide en ligne personnalisée, celle du wiki disparaît au profit du contenu local.** Si la personnalisation est ensuite supprimée, l’aide du wiki réapparaît automatiquement. Cette personnalisation n’a d’effet que dans la base de données de l’institution qui l’a rédigée :** elle ne modifie en rien les contenus du wiki et n’impacte pas les autres musées**.
14	14
15		-[[image:1744363045589-792.png]]
	18	+>(% class="small" %)Cas d'usage:
16	16
	20	+(((
	21	+>(% class="small" %)Expliquer le contenu attendu dans un champ.
17	17
18		-Non seulement les champs, mais aussi les blocs de champs peuvent être documentés :
	23	+(((
	24	+>(% class="small" %)Formaliser les règles de saisie propres à l’institution.
19	19
20		-Exemple avec le bloc DATE_UTILISATION :
	26	+>(% class="small" %)Indiquer à quels processus le champ est lié  (ex. : inventaire, récolement, prêt, dépôt, restauration, etc.).
21	21
22		-[[image:1744363311261-338.png]]
	28	+>(% class="small" %)Donner accès à des ressources externes de référence.
23	23
24		-Aide en ligne du champs Numéro d'inventaire :
	30	+>(% class="small" %)Harmoniser les pratiques et éviter les erreurs d’interprétation.
	31	+)))
	32	+)))
25	25
26		-(% style="text-align:center" %)
27		-[[image:1744363337995-749.png]]
	34	+(% class="box successmessage" %)
	35	+(((
	36	+**Bonnes pratiques : **
28	28
29		-Il est ainsi tout à fait possible de décrire très concrètement l'ensemble des zones de saisies des différentes tables de Flora.
	38	+* **Être concis et clair** : rédiger des explications courtes, directement utiles à la saisie.
	39	+* **Utiliser le vocabulaire métier partagé** : employer les termes définis dans la charte de saisie de l’institution.
	40	+* **Préciser le contexte** : indiquer si le champ intervient dans un processus spécifique (inventaire, récolement, prêt, dépôt, restauration).
	41	+* **Ajouter des exemples concrets** : illustrer les valeurs attendues pour éviter toute ambiguïté.
	42	+* **Uniformiser la présentation** : structurer les textes de la même manière pour tous les champs (définition, usage, remarques).
	43	+* **Limiter la redondance** : éviter de copier-coller l’intégralité de l’aide du wiki, ne garder que ce qui est réellement utile ou adapté localement.
	44	+* **Documenter les blocs de champs** : expliquer le rôle global du bloc en plus du détail des champs si nécessaire.
	45	+* **Préserver une mémoire interne** : conserver une copie (Word, tableur, etc.) des aides personnalisées pour suivre l’évolution des consignes et faciliter la maintenance lors des mises à jour Flora.
	46	+* **Vérifier l’accessibilité** : tester l’affichage de la pop-up dans les navigateurs utilisés et vérifier que les aides apparaissent correctement.
	47	+* **Actualiser régulièrement** : mettre à jour les contenus quand les procédures internes ou les règles métier évoluent.
	48	+)))
30	30
31		-Les aides en ligne de Flora ont deux supports possibles :
32		-
33		-* le wiki sur lequel vous êtes actuellement
34		-* des fichiers html présents sur votre applicatif Flora
35		-
36	36	== Comportement par défaut ==
37	37
38	38	Lors d'un appel au menu "Afficher aide" Flora recherche d'abord le fichier html correspondant sur votre applicatif. Si cette recherche est infructueuse, Flora interroge le wiki dans un second temps.
...	...	@@ -51,7 +51,6 @@
51	51	L'accès à ces pages, en modification, suppression ou création, se fait avec un compte autorisé, dans l'espace de travail "Administration", Menu "Paramétrage Aides en ligne" :
52	52
53	53
54		-(% style="text-align:center" %)
55	55	[[image:1744363736609-747.png]]
56	56
57	57
...	...	@@ -59,7 +59,6 @@
59	59
60	60	Pour retrouver le fichier d'aide en ligne à renseigner, il faut connaitre le nom informatique du champ concerné.. Par exemple, en musée, le champ "numéro d'inventaire" de la table des biens (MUS_BIEN) se nomme NUM_INVENTAIRE.
61	61
62		-(% style="text-align:center" %)
63	63	[[image:1744363912649-947.png]]
64	64
65	65	Afin de connaître ce nom, il suffit d'aller sur une grille de saisie concernée et de survoler le libellé de l'élément à documenter
...	...	@@ -78,13 +78,11 @@
78	78
79	79	Cliquer sur le [[image:1744364312163-238.png]] de l'Aide à la saisie pour déplier la liste des fichiers.
80	80
81		-(% style="text-align:center" %)
82	82	[[image:1744364340925-762.png]]
83	83
84	84	(% class="wikigeneratedid" %)
85	85	Choisir ensuite la source et la table du champ auquel on souhaite ajouter une aide en ligne. Taper sur les touches Ctrl et F de votre clavier afin de faire apparaitre une barre de recherche. Puis coller le nom informatique du champ dans la barre de recherche afin de le retrouver facilement dans la liste des champs.
86	86
87		-(% style="text-align:center" %)
88	88	[[image:1744364568000-243.png]]
89	89
90	90	(% class="wikigeneratedid" %)
...	...	@@ -107,3 +107,33 @@
107	107	Mais il serait pratique pour vous de créer un document traitement de texte dans lequel vous copie/collerez les contenus des champs personnalisés de chaque table.
108	108
109	109	Ce document sera la "mémoire" des spécificités de votre protocole de saisie, et pourra d'ailleurs être affiché sur la page d'accueil comme indiqué [[ici>>doc:2_Administration.Administration fonctionnelle.Documents de référence sur page d'aide.WebHome]]
	120	+)))
	121	+)))|(% style="width:300px" %)(((
	122	+(% class="box" %)
	123	+(((
	124	+**Sommaire**
	125	+
	126	+
	127	+)))
	128	+
	129	+(% class="box" %)
	130	+(((
	131	+**Aller plus loin**
	132	+
	133	+* [[Saisir dans Flora>>doc:1_Fonctionnalités.5\.C\. Saisie.WebHome||target="_blank"]]
	134	+)))
	135	+
	136	+(% class="box" %)
	137	+(((
	138	+**Icônes principales**
	139	+)))
	140	+
	141	+(((
	142	+
	143	+
	144	+
	145	+
	146	+)))
	147	+)))
	148	+
	149	+