Auf Englisch lesen

Freigeben über


Metadaten für Microsoft Learn-Dokumentation

Wir verwenden Metadaten auf Microsoft Learn für die Erstellung von Berichten zur Inhaltsanalyse, zur Auffindbarkeit von Inhalten über die Suche und zur Steuerung von Aspekten der Website-Erfahrung. Metadaten können im Artikel (im YAML-Front-Matter-Block) oder global in der Datei docfx.json des Repositorys angewendet werden.

Wenn Sie einen vorhandenen Artikel bearbeiten, müssen Sie wahrscheinlich keine Metadaten ändern. Wenn Sie jedoch einen neuen Artikel hinzufügen, sind bestimmte Metadaten-Attribute erforderlich, die Sie in den YAML-Front-Matter-Block der Datei einfügen müssen.

Hier sehen Sie ein Beispiel für Metadaten, die im YAML-Front-Matter eines Markdownartikels angewendet werden:

---
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 -->

Hinweis

Die Metadatenattribute ms.prod und ms.technology werden von der Learn-Plattform zurückgezogen. Ab Januar 2024 werden Werte in diesen Taxonomien in ms.service und ms.subservice für die Berichte über Inhalte nach Produkt konsolidiert.

Erforderliche Metadaten

In der folgenden Tabelle werden die erforderlichen Metadaten-Attribute aufgeführt. Wenn Sie einen dieser Schlüssel weglassen, tritt während des Builds wahrscheinlich ein Validierungsfehler auf.

Feld Wert Warum?
author Die GitHub-Konto-ID des Autors Der Autor kann anhand der GitHub-ID ermittelt werden, falls Fragen zum Inhalt aufkommen oder inhaltliche Probleme vorliegen. In einigen Fällen benachrichtigt die GitHub-Automatisierung den Autor über Aktivitäten im Zusammenhang mit der Datei.
description Eine Zusammenfassung des Inhalts (75–300 Zeichen) Wird beim Durchsuchen der Website und manchmal auf der Ergebnisseite einer Suchmaschine zur Suchmaschinenoptimierung verwendet
ms.author Der Microsoft-Alias des Autors ohne „@microsoft.com“. Wenn Sie kein Microsoft-Mitarbeiter sind, suchen Sie einen geeigneten Microsoft-Mitarbeiter, dessen Alias in diesem Feld verwendet werden kann. Hiermit wird der Besitzer des Artikels kenntlich gemacht. Der Besitzer ist für Entscheidungen über den Inhalt des Artikels sowie für die Berichterstellung und die BI des Artikels verantwortlich.
ms.date Ein Datum im Format MM/TT/JJJJ. Dieses Datum wird auf der veröffentlichten Seite angezeigt, um kenntlich zu machen, wann der Artikel zuletzt wesentlich überarbeitet wurde oder um dessen Aktualität zu garantieren. Das Datum wird ohne Uhrzeit eingegeben und als 0:00 Uhr in der Zeitzone UTC (koordinierte Weltzeit) interpretiert. Das den Benutzern angezeigte Datum wird in die jeweilige Zeitzone konvertiert.
ms.service oder
ms.prod
Der Dienst- oder Produktbezeichner – verwenden Sie nur eine der beiden Optionen, niemals beide. Dieser Wert wird häufig global in der Datei docfx.json festgelegt. Dieser Wert wird für die Selektierung und Berichterstellung verwendet.

ms.prod und ms.service sind Unterscheidungen, die noch aus der Zeit vor Microsoft Learn stammen und die zwischen bestimmten Produkten, die auf einem Computer (on-prem) ausgeführt werden, und die (frühen) Cloud-Dienste unterscheiden sollen.
ms.topic In der Regel wird einer der folgenden Werte verwendet:

article, conceptual, contributor-guide, overview, quickstart, reference, sample, tutorial.
Ermittelt den Inhaltstyp für Berichterstellungszwecke
title Der Seitentitel Dies ist der Seitentitel, der auf der Browserregisterkarte angezeigt wird. Dies sind die wichtigsten Metadaten für SEO.

Bei Attributen wird die Groß-/Kleinschreibung beachtet. Geben Sie sie genau wie aufgeführt ein, und verwenden Sie einen Doppelpunkt und ein Leerzeichen zwischen den Attributen und dem Wert. Wenn ein Attributwert einen Doppelpunkt (:), einen Hash (#) oder ein anderes Sonderzeichen enthält, müssen Sie ihn entweder in einfache (') oder doppelte Anführungszeichen (") einschließen. Zum Beispiel:

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

Optionale Metadaten

Zusätzlich zu den erforderlichen Metadaten gibt es viele optionale Metadaten-Attribute, die Sie angeben können. Die folgende Tabelle zeigt einige der optionalen Metadaten-Attribute.

Feld Wert Warum?
ms.custom Nur für die Verwendung durch Autoren oder Teams

Dieser Wert wird üblicherweise für die Nachverfolgung bestimmter Dokumentationsseiten oder Inhalte in Telemetrietools verwendet. Es ist ein einzelner Zeichenfolgenwert, der von dem Tool analysiert werden muss, das ihn nutzt. Beispiel: ms.custom: "experiment1, content_reporting, all_uwp_docs, CI_Id=101022"

Zeichenlimit: Die maximale Länge für Zeichenfolgenwerte beträgt 125 Zeichen.
ms.custom ist ein benutzerdefiniertes Feld, mit dem Autoren bestimmte Projekte oder eine Teilmenge des Inhalts nachverfolgen können.
ms.reviewer Der Microsoft-Alias einer Person, die den Inhalt überprüft.
ms.subservice Ein spezifischerer Wert, der mit ms.service verwendet werden kann, um spezifischere Berichte über Inhalte zu einem Dienst zu erstellen. verwenden Sie ms.subservice nur, wenn Sie auch ms.service verwenden. ms.subservice allein ist kein gültiges Metadatentag. Der Autor muss auch den übergeordneten Wert ms.service angeben. Dieses Attribut ist eine Möglichkeit, einen Drilldown in der Berichterstellung für einen mit ms.service angegebenen Dienst durchzuführen.
ms.technology Ein spezifischerer Wert, der zusammen mit ms.prod verwendet werden kann, um eine spezifischere Berichterstattung über Inhalte zu einem Produkt zu ermöglichen. verwenden Sie ms.technology nur, wenn Sie auch ms.prod verwenden. ms.technology allein ist kein gültiges Metadatentag. Der Autor muss auch den übergeordneten Wert ms.prod angeben. Dieses Attribut ist eine Möglichkeit, einen Drilldown in der Berichterstellung für einen mit ms.prod angegebenen Dienst durchzuführen.
ROBOTS NOINDEX, UNFOLLOW Verwenden Sie ROBOTS im Metadatenbereich, damit der Build- und Veröffentlichungsprozess keine Inhalte auf Suchseiten anzeigt. So verwenden Sie ROBOTS (in Großbuchstaben, auch wenn das für Metadatentags unüblich ist):
– Fügen Sie ROBOTS: NOINDEX zum Metadatenbereich hinzu.
– Durch NOINDEX wird die Ressource nicht in den Suchergebnissen angezeigt.
– Verwenden Sie NOFOLLOW nur, wenn Sie den gesamten Inhalt archivieren.
no-loc Eine Liste der Wörter im Artikel, die unter keinen Umständen übersetzt (lokalisiert) werden sollen Verwenden Sie diese Metadaten, um eine Überlokalisierung zu verhindern.

Siehe auch