10 règles d’or pour réaliser un manuel utilisateur de qualité

Quel que soit votre secteur d’activité, la documentation technique joue un rôle crucial dans la manière dont vous accompagnez, vous formez et vous assistez vos utilisateurs. Un opérateur en usine utilisant votre découpeuse laser pour la première fois, un chirurgien en opération qui souhaite vérifier la procédure d’allumage de votre instrument médical, un particulier rencontrant des soucis avec votre aspirateur. Tous ont besoin d’une chose : trouver en quelques secondes une réponse à leur question. La documentation technique est là pour ça.

La documentation technique joue un rôle crucial dans la manière dont vous formez et vous assistez vos utilisateurs

Pour certains clients, la qualité de la documentation et du support peut même devenir un facteur clé dans la décision d’achat.

En accompagnant nos clients lors de missions de rédaction technique, nous avons rassemblé 10 règles d’or à suivre pour réaliser un manuel utilisateur de qualité.

1. Maitrisez votre sujet

• La procédure ne doit plus avoir de secret pour vous
• Réalisez-la vous même au moins une fois
• Essayez de l’enseigner à quelqu’un
• En cas de doute, faites appel aux experts

2. Adaptez-vous au public

• Evaluez le niveau de connaissance de votre audience
• Quelles questions vos utilisateurs peuvent-ils se poser ?
• Explicitez les acronymes et termes techniques
• Utilisez des tests de lisibilité en ligne

3. Choisissez un style

• Utilisez le même ton tout au long du document
• Maniez l’humour avec précaution
• Utilisez la 2ème personne du pluriel (« vous »)
• Faites des paragraphes courts

4. Soyez concis et précis

• Ne mentionnez que les informations essentielles
• Faites des phrases courtes
• Evitez les termes approximatifs
• N’utilisez pas de synonyme pour désigner un objet

5. Structurez vos manuels

• Découpez vos procédures en étapes simples
• Votre manuel doit être orienté « action »
• Renseignez les informations clés : durée, difficulté, pré-requis, etc.
• Réutilisez des contenus existants si nécessaire

6. Illustrez de photos

• Prenez des photos en HD et au format paysage
• Placez l’action au centre de la photo
• Retouchez vos photos (luminosité, couleur, recadrage)
• Ajoutez des annotations (cercle, flèche) si nécessaire

7. Utilisez d’autres visuels

• Insérez des illustrations pour donner une vue d’ensemble
• N’utilisez pas d’illustrations trop complexes
• Utilisez des pictogrammes pour prévenir et informer
• Choisissez des pictogrammes universels (ISO / ANSI)

8. Utilisez les vidéos

• N’utilisez les vidéos que si les photos ne suffisent pas
• Capturez des actions simples, de quelques secondes
• Evitez d’insérer des voix pour faciliter la traduction
• Sous-titrez les vidéos pour la recherche et l’indexation

9. Diffusez vos manuels

• Publiez vos manuels en ligne et évitez le format PDF
• Optimisez vos manuels pour les mobiles et tablettes
• Facilitez la navigation et la recherche au sein des manuels
• Centralisez la gestion de la publication

10. Mettez le contenu à jour

• Editez le contenu des pages autant que nécessaire
• Favorisez le partage de commentaires des utilisateurs
• Intégrez les retours pertinents en continu
• Mettez en place un processus de mise à jour