Skip to main content

Enterprise Server 3.23 은(는) 현재 릴리스 후보로 제공됩니다.

Skip to content

시작 콘텐츠 형식

시작 콘텐츠는 제품 또는 기능을 사용하기 위한 최소한의 필수 정보를 제공합니다.

시작 콘텐츠는 GitHub 제품 및 기능 사용에 대한 진입점을 제공합니다. 이 섹션에는 개념 및 방법으로 넘어가기 전에 사용자에게 필요한 최소 필수 정보만 포함되어야 합니다. 간결하게 하기 위해 이 작업을 수행하므로 기능을 시작하는 것만으로는 복잡해 보이지 않습니다.

시작하기 전 고려 사항

시작은 쉽고 빠르게 훑어볼 수 있어야 하는 문서 모음입니다. 5개 미만의 아티클을 포함해야 하며 이상적으로는 두 개만 포함해야 합니다.

  • Quickstart
  • [PRODUCT] 정보(또는 "[PRODUCT]란?")

이에 대한 한 가지 예외는 제품 또는 기능을 사용하는 데 이러한 정보가 필요한 사용 가능한 플랜 및 청구 정보일 수 있습니다.

빠른 시작 콘텐츠에 대한 자세한 내용은 빠른 시작 콘텐츠 형식을 참조하세요.

특히 이러한 정보가 포함된 문서는 Get started에 포함되어서는 안 됩니다:

  • 방법 콘텐츠 형식에 속하는 문서입니다.
  • 설정 또는 가입 절차: 이 역시 사용 방법 안내입니다. UI에서 작업을 수행하는 방법을 문서화합니다.
  • 전체 제품 영역이 아닌 특정 기능을 시작하는 데 유용한 콘텐츠입니다. 이러한 종류의 콘텐츠는 개념에 더 적절하게 속합니다.
  • 모범 사례, 일반적으로. 기능을 접하는 사용자에게는 이러한 기능을 최대한 활용하는 데 필요한 컨텍스트가 부족합니다.