Commencez par comprendre vos utilisateurs et votre produit
Établissez les bases avec les parties prenantes
- Quelle est la manière la plus simple d’expliquer comment le produit fonctionne ?
- Quels sont les composants fondamentaux du produit ?
- Comment les utilisateurs adoptent-ils généralement le produit ? Où se retrouvent-ils le plus souvent bloqués ?
- Quelles sont les intégrations ou dépendances les plus importantes ?
- Si le produit était divisé en différentes couches, quelles seraient-elles ? Serait-il organisé par tâches que les gens effectuent ou par fonctionnalités qu’ils utilisent ?
Sachez pour qui vous écrivez
Organisez par parcours utilisateur, pas par fonctionnalités du produit
| Centré sur les fonctionnalités (à éviter) | Centré sur le parcours (préférable) |
|---|---|
| API principale | Démarrer |
| Authentification | S’authentifier |
| Webhooks | Envoyer votre première requête |
| Limitation de débit | Gérer les erreurs |
| SDKs | Passer en production |
Gérez la profondeur et la largeur
- Limitez les sections de niveau supérieur à sept éléments ou moins. La charge cognitive augmente lorsque les utilisateurs doivent examiner et évaluer davantage d’options.
- Préférez la profondeur à la largeur. Une section de niveau supérieur avec cinq sous-sections est plus facile à parcourir que 20 éléments de niveau supérieur.
- Ne cachez pas le contenu critique en dessous de deux niveaux. Si les utilisateurs doivent cliquer à travers trois niveaux pour atteindre des pages fréquemment consultées, envisagez de promouvoir ce contenu.
- Utilisez des verbes pour les sections orientées tâches (“S’authentifier”, “Déployer”, “Surveiller”)
- Utilisez des noms pour les sections de référence (“Référence API”, “SDKs”, “Journal des modifications”)
- Évitez la terminologie interne que les utilisateurs ne reconnaîtront pas
- Gardez les libellés courts — idéalement moins de 4 mots
Validez vos hypothèses
Suivez les parcours réels des utilisateurs
- Points d’entrée : Où les utilisateurs commencent-ils ? Viennent-ils d’une recherche, d’un ticket de support ou directement de votre produit ?
- Schémas de navigation : Les utilisateurs suivent-ils la structure prévue ou empruntent-ils des chemins inattendus ?
- Points de friction : Où les utilisateurs s’arrêtent-ils, reviennent-ils en arrière ou abandonnent-ils leur session ?
- Comportement de recherche : Les utilisateurs recherchent-ils des termes qui n’apparaissent pas dans vos libellés de navigation ? Cela signale un décalage terminologique.
Testez avec de vrais utilisateurs
Identifiez et corrigez les problèmes courants
Sections de niveau supérieur surchargées
Contenu essentiel enfoui
Noms de section peu clairs
Itérez au fil du temps
- Révisez la navigation chaque fois que le produit lance des changements majeurs. Les nouvelles fonctionnalités exposent souvent des lacunes structurelles.
- Consultez les analyses de recherche trimestriellement pour repérer les termes que les utilisateurs recherchent et qui ne sont pas reflétés dans vos libellés de navigation.
- Réexaminez la structure de niveau supérieur annuellement. À mesure que la documentation grandit, ce qui fonctionnait à 20 pages peut ne plus fonctionner à 200.
Questions fréquemment posées
Dois-je organiser la navigation par fonctionnalités du produit ou par objectifs utilisateur ?
Dois-je organiser la navigation par fonctionnalités du produit ou par objectifs utilisateur ?
Combien de sections de navigation de niveau supérieur devrais-je avoir ?
Combien de sections de navigation de niveau supérieur devrais-je avoir ?
Comment gérer une documentation qui s'adresse à plusieurs audiences ?
Comment gérer une documentation qui s'adresse à plusieurs audiences ?
D’abord, décidez si vos audiences sont suffisamment différentes pour nécessiter des structures séparées. Si un administrateur et un développeur ont tous deux besoin de démarrer, une section partagée “Démarrer” peut très bien fonctionner avec des sous-sections spécifiques à chaque audience. Si leurs parcours sont fondamentalement différents — produits séparés, personas séparés — envisagez des sites de documentation séparés ou une navigation par onglets qui sépare clairement les deux chemins.
Quand devrais-je réorganiser ma navigation ?
Quand devrais-je réorganiser ma navigation ?
Comment empêcher la navigation de devenir désordonnée à mesure que la documentation grandit ?
Comment empêcher la navigation de devenir désordonnée à mesure que la documentation grandit ?