Cette page présente les différents types de contenu, quand les utiliser et comment rédiger pour chacun.
Catégoriser avec le cadre Diátaxis
- Tutoriels : contenu orienté apprentissage pour les nouveaux utilisateurs
- Guides pratiques : guides orientés tâches pour résoudre des problèmes spécifiques
- Explications : discussions conceptuelles axées sur la compréhension
- Références : descriptions techniques orientées information
Choisir un type
| Question | Tutoriel | Guide pratique | Référence | Explication |
|---|---|---|---|---|
| Quel est l’objectif de l’utilisateur ? | Apprendre par la pratique | Résoudre un problème précis | Trouver une information précise | Comprendre des concepts |
| Quel est le niveau de l’utilisateur ? | Débutant | Intermédiaire | Confirmé | Tous niveaux |
| Quel est l’objectif principal ? | Apprendre en pratiquant | Atteindre un objectif | Fournir des informations | Approfondir la compréhension |
| Comment le contenu est-il structuré ? | Étape par étape | Problème–solution | Faits organisés | Discussions conceptuelles |
| Est-ce orienté tâches ? | Oui, tâches guidées | Oui, tâches spécifiques | Non, informatif | Non, conceptuel |
| Est-ce conçu pour une progression linéaire ? | Oui | Non | Non | Non |
Rédiger pour chaque type
Tutoriels (axés sur l’apprentissage)
- Objectif du public : Apprendre quelque chose de nouveau grâce à des instructions pas à pas.
- Caractéristiques : Séquentiels et ne nécessitent aucune connaissance préalable.
- Approche de rédaction :
- Préciser ce que l’utilisateur aura accompli après la lecture.
- Utiliser des étapes claires et progressives. Limiter au maximum les choix à effectuer par l’utilisateur.
- Signaler les étapes clés au fil du parcours.
- Réduire la théorie au minimum et se concentrer sur des actions concrètes.
Guides pratiques (orientés problème)
- Objectif du public : Réaliser correctement une tâche précise.
- Caractéristiques : Orientés objectif et supposant des connaissances préalables.
- Approche rédactionnelle :
- Écrire du point de vue de l’utilisateur, non du produit.
- Décrire une séquence logique et omettre les détails superflus.
- Limiter le contexte au strict nécessaire.
Référence (axée sur l’information)
- Objectif de l’audience : Trouver des détails sur les fonctionnalités d’un produit.
- Caractéristiques : Sans ambiguïté, centrée sur le produit, facilement balayable.
- Approche rédactionnelle :
- Rendre le contenu scannable et concis.
- Privilégier la cohérence.
- Éviter le contenu explicatif. Se concentrer sur des exemples faciles à copier et à adapter.
Explication (axée sur la compréhension)
- Objectif du public : Élargir la compréhension générale d’un concept ou d’une fonctionnalité très complexe.
- Caractéristiques : Théorique, potentiellement subjective, de portée large.
- Approche rédactionnelle :
- Fournir du contexte, comme des décisions de conception ou des contraintes techniques.
- Reconnaître les opinions et les alternatives.
- Établir des liens avec d’autres aspects du produit ou du secteur.
Conseils et astuces
- Gardez l’objectif en tête : Avant d’écrire, attribuez à chaque page un type de contenu précis et maintenez-le comme fil conducteur tout au long de la rédaction.
- Tenez compte de la fraîcheur du contenu : Quel que soit le type, privilégiez une documentation durable. Si un élément fige l’apparence d’une fonctionnalité à une date donnée, il est sans doute plus adapté à un journal des modifications ou à un article de blog qu’à votre documentation. Et si quelque chose évolue très souvent, évitez de l’inclure dans vos docs.
- Mettez-vous à la place de vos utilisateurs : Prenez en compte différents profils/personas lors de l’organisation du contenu. Voir Understand your audience pour en savoir plus.