Microsoft Learn 설명서의 메타데이터
Microsoft Learn의 메타데이터는 콘텐츠 분석 보고, 검색을 통한 콘텐츠 검색 가능성 및 사이트 환경의 측면을 구동하는 데 사용합니다. 메타데이터는 문서(YAML 전문)나 리포지토리의 docfx.json 파일에 전역적으로 적용할 수 있습니다.
기존 문서를 편집하는 경우 대개 메타데이터를 변경할 필요가 없습니다. 그러나 새 문서를 추가하는 경우 파일의 YAML 프런트 문제에 포함해야 하는 특정 필수 메타데이터 특성이 있습니다.
다음은 Markdown 문서의 YAML 전문에 적용된 메타데이터의 예입니다.
---
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월부터 이러한 분류의 값은 제품별 콘텐츠에 대한 보고를 위해 ms.service 및 ms.subservice로 통합됩니다.
다음 표에는 필요한 메타데이터 특성이 나와 있습니다. 다음 값 중에서 생략하는 값이 있으면 빌드 중에 유효성 검사 오류가 발생할 수 있습니다.
필드 | 값 | 이유는 무엇입니까? |
---|---|---|
author |
작성자의 GitHub 계정 ID입니다. | 콘텐츠에 대한 질문이나 문제가 있는 경우 작성자를 GitHub ID로 식별합니다. 경우에 따라 GitHub 자동화에서 작성자에게 파일과 관련된 활동에 대해 알릴 수 있습니다. |
description |
콘텐츠의 요약입니다. 75~300자입니다. | 사이트 검색에 사용됩니다. SEO 개선을 위해 검색 엔진 결과 페이지에서 사용되는 경우도 있습니다. |
ms.author |
"@microsoft.com"이 없는 작성자의 Microsoft 별칭입니다. Microsoft 직원이 아닌 경우 이 필드에 사용할 적절한 Microsoft 직원을 찾습니다. | 문서의 소유자를 식별합니다. 소유자는 문서의 콘텐츠에 대한 의사 결정과 문서의 보고 및 BI를 담당합니다. |
ms.date |
YYYY/MM/DD 형식의 날짜입니다. | 게시된 페이지에 표시되어 마지막으로 문서가 대폭 편집되었거나 확실히 새로 고침된 시간을 나타냅니다. 날짜는 시간 없이 입력되며 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.service 를 사용하는 경우에만 ms.subservice 를 사용하세요. |
ms.subservice 자체는 유효한 메타데이터가 아닙니다. 작성자는 이를 부모 ms.service 값과 연결해야 합니다. 이 특성은 지정된 ms.service 에 대해 보고에서 추가로 드릴다운하는 방법입니다. |
ms.technology |
제품에 대한 콘텐츠에 대한 보다 구체적인 보고를 사용하도록 설정하기 위해 함께 ms.prod 사용할 수 있는 보다 구체적인 값입니다. ms.prod 를 사용하는 경우에만 ms.technology 를 사용하세요. |
ms.technology 자체는 유효한 메타데이터가 아닙니다. 작성자는 이를 부모 ms.prod 값과 연결해야 합니다. 이 특성은 지정된 ms.prod 에 대해 보고에서 추가로 드릴다운하는 방법입니다. |
ROBOTS |
NOINDEX , UNFOLLOW |
빌드 및 게시 프로세스에서 검색 페이지에 콘텐츠를 표시하지 않도록 하려면 메타데이터 섹션에 ROBOTS를 사용합니다. ROBOTS 를 사용하려는 경우(다른 메타데이터 태그는 모두 대문자로 되어 있지 않지만, 이 태그는 모두 대문자로 되어 있음):- 메타데이터 섹션에 ROBOTS: NOINDEX 를 추가합니다.- NOINDEX 는 자산이 검색 결과에 표시되지 않도록 합니다.- 전체 콘텐츠 세트를 보관하는 경우에만 NOFOLLOW 를 사용합니다. |
no-loc |
번역(지역화)되지 않아야 하는 문서의 단어 목록입니다. | “과도한 지역화”를 방지하려면 이 메타데이터를 사용합니다. |