개념 콘텐츠는 명확하고 높은 수준의 개요, 기능 또는 토픽이 경험에 도움이 되는 방법에 대한 설명, 사용 사례 또는 예시와 같은 컨텍스트를 제공하여 기능 또는 토픽을 이해하는 데 도움이 됩니다.
다른 문서 내에서 개념 문서 및 개념 섹션을 만듭니다. 대부분의 주요 제품, 기능 또는 주체에는 고유한 개념 문서가 있습니다.
아티클 또는 섹션 중에서 결정
방법 또는 자습서는 단계 전에 1-2개의 간단한 소개 문장을 가질 수 있습니다. 두세 문장 이상의 설명이 필요하다면 그 내용을 개념 문서에 포함할 만한지 고려해야 합니다.
그러나 우리는 선택적이어야 합니다. 모든 개념 또는 "X 정보" 섹션에 자체 문서가 필요한 것은 아닙니다. 일반적으로 이는 포함해야 하는 사용자에게 얼마나 많은 정보가 유용한지에 달려 있습니다.
개념 콘텐츠 작성 방법
개념적 콘텐츠 템플릿은 템플릿을(를) 참조하세요.
- 기능, 제품 또는 토픽이 무엇인지 쉬운 언어로 설명하세요.
- 해당 목적과 독자에게 유용한 이유를 설명하세요.
- 사용 사례 또는 예시를 공유하세요.
개념적 콘텐츠의 제목
문서의 짧은 제목은 한 단어 또는 명사 구여야 합니다. 문서가 사이드바의 개념 아래에 표시되는 경우에는 해당 문서가 같은 이름의 제목 아래에 있는 경우가 아니면 "정보"를 사용하지 마세요. 예: "코딩 에이전트" 및 "코딩 에이전트 소개".
문서의 개념 섹션 머리글은 "정보 [제목]"으로 시작합니다.
- 명사로 주체를 설명하세요.
- 사용: "정보 code scanning"
- ‘코드의 취약성 검사를 피하세요’
개념적 콘텐츠의 예시
- 개념 문서
- 다른 문서 내의 개념 섹션
- Adding a security policy to your repository(리포지토리에 보안 정책 추가)의 ‘보안 정책 정보’
- 유지 관리 모드 사용 설정 및 예약의 ‘유지 관리 모드의 정보’