Le contenu conceptuel aide les utilisateurs à comprendre une fonctionnalité ou une rubrique en leur proposant une vue d’ensemble claire et générale, une explication de la façon dont la fonctionnalité ou la rubrique peut les aider dans leur parcours ainsi qu’un contexte comme des cas d’usage ou des exemples.
Nous créons des articles conceptuels et des sections conceptuelles au sein d’autres articles. La plupart des produits, fonctionnalités ou sujets d’importance majeure ont leur propre article conceptuel.
Comment écrire du contenu conceptuel
Pour le modèle de contenu conceptuel, consultez « Modèles ».
- Décrivez dans un langage simple la fonctionnalité, le produit ou la rubrique.
- Décrivez son objectif et son utilité pour le lecteur.
- Donnez des cas d’usage ou des exemples.
- Le cas échéant, décrivez le fonctionnement de la fonctionnalité ou de la rubrique (tenez compte de l’audience et de l’emplacement avant toute immersion dans les détails techniques).
- Indiquez tous les détails dont le lecteur doit avoir connaissance pour utiliser la fonctionnalité.
- Incluez les étapes suivantes pour bien démarrer avec la fonctionnalité (que ce soit avec des liens de type « Pour aller plus loin » ou du contenu dans l’article lui-même).
Titres pour les contenus conceptuels
- Les articles conceptuels ou en-têtes de sections conceptuelles commencent par « À propos de [rubrique] ».
- Utilisez un nom pour décrire le sujet.
- Utilisez : « À propos de code scanning »
- Évitez : « À propos de l’analyse de votre code à la recherche de vulnérabilités »
Exemples de contenu conceptuel
- Articles conceptuels
- Sections conceptuelles dans d’autres articles
- « À propos des règles de sécurité » dans Ajout d’une stratégie de sécurité à votre dépôt
- « À propos du mode de maintenance » dans Activation et planification du mode de maintenance