Comment rédigez-vous une documentation utilisateur cohérente et alignée sur la voix et le ton de votre marque ?

1 Connaissez votre public

Avant de commencer à écrire, vous devez comprendre qui sont vos utilisateurs cibles, quels sont leurs objectifs et leurs points faibles, et comment ils préfèrent consommer l’information. Vous pouvez utiliser des personas d’utilisateurs, des enquêtes, des entretiens, des analyses et des commentaires pour recueillir des informations sur votre public. Cela vous aidera à adapter votre contenu à leurs besoins, attentes et préférences. Par exemple, vous pouvez utiliser différents niveaux de technicité, de formalité et d’humour en fonction de l’origine, du contexte et de l’humeur de votre public.

2 Définissez votre voix et votre ton

Votre voix et votre ton sont les expressions de la personnalité et des valeurs de votre marque. Votre voix est cohérente sur tous vos canaux de communication, tandis que votre ton peut varier en fonction de la situation et de l’émotion que vous souhaitez transmettre. Par exemple, votre voix peut être amicale, professionnelle et confiante, tandis que votre ton peut être plus décontracté, formel ou empathique en fonction du sujet, de l’objectif et du public de votre documentation utilisateur. Vous pouvez utiliser un guide de voix et de ton pour documenter vos directives de style et des exemples pour vos rédacteurs et éditeurs.

3 Utilisez un langage simple et clair

L’un des principaux objectifs de la documentation utilisateur est d’aider vos clients à comprendre et à utiliser votre produit sans confusion ni frustration. Pour ce faire, vous devez utiliser un langage simple et clair qui évite le jargon, l’ambiguïté et la complexité inutile. Vous pouvez utiliser des principes d’anglais simple, tels que l’utilisation d’une voix active, de phrases courtes, de mots courants et d’énoncés positifs. Vous pouvez également utiliser des outils comme Hemingway ou Grammarly pour vérifier votre lisibilité et votre grammaire.

4 Structurez votre contenu logiquement

Une autre façon de rendre votre documentation utilisateur facile à suivre et à digérer est de structurer votre contenu de manière logique et cohérente. Vous pouvez utiliser des en-têtes, des sous-titres, des listes, des tableaux et des diagrammes pour organiser vos informations en blocs et hiérarchies. Vous pouvez également utiliser des éléments de navigation, tels que des menus, des liens, des fils d’Ariane et des barres de recherche, pour aider vos utilisateurs à trouver rapidement et facilement ce qu’ils recherchent. Vous pouvez utiliser un modèle de contenu ou un modèle pour définir vos types et éléments de contenu.