เมตาดาต้าสําหรับเอกสาร Microsoft Learn
เราใช้เมตาดาต้าบน Microsoft Learn สําหรับการรายงานการวิเคราะห์เนื้อหา ความสามารถในการค้นหาเนื้อหาผ่านการค้นหา และขับเคลื่อนแง่มุมต่างๆ ของประสบการณ์การใช้งานไซต์ เมตาดาต้าสามารถนําไปใช้ในบทความ (ในส่วนสําคัญของ YAML) หรือส่วนกลางใน ไฟล์ docfx.json สําหรับที่เก็บ
ถ้าคุณกําลังทําการแก้ไขบทความที่มีอยู่ คุณอาจไม่จําเป็นต้องเปลี่ยนเมตาดาต้า อย่างไรก็ตาม ถ้าคุณกําลังเพิ่มบทความใหม่ มีแอตทริบิวต์เมตาดาต้าที่จําเป็นบางอย่างที่คุณจะต้องรวมไว้ในเรื่องด้านหน้า YAML ของไฟล์
นี่คือตัวอย่างของเมตาดาต้าที่ใช้ในบทความส่วนหน้า YAML ของ 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 -->
หมายเหตุ
แอตทริบิวต์เมตาดาต้าของเทคโนโลยี ms.prod และ ms.technology จะถูกยกเลิกจากแพลตฟอร์ม Learn เริ่มต้นในเดือนมกราคม 2024 ค่าใน taxonomies เหล่านี้จะถูกรวมเข้าไว้ใน ms.service และ ms.subservice สําหรับการรายงานเนื้อหาตามผลิตภัณฑ์
ตารางต่อไปนี้แสดงแอตทริบิวต์เมตาดาต้าที่จําเป็น ถ้าคุณไม่ใช้สิ่งเหล่านี้ คุณอาจได้รับข้อผิดพลาดการตรวจสอบความถูกต้องในระหว่างการสร้าง
ฟิลด์ | มูลค่า | เพราะเหตุใด |
---|---|---|
author |
รหัสบัญชี GitHub ของผู้เขียน | ระบุผู้เขียนโดย ID GitHub ในกรณีที่มีคําถามหรือปัญหาเกี่ยวกับเนื้อหา ในบางกรณี ระบบอัตโนมัติของ GitHub อาจแจ้งผู้เขียนกิจกรรมที่เกี่ยวข้องกับไฟล์ |
description |
ข้อมูลสรุปของเนื้อหา 75-300 ตัวอักษร | ใช้ในการค้นหาไซต์ บางครั้งใช้กับหน้าผลลัพธ์ของเครื่องมือค้นหาสําหรับ SEO ที่ปรับปรุงประสิทธิภาพแล้ว |
ms.author |
นามแฝง ของ Microsoft ของผู้เขียน โดยไม่มี "@microsoft.com" หากคุณไม่ใช่พนักงานของ Microsoft ให้ค้นหาพนักงาน Microsoft ที่เหมาะสมเพื่อใช้ในเขตข้อมูลนี้ | ระบุเจ้าของบทความ เจ้าของเป็นผู้รับผิดชอบในการตัดสินใจเกี่ยวกับเนื้อหาของบทความ และสําหรับการรายงานและ BI ของบทความ |
ms.date |
วันที่ในรูปแบบ ดด/วว/ปปปป | แสดงในหน้าเผยแพร่เพื่อระบุว่าบทความได้รับการแก้ไขหรือรับประกันความสดใหม่ครั้งล่าสุด วันที่จะถูกป้อนโดยไม่มีเวลาและจะถูกแปลเป็น 0:00 และในโซนเวลา UTC วันที่ที่แสดงต่อผู้ใช้จะถูกแปลงเป็นโซนเวลาของตน |
ms.service หรือ ms.prod |
ตัวระบุบริการหรือผลิตภัณฑ์ ใช้อย่างใดอย่างหนึ่ง ไม่ใช่ทั้งสองอย่าง ค่านี้มักจะถูกตั้งค่าส่วนกลางในไฟล์ docfx.json | ใช้สําหรับการตัดสินค้าจากคลังและการรายงาน ms.prod และ ms.service มีค่าที่แตกต่างกันที่ทําก่อน Microsoft Learn หมายถึงการแยกความแตกต่างระหว่างผลิตภัณฑ์เฉพาะที่เรียกใช้บนเครื่อง (ภายในเครื่อง) และบริการคลาวด์ (ก่อน) |
ms.topic |
โดยปกติแล้วจะเป็นหนึ่งในค่าต่อไปนี้:article , conceptual , contributor-guide , overview , , quickstart , reference , , sample tutorial |
ระบุชนิดของเนื้อหาสําหรับวัตถุประสงค์ในการรายงาน |
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.subservice เฉพาะถ้าคุณกําลังใช้ ms.service เท่านั้น |
ms.subservice โดยตัวมันเองไม่ใช่เมตาดาต้าที่ถูกต้อง ผู้เขียนต้องเชื่อมโยงกับค่าพาเรนต์ms.service แอตทริบิวต์นี้เป็นวิธีการดูรายละเอียดแนวลึกเพิ่มเติมในการรายงานสําหรับ ที่ระบุms.service |
ms.technology |
ค่าที่เฉพาะเจาะจงมากขึ้นที่สามารถนํามาใช้ร่วมกัน ms.prod เพื่อเปิดใช้งานการรายงานที่เฉพาะเจาะจงมากขึ้นเกี่ยวกับเนื้อหาเกี่ยวกับผลิตภัณฑ์ ใช้ ms.technology เฉพาะถ้าคุณกําลังใช้ ms.prod เท่านั้น |
ms.technology โดยตัวมันเองไม่ใช่เมตาดาต้าที่ถูกต้อง ผู้เขียนต้องเชื่อมโยงกับค่าพาเรนต์ms.prod แอตทริบิวต์นี้เป็นวิธีการดูรายละเอียดแนวลึกเพิ่มเติมในการรายงานสําหรับ ที่ระบุms.prod |
ROBOTS |
NOINDEX , UNFOLLOW |
ใช้ ROBOTS ในส่วนเมตาดาต้าของคุณเพื่อป้องกันไม่ให้กระบวนการสร้างและเผยแพร่แสดงเนื้อหาบนหน้าการค้นหา เมื่อคุณต้องการใช้ ROBOTS (และใช่ เป็นตัวพิมพ์ใหญ่ทั้งหมด แม้ว่าแท็กเมตาดาต้าอื่น ๆ จะไม่ใช้):- เพิ่ม ROBOTS: NOINDEX ไปยังส่วนเมตาดาต้าของคุณ- NOINDEX ทําให้แอสเซทไม่แสดงในผลลัพธ์การค้นหา- ใช้ NOFOLLOW เฉพาะเมื่อคุณเก็บชุดเนื้อหาทั้งหมด |
no-loc |
รายการของคําในบทความที่ไม่ควรแปล (แปลเป็นภาษาท้องถิ่น) | ใช้เมตาดาต้านี้เพื่อป้องกัน "การจัดสรรเกิน" |