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 de concepts et des sections conceptuelles dans d’autres articles. La plupart des principaux produits, fonctionnalités ou sujets ont leur propre article sur les concepts.
Choix entre un article ou une section
Les procédures ou tutoriels peuvent comporter 1 à 2 phrases d’introduction brèves avant les étapes. Si d’autres explications au-delà d’un couple de phrases sont nécessaires, c’est quand nous devons déterminer s’il mérite une place dans un article sur les concepts.
Toutefois, nous devrions être sélectifs. Chaque concept ou section « À propos de X » n’a pas besoin de son propre article. En règle générale, il s’agit de la quantité d’informations qui seront utiles à l’utilisateur que nous devons inclure.
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.
Titres pour les contenus conceptuels
Les titres courts d’articles doivent comporter un seul mot ou un groupe nominal. Si les articles apparaissent sous Concepts dans la barre latérale, évitez d’utiliser « À propos », sauf si l’article apparaît sous un titre du même nom. Ex : « Agent de codage » et « À propos de l’agent de codage ».
Les en-têtes des sections conceptuelles des articles commencent par « À propos de [sujet] ».
- Utilisez un nom pour décrire le sujet.
- Utiliser : « À propos de code scanning »
- Évitez : « 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