Modifications pour le document Documenter l’aide en ligne

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 :
...	...	@@ -95,9 +95,14 @@
95	95	(((
96	96	**Bonnes pratiques : **
97	97
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.
	122	+**Présentation et clarté**
	123	+
	124	+* Uniformisez la présentation : adoptez une structure homogène (définition, usage, remarques).
	125	+* Soyez clairs et concis : rédigez des explications courtes et directement utiles.
100	100	* Employez le vocabulaire métier partagé : utilisez les termes définis dans la charte de saisie de votre institution.
	127	+
	128	+**Contenu et cohérence**
	129	+
101	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	102	* Ajoutez des exemples concrets : illustrez les valeurs attendues pour éviter toute ambiguïté.
103	103	* Limitez les redondances : n’intégrez que ce qui est pertinent, sans recopier inutilement l’aide du wiki.
...	...	@@ -140,7 +140,6 @@
140	140	**Bonnes pratiques : **
141	141
142	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.
144	144	)))
145	145
146	146	>(% class="small" %)L’exemple ci-dessous illustre le champ **Numéro d’inventaire** avec une aide en ligne enrichie :