Lire en anglais

Partager via


Métadonnées de la documentation Microsoft Learn

Nous utilisons les métadonnées dans Microsoft Learn pour créer des rapports, améliorer la fonctionnalité de recherche de contenu et effectuer le suivi de l’expérience du site. Les métadonnées peuvent être appliquées au niveau de l’article (dans les pages liminaires YAML) ou de manière globale dans le fichier docfx.js pour l’ensemble du dépôt.

Si vous apportez une modification à un article existant, vous n’aurez probablement pas à modifier les métadonnées. Toutefois, si vous ajoutez un nouvel article, vous devrez inclure certains attributs de métadonnées obligatoires dans les pages liminaires YAML du fichier.

Voici un exemple de métadonnées appliquées dans le contenu frontal YAML d’un article Markdown :

---
title:                     # the article title to show on the browser tab
description:               # 115 - 145 character description to show in search results
author: {github-id}        # the author's GitHub ID - will be auto-populated if set in settings.json
ms.author: {ms-alias}      # the author's Microsoft alias (if applicable) - will be auto-populated if set in settings.json
ms.date: {@date}           # the date - will be auto-populated when template is first applied
ms.topic: getting-started  # the type of article
---
# Heading 1 <!-- the article title to show on the web page -->

Notes

Les attributs de métadonnées ms.prod et ms.technology sont mis hors service de la plateforme Learn. À compter de janvier 2024, les valeurs de ces taxonomies seront consolidées dans ms.service et ms.subservice pour la création de rapports sur le contenu par produit.

Métadonnées obligatoires

Le tableau suivant présente les attributs de métadonnées obligatoires. Si vous omettez l’une de ces clés, vous recevrez probablement une erreur de validation lors de la génération.

Champ Valeur Pourquoi ?
author ID du compte GitHub de l’auteur. Identifie l’auteur par son ID GitHub en cas de questions ou de problèmes concernant le contenu. Dans certains cas, l’automatisation GitHub peut notifier l’auteur d’une activité qui implique le fichier.
description Résumé du contenu. 75 à 300 caractères. Utilisé dans la recherche de site. Parfois utilisé dans une page de résultats de moteur de recherche pour améliorer le SEO.
ms.author Alias Microsoft de l’auteur, sans "@microsoft.com". Si vous n’êtes pas un employé de Microsoft, recherchez un employé Microsoft approprié à utiliser dans ce champ. Identifie le propriétaire de l’article. Le propriétaire est responsable des décisions concernant le contenu de l’article, ainsi que des rapports et du décisionnel relatifs à l’article.
ms.date Date au format JJ/MM/AAAA. S’affiche dans la page publiée pour indiquer la dernière fois qu’une modification importante a été apportée à l’article ou que celui-ci a été considéré comme étant à jour. La date est entrée sans heure. Par défaut, il est donc considéré qu’il était minuit heure UTC. La date affichée est convertie dans le fuseau horaire des utilisateurs.
ms.service ou
ms.prod
Identificateur du service ou du produit. Utilisez l’un ou l’autre, mais pas les deux. Cette valeur est souvent définie de manière globale dans le fichier docfx.json. Utilisé pour le triage des problèmes et la création de rapports.

ms.prod/ms.service est une distinction qui date de bien avant Microsoft Learn. L’objectif est d’éviter de confondre certains produits exécutés sur un ordinateur (en local) et les services cloud (qui en étaient à leurs balbutiements).
ms.topic En général, l’une des valeurs suivantes :

article, conceptual, contributor-guide, overview, quickstart, reference, sample, tutorial.
Identifie le type de contenu à des fins de création de rapports.
title Titre de la page. Il s’agit du titre de la page qui apparaît sur l’onglet du navigateur et qui constitue les métadonnées les plus importantes pour l’optimisation du référencement d’un site auprès d’un moteur de recherche (SEO).

Les attributs respectent la casse. Entrez-les exactement comme indiqué, puis utilisez un signe deux-points et un espace entre les attributs et la valeur. Si une valeur d’attribut inclut un signe deux-points (:), un hachage (#) ou tout autre caractère spécial, vous devez la placer entre guillemets simples (') ou doubles ("). Par exemple :

---
title: 'Quickstart: How to use hashtags (#) to make a point on the internet'
---
# Heading 1 <!-- the article title to show on the web page -->

Métadonnées facultatives

Outre les métadonnées obligatoires, il existe de nombreux attributs de métadonnées facultatifs que vous pouvez ajouter. Le tableau suivant en donne quelques exemples.

Champ Valeur Pourquoi ?
ms.custom Utilisation par l’auteur ou l’équipe uniquement.

Couramment utilisé pour le suivi de la documentation Docs ou des ensembles de contenu dans les outils de télémétrie. Il s’agit d’une valeur de chaîne unique qu’il revient à l’outil consommateur d’analyser. Exemple : ms.custom: "experiment1, content_reporting, all_uwp_docs, CI_Id=101022"

Limite de caractères : la longueur maximale de la valeur de chaîne est de 125 caractères.
ms.custom est un champ personnalisé que les auteurs peuvent utiliser pour suivre certains projets ou un sous-ensemble de contenu.
ms.reviewer Alias Microsoft d’une personne chargée de réviser le contenu.
ms.subservice Valeur plus spécifique qui peut être utilisée avec ms.service rendre les rapports plus précis sur le contenu d’un service. Utilisez uniquement ms.subservice si vous utilisez également ms.service. Seul, ms.subservice ne peut pas être considéré comme une métadonnée valide. L’auteur doit l’associer à une valeur ms.service parent. Cet attribut permet d’étudier en détail les rapports concernant un ms.service donné.
ms.technology Valeur plus spécifique qui peut être utilisée avec ms.prod rendre les rapports plus précis sur le contenu d’un produit. Utilisez uniquement ms.technology si vous utilisez également ms.prod. Seul, ms.technology ne peut pas être considéré comme une métadonnée valide. L’auteur doit l’associer à une valeur ms.prod parent. Cet attribut permet d’étudier en détail les rapports concernant un ms.prod donné.
ROBOTS NOINDEX, UNFOLLOW Utilisez ROBOTS dans votre section de métadonnées pour empêcher les processus de génération et de publication d’afficher du contenu dans les pages de recherche. Lorsque vous souhaitez utiliser ROBOTS (cela s’écrit tout en majuscules, même si ce n’est pas le cas des autres balises de métadonnées) :
- Ajoutez ROBOTS: NOINDEX à votre section de métadonnées.
- NOINDEX empêche l’affichage de la ressource dans les résultats de la recherche.
- Utilisez NOFOLLOW uniquement lorsque vous archivez l’intégralité d’un ensemble de contenu.
no-loc Liste des mots de cet article qui ne doivent jamais être traduits (localisés). Utilisez ces métadonnées pour empêcher la « surlocalisation ».

Voir aussi