Microsoft Learn ドキュメントのメタデータ
コンテンツ分析レポート作成のために、また検索によるコンテンツの検出可能性およびサイト エクスペリエンスのさまざまな局面の推進のために、Microsoft Learn 上のメタデータを使用しています。 メタデータは、記事内 (YAML front matter 内) に適用することも、リポジトリの docfx.json ファイル内にグローバルに適用することもできます。
既存の記事を編集する場合、メタデータを変更する必要はおそらくないでしょう。 ただし、新しい記事を追加する場合は、特定の必須メタデータ属性をファイルの YAML フロント マターに含める必要があります。
Markdown 記事の YAML front matter で適用されるメタデータの例を次に示します。
---
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 -->
注意
ms.prod および ms.technology メタデータ属性は、Learn プラットフォームから廃止されます。 2024 年 1 月から、これらの分類のVALUEが ms.service と ms.subservice に統合され、製品別の内容に関するレポートが作成されます。
次の表に、必須メタデータ属性を示します。 これらのどれを省略しても、ビルド中に検証エラーが発生する可能性があります。
フィールド | 値 | なぜですか? |
---|---|---|
author |
作成者の GitHub アカウント ID。 | コンテンツに関して質問または問題がある場合に、GitHub ID で作成者を識別します。 場合によっては、ファイルを必要とするアクティビティが GitHub オートメーションによって作成者に通知されます。 |
description |
コンテンツの概要。 75 から 300 文字。 | サイト検索で使用されます。 SEO の改善を目的として、検索エンジンの結果ページで使用される場合があります。 |
ms.author |
"@microsoft.com" を "含まない" 作成者の Microsoft エイリアス。 自分が Microsoft の従業員でない場合は、このフィールドで使用する適切な Microsoft の従業員を見つける必要があります。 | 記事の所有者を識別します。 所有者は、記事のコンテンツに関する決定と、記事のレポートおよび BI について責任があります。 |
ms.date |
MM/DD/YYYY 形式の日付です。 | 公開済みページに表示される日付です。前回、記事が大幅に編集されたか、"最新" であることが保証された日付を示します。 日付は時刻なしで入力され、0:00 として UTC タイム ゾーンで解釈されます。 ユーザーに表示される日付は、該当するタイム ゾーンに変換されます。 |
ms.service または ms.prod |
サービスまたは製品の識別子。 どちらか一方を使用し、両方一緒に使用しないでください。 多くの場合、この値は docfx.json ファイル内にグローバルに設定されます。 | 問題のトリアージとレポートに使用されます。 ms.prod と ms.service は、Microsoft Learn より前に作成された区別であり、マシン (オンプレミス) と (早期) クラウド サービスで実行される特定の製品を区別することを目的としています。 |
ms.topic |
通常は次の値のいずれかです。 |
レポートを目的としてコンテンツの種類を識別します。 |
title |
ページのタイトル。 | これは、ブラウザー タブに表示されるページ タイトルです。これは SEO の最も重要なメタデータです。 |
属性では大文字と小文字が区別されます。 表示されているとおりに入力し、属性と値の間にコロンとスペースを使用します。 属性の値にコロン (:)、ハッシュ (#)、または他の特殊文字が含まれる場合は、単一引用符 (') または二重引用符 (") で値を囲む必要があります。 次に例を示します。
---
title: 'Quickstart: How to use hashtags (#) to make a point on the internet'
---
# Heading 1 <!-- the article title to show on the web page -->
必須メタデータに加えて、追加することができる省略可能なメタデータ属性が多数あります。 次の表に、省略可能なメタデータ属性の一部を示します。
フィールド | 値 | なぜですか? |
---|---|---|
ms.custom |
ライターまたはチーム専用。 テレメトリ ツールで特定のドキュメントまたはコンテンツ セットを追跡するために一般的に使用されます。 これは単一の文字列値であり、それを解析するのは消費ツールの役割です。 例: ms.custom: "experiment1, content_reporting, all_uwp_docs, CI_Id=101022" 文字制限: 文字列値の最大長は 125 文字です。 |
ms.custom は、ライターが特殊なプロジェクトまたはコンテンツのサブセットを追跡するのに使用できるカスタム フィールドです。 |
ms.reviewer |
コンテンツをレビューするユーザーの Microsoft エイリアス。 | |
ms.subservice |
サービスに関するコンテンツのより具体的なレポートを可能にするために ms.service とともに使用できる、より具体的な値。 ユーザーも ms.service を使用している場合にのみ ms.subservice を使用します。 |
ms.subservice 自体は有効なメタデータではありません。 作成者は、それを親の ms.service 値に関連付ける必要があります。 この属性は、特定の ms.service についてレポートする際にさらにドリルダウンする方法です。 |
ms.technology |
製品に関するコンテンツにのより具体的なレポートを可能にするために ms.prod とともに使用できる、より具体的な値。 ユーザーも ms.prod を使用している場合にのみ ms.technology を使用します。 |
ms.technology 自体は有効なメタデータではありません。 作成者は、それを親の ms.prod 値に関連付ける必要があります。 この属性は、特定の ms.prod についてレポートする際にさらにドリルダウンする方法です。 |
ROBOTS |
$ | メタデータ セクションで ROBOTS を使用すると、ビルドおよび発行プロセスによって検索ページ上にコンテンツを表示できなくなります。 ROBOTS を使用する場合 (他のメタデータ タグがそうでなくても、これはすべて大文字で表示されます):- ROBOTS: NOINDEX をご利用のメタデータ セクションに追加します。- NOINDEX により、検索結果に資産は表示されません。- コンテンツ セット全体をアーカイブする場合にのみ NOFOLLOW を使用します。 |
no-loc |
翻訳 (ローカライズ) すべきではない記事内の単語の一覧。 | "オーバーローカライゼーション" を防ぐには、このメタデータを使用します。 |