Skip to main content

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

빠른 시작 콘텐츠 형식

빠른 시작은 작동 방식이나 사용하려는 이유에 대한 긴 설명 없이 신속하게 지침을 원하는 사용자에게 가장 좋습니다.

빠른 시작을 사용하면 필수 단계만 있는 워크플로를 약 오 분 내에 또는 600 단어로 보여 줌으로써 신속하게 별개의 중요한 작업을 완료할 수 있습니다. 빠른 시작은 새로운 도구를 사용하여 빠르게 설정하거나, 다른 작업을 빠르게 완료하는 데 사용할 수 있습니다. 더 복잡한 작업에는 튜토리얼을 사용하세요.

빠른 시작은 이미 기능 또는 제품을 이해하고 있으며 사용해 볼 준비가 된 경우에 유용합니다.

우리 사이트에서는 튜토리얼과 빠른 시작을 "가이드"라고 합니다. /guides 방문 페이지에 있는 문서 집합의 가이드 목록에는 튜토리얼, 빠른 시작 및 특정 절차에 대한 문서가 포함되어 있습니다.

빠른 시작 작성 방법

빠른 시작 템플릿은 "템플릿"을(를) 참조하세요.

빠른 시작의 내용:

  • 소개:
    • 다음과 같은 표현을 사용하여 해당 가이드가 빠르고 간결하다는 것을 강조합니다.
      • 프로젝트에 [FEATURE]을(를) 빠르게 추가
      • [PRODUCT]을(를) 시작하기 위한 필수 요소
      • [FEATURE]에 익숙한 사용자를 위한 약어 가이드
    • 대상 그룹을 명확히 합니다.
    • 선행 조건 및 필요한 사전 지식을 확실히 명시합니다.
    • 사용자가 달성 또는 만들 수 있는 것을 명시합니다.
  • 절차에 대한 섹션
    • 빠른 시작의 대상 그룹에 따라 단계가 절차 콘텐츠에 사용되는 단계보다 덜 명시적이고 덜 공식적일 수 있습니다. 대상 그룹이 해당 수준의 세부 정보가 필요하지 않은 경우 기존의 재사용 가능한 문자열을 사용하여 단계를 구성할 필요가 없습니다.
    • 복제하는 대신 다른 문서 또는 리소스에 연결하여 정보의 흐름을 방해하지 않도록 하세요.
    • 시각적 신호를 제공합니다. 코드 블록 및 스크린샷을 많이 사용하여 사용자가 올바른 작업을 수행하고 있음을 알립니다.
  • 문제 해결 (선택 사항)
    • 해당하는 빠른 시작과 관련된 문제 해결 콘텐츠가 있는 경우 해당 콘텐츠에 대한 링크를 제공하세요.
  • 다음 단계
    • 빠른 시작에서 수행된 작업을 요약해서 다음 단계로 전환하는 수단으로 제공하세요.
    • 빠른 시작을 완료한 후 사용자가 수행할 수 있는 2~3개의 실행 가능한 다음 단계를 제시하세요. 언제나 기능 또는 제품의 개념적 콘텐츠에 연결하세요. docs.github.com 또는 GitHub Skills의 다른 관련 정보에 연결할 수도 있습니다.

빠른 시작에 대한 제목 지침

  • 사용자가 새 도구를 시작하는 데 해당 가이드가 도움이 되는 경우, 제목에 ‘빠른 시작’을 포함하세요 (예: ‘GitHub Actions 빠른 시작’ 또는 ‘빠른 시작: 절차 제목’).
  • 다른 사용 사례의 경우, 절차에 대한 제목 지침을 따르고 ‘빠른 시작’이라는 단어를 생략하세요.

빠른 시작의 예시