Projet:Aide et accueil/Guide de rédaction

Une page de Wikipédia, l'encyclopédie libre.

Les pages d'aide fournissent des explications, des instruction et des conseils pratiques. Ce document énonce les principes de conception des pages d'aide pour créer des pages d'aide utiles, simples et accessibles qui répondront aux questions des contributeurs afin de résoudre leurs problèmes.

Focus sur les utilisateurs et les cas d'utilisation[modifier | modifier le code]

Parlez au lecteur du problème qu'ils tente de résoudre
Utilisez un langage actif, comme « Ajout de références », « Personnalisation d'un tableau » ...
Utilisez des rubriques descriptives comme « Je veux ... », « Comment puis-je ...? "
Aider de vrais gens à résoudre des problèmes réels. Ne pas surcharger les explications avec des tonnes de principes et d'historique.

Encourager et rassurer les lecteurs[modifier | modifier le code]

Faire que lecteurs gagnent en compréhension et en confiance en lisant la page d'aide
Utiliser un style proche de la conversation peut aider à ce que les pages soient plus accessibles et agréables à lire, en particulier pour les nouveaux utilisateurs
Ne faites pas que les lecteurs se sentent stupides, ou coupables de ne pas avoir lu toutes les pages d'aide

Rester simple[modifier | modifier le code]

Concentrez-vous sur les manières de faire les plus courantes et faites qu'ils restent facilement identifiables
Faites des phrases et des paragraphes courts. Les phrases devraient avoir moins de 25 mots. Un paragraphe devrait se concentrer sur un seul sujet.
Inclure les résumés courts, pour expliquer comment faire
Inclure des exemples (échantillon de code, pas à pas, etc.)
Décomposer des processus complexes en étapes
Utiliser une terminologie cohérente et constante
Ne pas faire de liens vers l’espace principal pour expliquer un terme, renvoyer sur la page de jargon ou une page spécifique
Présentez des moyens simples :
par exemple suggérer un Gadget au lieu d'expliquer comment éditer le css / js personnel, proposer un Gadget de références plutôt que de tout taper à la main...
Évitez de multiplier les liens vers d'autres pages (en particulier l’espace principal)

Faire une navigation claire et apparente[modifier | modifier le code]

Marquer les éléments essentiels et les mettre en avant
Utiliser {{En-tête Aide}} pour démarrer une page, avec une introduction appropriée : « cette page va vous permettre de... »
Créer une section « À retenir » à la suite du modèle d'en-tête, présentant les points essentiels.
Marquer les éléments facilitant la compréhension
Indiquer la présence d'une page d'aide présentant les bases, ou détaillant d'autres aspects plus complexes avec {{aide détaillée}}
Guider les utilisateurs dans une progression évidente, indiquant où ils doivent aller
Utiliser du gras sur les points-clés
Utilisez l'espace de noms approprié
Tout ce qui concerne les politiques, les directives et les processus doivent être dans l’espace de noms Wikipédia
Les instructions, « comment faire », tutoriels et explications des caractéristiques de MediaWiki doivent être dans l’espace de noms Aide

Conception des pages d'aide pour les rendre visuellement attrayantes[modifier | modifier le code]

Inciter les utilisateurs à lire avec un design clair
Casser les pages en sections et sous-sections ayant chacune un titre clair
Illustrer des articles avec les médias riches
Captures d'écran (.png de haute qualité, pas .jpeg)
Vidéos
Ne pas briser l'accessibilité
Les images doivent avoir un texte alternatif
Les tableaux doivent comporter des titres et des légendes
Utilisez des modèles pour faire des focus
{{relief}} permet de mettre en avant des points clés

Ciblez des pages d'aide à différents niveaux d'expérience[modifier | modifier le code]

Faire des aperçus qui traitent des problèmes les plus communs avec des solutions les plus efficaces
Les introductions des pages sont simples, courtes et pas écrasantes
Avoir des liens pertinents
Créer des liens vers des termes qui n'ont pas été mis en place auparavant dans la page
Créer des liens vers la page la moins complexe techniquement
Séparer et minimiser les cas avancés et hautement spécifiques d'utilisation, renvoyer vers une page d'aide spécifique
Utilisez les notes de bas de page pour les informations supplémentaires, non-essentiels
Envelopper de grands blocs de code, les exemples détaillés et des cas rares dans une boîte déroulante