Skip to main content

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

여러 콘텐츠 형식 결합 정보

단일 문서에서 여러 콘텐츠 형식을 결합하여 복잡한 작업을 완료하는 데 도움이 될 수 있습니다.

복잡한 작업을 완료하거나, 관련 작업 집합을 이해하거나, 전체 워크플로를 설명하는 데 도움이 되도록 컨텍스트에서 정보를 그룹화하면 도움이 되는 경우가 있습니다. 콘텐츠 형식을 결합하는 긴 문서를 사용하여 사용자가 적절한 위치에서 문맥 콘텐츠를 찾을 수 있도록 하세요. 또한 긴 문서는 제품에 더 많은 옵션을 추가하므로 콘텐츠의 중복을 제거하고 크기를 조정할 콘텐츠를 준비하는 데 도움이 될 수 있습니다. 제품을 적극적으로 사용하는 동안 긴 문서가 필요한 경우가 많으며, 경험의 다른 지점에서 문서를 참조해야 할 수도 있습니다.

문서에서 여러 콘텐츠 형식을 결합하는 방법

  • 더 긴 문서에서 개념적, 절차적, 참조, 문제 해결 또는 알려진 이슈 콘텐츠를 사용하고, 빠른 시작 또는 자습서는 사용하지 마세요.
  • 필요에 따라 문서에서 다양한 콘텐츠 형식의 구역을 사용하고 콘텐츠 형식에 대한 제목 지침을 따릅니다.
  • 대부분의 경우 이러한 문서에는 하나 이상의 절차 구역과 하나 이상의 추가 개념, 참조 또는 절차 구역이 포함됩니다.
  • 콘텐츠 순서 지정 지침을 사용하여 문서 내에서 머리글을 구성합니다.
  • 가능한 한 자주 문제 해결 정보를 사용하세요.
  • 필요한 경우 머리글에서 문서 제목을 복제할 수 있습니다.

여러 콘텐츠 형식을 결합하는 문서에 관한 제목 지침

  • 문서 내에 절차가 있는 경우 동명사로 시작하는 작업 기반 제목을 사용하세요.
  • 제목은 문서에 포함된 정보 및 작업의 범위를 설명할 정도로 일반적입니다.
  • 제목은 설정이 전환되는 것을 설명하고, 예를 들어 ‘개인 리포지토리 공개 만들기’ 대신 ‘리포지토리 표시 유형 설정’과 같은 독자가 선택하는 설정에 대해 중립적이어야 합니다.

여러 콘텐츠 형식을 결합하는 문서의 예