Modifications pour le document Documenter l’aide en ligne

Résumé

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

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" %)(((
...	...	@@ -11,75 +11,80 @@
11	11	)))
12	12
13	13	(((
14		-= L'aide en ligne : un appui à la saisie dans Flora =
	12	+= À quoi sert l'aide en ligne dans Flora ? =
15	15
	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.
16	16
17		-L’aide en ligne **accompagne les utilisateurs** dans la compréhension et l’utilisation des champs présents dans les différentes tables de Flora.
18		-Elle contribue à garantir une saisie homogène, cohérente et conforme aux pratiques définies par votre institution. Elle complète les documents de référence internes et les procédures métiers du musée.
19		-Son objectif est de traduire concrètement ces règles directement dans l’interface de Flora, au plus près des champs utilisés par les équipes au quotidien.
	16	+Elle vient en appui des documents de référence internes comme la **charte de saisie**, la **charte de nommage** ou les **processus métiers** propres au musée. Elle permet ainsi de traduire concrètement ces règles dans l’interface de Flora, au plus près des champs utilisés par les équipes.
20	20
21		-Concrètement, l’aide en ligne permet de :
	18	+**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**.
22	22
23		-* **Expliquer le contenu attendu dans un champ**.
24		-* **Formaliser les règles de saisie propres à l’institution** (abréviations autorisées, vocabulaire contrôlé, conventions d’écriture, etc.).
25		-* **Donner accès à des ressources externes de référence** (textes réglementaires, chartes internes, normes, guides méthodologiques).
26		-* **Harmoniser les pratiques et éviter les erreurs d’interprétation**, notamment dans les équipes élargies ou en cas de renouvellement des agents.
	20	+>(% class="small" %)Cas d'usage:
27	27
28		-Par défaut, **l’aide en ligne est redirigée vers l’aide disponible sur le wiki officiel**. Cette documentation est actuellement en cours de rédaction et d’enrichissement par l’équipe de Flora Software.
	22	+(((
	23	+>(% class="small" %)Expliquer le contenu attendu dans un champ.
29	29
30		-Elle constitue une **base commune de référence pour l’ensemble des utilisateurs**.
	25	+(((
	26	+>(% class="small" %)Formaliser les règles de saisie propres à l’institution.
31	31
32		-Toutefois, chaque institution a la possibilité d**’adapter cette aide à ses propres pratiques**.
	28	+>(% class="small" %)Indiquer à quels processus le champ est lié  (ex. : inventaire, récolement, prêt, dépôt, restauration, etc.).
33	33
34		-= Personnaliser l'aide en ligne =
	30	+>(% class="small" %)Donner accès à des ressources externes de référence.
35	35
36		-Lorsqu’un musée crée une **aide en ligne personnalisée** pour un champ :
	32	+>(% class="small" %)Harmoniser les pratiques et éviter les erreurs d’interprétation.
	33	+)))
	34	+)))
37	37
38		-* le contenu standard issu du** wiki est automatiquement masqué**
39		-* seul le **contenu rédigé localement est affiché**
	36	+= Identifier le nom interne du champ ou du bloc =
40	40
41		-Si cette personnalisation est supprimée, l’aide du wiki réapparaît automatiquement.
	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 :
42	42
43		-Cette **personnalisation est strictement locale** : elle s’applique uniquement à la base de données de l’institution qui l’a créée.
44		-Elle ne modifie pas le contenu du wiki et n’a aucun impact sur les autres institutions.
	40	+* Survolez le libellé dans une grille de saisie : son nom interne s’affiche en infobulle.
	41	+* Vous pouvez aussi faire un clic droit sur le libellé et choisir **Afficher informations** pour copier directement le nom interne.
45	45
	43	+>(% class="small" %)Exemple : dans la table MUS_BIEN, le champ Numéro d’inventaire porte le nom technique **NUM_INVENTAIRE**.
46	46
47		-== Identifier le nom interne du champ ou du bloc ==
	45	+[[//Ex. Biens : survol d'un libellé et affichage du nom interne en infobulle//>>image:1744363912649-947.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
48	48
49		-Pour retrouver le fichier d’aide correspondant, vous devez d’abord identifier le nom interne du champ ou du bloc de champs.
50	50
51		-Pour cela :
	48	+[[//Ex. Biens : clic droit sur le champ - Afficher informations//>>image:1744363948510-224.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
52	52
53		-1. Faites un **clic droit** sur le libellé du champ
54		-1. Choisir **Afficher informations**
55		-1. **Copiez le nom interne **du champ (ligne name)
56	56
57		-[[//Clic droit - Afficher informations//>>image:1744363948510-224.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
	51	+[[//Résultat : Nom interne du champ indiqué sur la première ligne//>>image:1744363968204-295.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
58	58
59	59
60		-[[//Nom interne du champ//>>image:1744363968204-295.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
	54	+= Ouvrir l’éditeur d’aide en ligne =
61	61
	56	+Pour créer ou modifier une aide, rendez-vous dans l’espace de travail **Administration**, menu **Paramétrage** > **Aide en ligne**.
62	62
63		-== Accéder à l'éditeur d'aide en ligne ==
	58	+Vous y trouverez la liste des fichiers disponibles, organisés par source et par table.
64	64
65		-1. Rendez-vous dans l'espace de travail **Administration, menu Paramétrage, Aide en ligne**
66		-1. Dépliez la rubrique** Aide à la saisie**
67		-1. Choisir la source et la table
68		-1. **Utilisez le raccourci clavier Ctrl + F** pour ouvrir la barre de recherche
69		-1. **Collez le nom interne** que vous avez récupéré
70		-1. **Cliquez sur l’élément trouvé** pour ouvrir l’éditeur
	60	+Dépliez la rubrique **Aide à la saisie** pour rechercher les champs et blocs de champs à documenter.
71	71
72		-[[//Choix de la source Musée et de la table Biens et ensembles//>>image:1757595391112-778.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
	62	+[[//Espace de travail **Administration **~> menu **Paramétrage** ~> **Aide en ligne** ~> rubrique** Aide à la saisie**//>>image:1757594385587-551.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
73	73
74	74
75		-[[//Afficher la barre de recherche avec **CTRL+F** pour rechercher le champ//>>image:1757595571069-539.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
	65	+= Localiser le champ ou le bloc à personnaliser =
76	76
	67	+Une fois dans le module d’édition des aides en ligne, vous devez localiser précisément le champ ou le bloc concerné avant de pouvoir le personnaliser. Procédez étape par étape :
77	77
78		-[[//Ouverture de l'éditeur//>>image:1757595726608-759.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
	69	+1. **Choisissez la source** (ex. Musées, Bibliothèque, Archives).
	70	+1. **Sélectionnez la table** dans laquelle se trouve le champ ou le bloc à documenter.
	71	+1. **Utilisez le raccourci clavier Ctrl + F** pour ouvrir la barre de recherche.
	72	+1. **Collez le nom interne** que vous avez récupéré (champ ou bloc).
	73	+1. **Cliquez sur l’élément trouvé** pour ouvrir l’éditeur.
79	79
	75	+[[//Choix de la **source Musée** et de la **table Biens et ensembles**//>>image:1757595391112-778.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
80	80
81		-== Rédiger et mettre en forme votre aide ==
82	82
	78	+[[//Recherche **CTRL+F** et clic sur le nom interne du champ **NUM_INVENTAIRE**//>>image:1757595571069-539.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
	79	+
	80	+
	81	+[[//Résultat : l'éditeur d'aide en ligne apparait //>>image:1757595726608-759.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
	82	+
	83	+
	84	+= Rédiger et mettre en forme votre aide =
	85	+
83	83	Une fois le champ ou le bloc trouvé, cliquez sur son nom pour ouvrir l’éditeur HTML.
84	84
85	85	(((
...	...	@@ -92,9 +92,15 @@
92	92	(((
93	93	**Bonnes pratiques : **
94	94
	98	+**Présentation et clarté**
	99	+
95	95	* Uniformisez la présentation : adoptez une structure homogène pour toutes vos aides (ex. : définition, usage, remarques).
96	96	* Soyez clairs et concis : rédigez des explications courtes et immédiatement compréhensibles.
97	97	* Employez le vocabulaire métier partagé : utilisez les termes définis dans la charte de saisie de votre institution.
	103	+* Ajoutez des exemples concrets : illustrez les valeurs attendues afin d’éviter toute ambiguïté.
	104	+
	105	+**Contenu et cohérence**
	106	+
98	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	99	* Ajoutez des exemples concrets : illustrez les valeurs attendues pour éviter toute ambiguïté.
100	100	* Limitez les redondances : n’intégrez que ce qui est pertinent, sans recopier inutilement l’aide du wiki.
...	...	@@ -158,6 +158,8 @@
158	158
159	159	[[//Saisie et mise en forme des données//>>image:1757596818102-351.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
160	160
	170	+(% class="wikigeneratedid" id="H200B200B200B200B200B200B200B200B200B200B200B200B200B200B" %)
	171	+​​​​​​​​​​​​​​
161	161
162	162	[[//Sauvegarder l'aide en ligne//>>image:1757597668258-471.png||data-xwiki-image-style-alignment="center" data-xwiki-image-style-border="true"]]
163	163