이 버전의 GitHub Enterprise는 다음 날짜에 중단되었습니다. 2024-09-25. 중요한 보안 문제에 대해서도 패치 릴리스가 이루어지지 않습니다. 더 뛰어난 성능, 향상된 보안, 새로운 기능을 위해 최신 버전의 GitHub Enterprise Server로 업그레이드합니다. 업그레이드에 대한 도움말은 GitHub Enterprise 지원에 문의하세요.

참조 콘텐츠 형식

참조 콘텐츠는 기능을 적극적으로 사용하는 동안 필요로 하는 자세한 정보를 제공합니다.

이 문서의 내용

다른 문서 내에서 참조 문서 및 참조 구역을 만듭니다.

  • 특히 GitHub Actions의 검색 구문 또는 YAML 구문과 같은 많은 양의 참조 콘텐츠가 있는 경우, 일부 주요 주체에는 자체 참조 문서가 필요할 수 있습니다.
  • 기능의 지원되는 언어 또는 하드웨어 요구 사항 목록과 같은 더 적은 양의 콘텐츠 또는 보다 구체적인 정보의 경우 절차 또는 개념 문서 내의 컨텍스트에서 참조 구역을 사용하세요.

참조 콘텐츠 작성 방법

참조 콘텐츠 템플릿은 ‘템플릿’을(를) 참조하세요.

  • 문장 또는 전체 개념 구역을 작성하여 참조 콘텐츠를 소개하세요.
  • 실제 참조 콘텐츠를 명확하고 일관되게 표시하세요.
  • 설명할 단일 요소가 있는 주체의 경우 목록을 사용하세요.
  • 설명할 요소가 여러 가지 있는 주체의 경우 표를 사용하세요.
  • 워크플로에 대한 YAML 구문과 같은 더 긴 참조 콘텐츠의 경우 머리글을 일관되게 사용하세요.

참조 콘텐츠 제목

  • 참조 구역의 참조 문서 또는 머리글은 구역의 내용을 명확하게 설명하고 일반적으로 명사로 시작하세요.
  • 제목에는 초보 사용자가 액세스할 수 있는 충분한 정보가 포함되어 있으며 각 구역의 내용을 완전히 설명하세요.
  • 제목은 겹친 명사를 쓰지 말고, 전치사로 긴 명사 문자열을 분리하세요.

참조 콘텐츠의 예시