방법 콘텐츠 유형

방법 설명에는 제품을 사용하여 GitHub 작업을 수행하는 방법을 설명하는 번호가 매겨진 단계가 포함되어 있습니다. 일반적으로 GitHub를 최대한 활용하기 위해 필요합니다.

방법 문서에서는 작업을 완료하기 위한 최소 필수 단계에 중점을 두고 있습니다. 필수 구성 요소(특히 개념 또는 참조) 또는 다음 단계(특히 자습서)로 다른 콘텐츠 형식에 연결할 수 있습니다. 연결 전략에 따라 명시적으로 유용하고 필요한 경우에만 사용해야 합니다.

일반적으로 단계 전에 1-2 간단한 입문 문장을 포함합니다. 몇 가지 문장을 초과하는 추가 설명이 필요한 경우 개념 문서로 대신 정보를 추가하는 것이 좋습니다.

문제 해결은 자체 콘텐츠 형식이지만 방법 문서에는 사용자가 작업을 완료하는 데 도움이 되는 짧은 문제 해결 섹션이 포함될 수 있습니다.

사용 설명 문서의 제목

아티클 내의 방법 문서에서 제목과 섹션은 작업 기반이고 동명사로 시작됩니다.

사용: "학생 개발자 팩 신청" 활성 및 특정 동사를 사용합니다(브레인스토밍 또는 필요한 경우 동의어 사전 사용). 제목은 특히 문서 또는 머리글에 포함된 작업을 설명하지만, 모든 콘텐츠를 반영할 만큼 일반적입니다.

간결한 제목을 만드는 방법에 관한 글에서는 동명사가 아닌 짧은 동사 구를 사용합니다. 짧은 제목이 사이드바 탐색에 나타납니다.

방법 콘텐츠 템플릿은 템플릿을 참조하세요.

        [AUTOTITLE](/contributing/style-guide-and-content-model/style-guide#procedural-steps)의 절차 단계에 대한 스타일 지침을 따르세요.

방법 콘텐츠는 반복적일 수 있습니다. 관련 콘텐츠를 더 긴 단일 문서로 그룹화할 수 있는 기회를 찾습니다.
- 설득력 있는 이유가 없는 한 여러 관련 방법을 단일 문서로 그룹화합니다.
- 설정을 사용하지 않도록 설정하거나 작업을 실행 취소하려면 동일한 단계가 필요하며 특별한 의미가 없는 경우 별도의 방법을 작성하지 마세요.
- 설정을 사용하지 않도록 설정하거나 작업을 실행 취소하는 데 다른 단계가 필요하거나 중요하거나 특별한 의미가 있는 경우 방법 모두를 포함하도록 더 긴 아티클을 만듭니다.
항상 방법의 의도된 결과를 포함합니다(일반적으로 제목이 됩니다).
알려진 문제점에 문제 해결 팁을 포함합니다.

        [AUTOTITLE](/actions/using-workflows/using-starter-workflows)