Baca dalam bahasa Inggris

Bagikan melalui


Metadata untuk dokumentasi Microsoft Learn

Kami menggunakan metadata di Microsoft Learn untuk pelaporan analitik konten, ketercarian konten melalui pencarian, dan aspek pendorongan pengalaman situs. Metadata dapat diterapkan dalam artikel (dalam front matter YAML) atau secara global dalam file docfx.json untuk repositori.

Jika Anda membuat pengeditan ke artikel yang sudah ada, Anda mungkin tidak perlu mengubah metadata apa pun. Namun, jika Anda menambahkan artikel baru, ada atribut metadata tertentu yang diperlukan yang perlu Anda sertakan dalam front matter YAML file.

Berikut adalah contoh metadata yang diterapkan di front matter YAML dari artikel 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 -->

Catatan

Atribut metadata ms.prod dan ms.technology dihentikan dari platform Learn. Mulai Januari 2024, nilai dalam taksonomi ini akan dikonsolidasikan ke dalam ms.service dan ms.subservice untuk pelaporan konten berdasarkan produk.

Metadata yang diperlukan

Tabel berikut menunjukkan atribut metadata yang diperlukan. Jika Anda menghilangkan salah satu dari ini, Anda kemungkinan akan mendapatkan kesalahan validasi selama build.

Bidang Nilai Mengapa?
author ID akun GitHub penulis. Mengidentifikasi penulis dengan ID GitHub jika ada pertanyaan tentang atau masalah dengan konten. Dalam beberapa kasus, otomatisasi GitHub mungkin memberi tahu penulis aktivitas yang melibatkan file.
description Ringkasan konten. 75-300 karakter. Digunakan dalam pencarian situs. Terkadang digunakan pada halaman hasil mesin pencari untuk SEO yang ditingkatkan.
ms.author Alias Microsoft penulis, tanpa "@microsoft.com". Jika Anda bukan karyawan Microsoft, temukan karyawan Microsoft yang cocok untuk digunakan di bidang ini. Mengidentifikasi pemilik artikel. Pemilik bertanggung jawab atas keputusan tentang konten artikel, dan untuk pelaporan artikel dan BI.
ms.date Tanggal dalam format MM/DD/YYYY. Ditampilkan di halaman yang diterbitkan untuk menunjukkan terakhir kali artikel diedit secara substansial atau dijamin segar. Tanggal dimasukkan tanpa waktu dan ditafsirkan sebagai 0:00 dan di zona waktu UTC. Tanggal yang ditampilkan kepada pengguna dikonversi ke zona waktu mereka.
ms.serviceatau
ms.prod
Pengidentifikasi layanan atau produk. Gunakan satu atau yang lain, tidak pernah keduanya. Nilai ini sering diatur secara global dalam file docfx.json . Digunakan untuk triase dan pelaporan masalah.

ms.prod dan ms.service merupakan perbedaan yang dibuat yang mendahului Microsoft Learn, dimaksudkan untuk membedakan antara produk tertentu yang berjalan pada komputer (lokal) dan layanan cloud (awal).
ms.topic Biasanya salah satu nilai berikut:

article, , contributor-guideconceptual, overview, quickstart, reference, sample, . tutorial
Mengidentifikasi jenis konten untuk tujuan pelaporan.
title Judul halaman. Ini adalah judul halaman yang ditampilkan di tab browser. Ini adalah metadata terpenting untuk SEO.

Atribut peka huruf besar/kecil. Masukkan persis seperti yang tercantum, dan gunakan titik dua dan spasi antara atribut dan nilai. Jika nilai atribut menyertakan titik dua (:), hash (#), atau karakter khusus lainnya, Anda harus mengapitnya baik tanda kutip tunggal (') atau ganda ("). Contohnya:

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

Metadata opsional

Selain metadata yang diperlukan, ada banyak atribut metadata opsional yang dapat Anda tambahkan. Tabel berikut ini memperlihatkan beberapa atribut metadata opsional.

Bidang Nilai Mengapa?
ms.custom Hanya untuk penulis atau tim.

Umumnya digunakan untuk melacak dokumen atau set konten tertentu dalam alat telemetri. Ini adalah nilai string tunggal, dan terserah alat yang mengonsumsi untuk mengurainya. Contoh: ms.custom: "experiment1, content_reporting, all_uwp_docs, CI_Id=101022"

Batas karakter: Panjang nilai string maksimum adalah 125 karakter.
ms.custom adalah bidang kustom yang dapat digunakan penulis untuk melacak proyek khusus atau subset konten.
ms.reviewer Alias Microsoft seseorang yang meninjau konten.
ms.subservice Nilai yang lebih spesifik yang dapat digunakan untuk ms.service mengaktifkan pelaporan yang lebih spesifik tentang konten tentang layanan. Hanya gunakan ms.subservice jika Anda juga menggunakan ms.service. ms.subservice dengan sendirinya bukan metadata yang valid. Penulis harus mengaitkannya dengan nilai induk ms.service . Atribut ini adalah cara untuk menelusuri lebih jauh dalam pelaporan untuk tertentu ms.service.
ms.technology Nilai yang lebih spesifik yang dapat digunakan bersama untuk ms.prod mengaktifkan pelaporan yang lebih spesifik tentang konten tentang produk. Hanya gunakan ms.technology jika Anda juga menggunakan ms.prod. ms.technology dengan sendirinya bukan metadata yang valid. Penulis harus mengaitkannya dengan nilai induk ms.prod . Atribut ini adalah cara untuk menelusuri lebih jauh dalam pelaporan untuk tertentu ms.prod.
ROBOTS NOINDEX, UNFOLLOW Gunakan ROBOT di bagian metadata Anda untuk mencegah proses build dan penerbitan menampilkan konten di halaman pencarian. Ketika Anda ingin menggunakan ROBOTS (dan ya, semuanya dikapitalisasi, meskipun tag metadata lain tidak):
- Tambahkan ROBOTS: NOINDEX ke bagian metadata Anda.
- NOINDEX menyebabkan aset tidak muncul di hasil pencarian.
- Gunakan NOFOLLOW hanya ketika Anda mengarsipkan seluruh kumpulan konten.
no-loc Daftar kata dalam artikel yang tidak boleh diterjemahkan (dilokalkan). Gunakan metadata ini untuk mencegah "overlocalization."

Lihat juga