Lue englanniksi

Jaa


Microsoft Learn -dokumentaation metatiedot

Käytämme Microsoft Learnin metatietoja sisältöanalyysin raportointiin, sisällön löydettävyyteen haun kautta ja sivustokokemuksen ohjautumiseen. Metatietoja voidaan käyttää artikkelissa (YAML-etuosassa) tai yleisesti säilön docfx.json tiedostossa.

Jos teet muokkauksen aiemmin luotuun artikkeliin, sinun ei todennäköisesti tarvitse muuttaa metatietoja. Jos kuitenkin lisäät uuden artikkelin, tietyt pakolliset metatietomääritteet on sisällytettävä tiedoston YAML-etuasiaan.

Tässä on esimerkki metatiedoista, joita käytetään Markdown-artikkelin YAML-etuosassa:

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

Huomautus

Ms.prod- ja ms.technology-metatietomääritteet poistetaan käytöstä Learn-ympäristöstä. Tammikuusta 2024 alkaen näiden taksonomien arvot yhdistetään ms.serviceen ja ms.subserviceen, jos haluat raportoida sisällöstä tuotteittain.

Pakolliset metatiedot

Seuraavassa taulukossa näkyvät vaaditut metatietomääritteet. Jos poistat jonkin näistä, saat todennäköisesti vahvistusvirheen koontiversiossa.

Kenttä Arvo Miksi?
author Tekijän GitHub-tilin tunnus. Tunnistaa tekijän GitHub-tunnuksen perusteella siltä varalta, että sisällössä on kysymyksiä tai ongelmia. Joissakin tapauksissa GitHub-automaatio saattaa ilmoittaa tekijälle tiedostoon liittyvästä toiminnasta.
description Yhteenveto sisällöstä. 75–300 merkkiä. Käytetään sivuston haussa. Käytetään joskus hakukoneiden tulossivulla parannetun hakukoneiden hakutulosten parantamiseksi.
ms.author Tekijän Microsoft-alias ilman merkkiä @microsoft.com. Jos et ole Microsoftin työntekijä, etsi sopiva Microsoftin työntekijä, jota voit käyttää tässä kentässä. Määrittää artikkelin omistajan. Omistaja on vastuussa artikkelin sisältöä koskevista päätöksistä sekä artikkelin raportoinnista ja BI:stä.
ms.date Päivämäärä muodossa KK/PP/VVVV. Julkaistulla sivulla näkyy ilmoitus siitä, milloin artikkelia on viimeksi muokattu tai taattu tuoreena. Päivämäärä syötetään ilman aikaa, ja se tulkitaan 0:00 ja UTC-aikavyöhykkeellä. Käyttäjille näytettävä päivämäärä muunnetaan heidän aikavyöhykkeekseen.
ms.servicetai
ms.prod
Palvelu- tai tuotetunniste. Käytä jompaakumpaa, ei koskaan molempia. Tämä arvo määritetään usein yleisesti docfx.json tiedostossa. Käytetään ongelman triage- ja raportointiin.

ms.prod ja ms.service ovat erotteluja, jotka edeltävät Microsoft Learnia ja joiden tarkoituksena on erottaa tietokoneessa suoritettavat (paikalliset) tuotteet ja (varhaiset) pilvipalvelut.
ms.topic Yleensä jokin seuraavista arvoista:

article, conceptual, contributor-guide, overview, quickstartreference, , sample, tutorial.
Määrittää raportoinnissa käytettävän sisällön tyypin.
title Sivun otsikko. Tämä on sivun otsikko, joka näkyy selainvälilehdellä. Se on sekvenssin tärkeimmät metatiedot.

Määritteissä kirjainkoko on merkitsevä. Anna ne täsmälleen luettelon mukaisesti ja käytä kaksoispistettä ja välilyöntiä määritteiden ja arvon välissä. Jos määritearvo sisältää kaksoispisteen (:), ristikkomerkin (#) tai minkä tahansa muun erikoismerkin, se on kirjoitettava joko yksittäismerkkiin (') tai kaksinkertaisiin lainausmerkkeisiin ("). Esimerkkejä:

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

Valinnaiset metatiedot

Tarvittavien metatietojen lisäksi voit lisätä useita valinnaisia metatietomääritteitä. Seuraavassa taulukossa on joitakin valinnaisia metatietomääritteitä.

Kenttä Arvo Miksi?
ms.custom Vain kirjoittajan tai ryhmän käyttöön.

Käytetään yleisesti tiettyjen asiakirjojen tai sisältöjoukkojen seurantaan telemetriatyökaluissa. Kyseessä on yksittäinen merkkijonoarvo, ja kulutustyökalun on jäsennttävä se. Esimerkki: ms.custom: "experiment1, content_reporting, all_uwp_docs, CI_Id=101022"

Merkkirajoitus: Merkkijonon enimmäispituus on 125 merkkiä.
ms.custom on mukautettu kenttä, jonka avulla kirjoittajat voivat seurata erikoisprojekteja tai sisällön alijoukkoa.
ms.reviewer Sisällön arvioivan henkilön Microsoft-alias.
ms.subservice Tarkempi arvo, jonka kanssa ms.service voidaan ottaa käyttöön tarkempi raportointi palvelussa olevasta sisällöstä. Käytä vain ms.subservice , jos käytössäsi ms.serviceon myös . ms.subservice Yksinään eivät ole kelvollisia metatietoja. Tekijän on yhdistettävä se pääarvoon ms.service . Tämän määritteen avulla voidaan porautua alaspäin tietyn ms.service-määritteen raportoinnissa.
ms.technology Tarkempi arvo, jota voidaan käyttää yhdessä sen kanssa ms.prod , jotta tuotteesta voi raportoida sisältöä tarkemmin. Käytä vain ms.technology , jos käytössäsi ms.prodon myös . ms.technology Yksinään eivät ole kelvollisia metatietoja. Tekijän on yhdistettävä se pääarvoon ms.prod . Tämän määritteen avulla voidaan porautua alaspäin tietyn ms.prod-määritteen raportoinnissa.
ROBOTS NOINDEX, UNFOLLOW ROBOTS-funktion käyttäminen metatieto-osiossa estää koonti- ja julkaisuprosessia näyttämästä sisältöä hakusivuilla. Kun haluat käyttää ( ROBOTS ja kyllä, kaikki on isolla alkukirjaimella, vaikka muut metatietotunnisteet eivät ole):
– Lisää ROBOTS: NOINDEX metatieto-osioon.
- NOINDEX jolloin resurssi ei näy hakutuloksissa.
- Käytä NOFOLLOW vain, kun arkistoit koko sisältöjoukon.
no-loc Artikkelien sanaluettelo, jota ei tule koskaan kääntää (lokalisoida). Estä "ylilokalisointi" näiden metatietojen avulla.

Katso myös