절차 콘텐츠 형식

절차 콘텐츠는 작업이 다른 사람의 더 큰 목표에 어떻게 부합하는지에 대한 컨텍스트를 알려줍니다.

이 기사에서

절차 콘텐츠는 GitHub을(를) 사용하는 동안 처음부터 끝까지 작업을 완료하는 데 도움이 됩니다.

더 큰 문서 내에 절차 문서와 절차 섹션을 만듭니다.

절차 문서 작성 방법

절차적 콘텐츠 템플릿은 템플릿을 참조하세요.

  •         [AUTOTITLE](/contributing/style-guide-and-content-model/style-guide#procedural-steps)의 절차 단계에 대한 스타일 지침을 따르세요.
  • 절차적 콘텐츠는 반복적일 수 있으므로, 관련 콘텐츠를 더 긴 단일 문서로 그룹화할 수 있는 기회를 찾아 보세요.
    • 관련된 여러 절차를 하나의 문서로 그룹화하십시오. 그렇지 않을 이유가 있는 경우를 제외하고는.
    • 설정을 사용하지 않도록 정하거나 작업을 실행 취소하려면 동일한 단계가 필요하며, 특별한 의미가 없는 경우 별도의 절차를 작성하지 마세요.
    • 설정을 사용하지 않도록 정하거나 작업을 실행 취소하는 데 다른 단계가 필요하거나 중요하거나 특별한 의미가 있는 경우 두 절차를 모두 포함할 더 긴 문서를 만드세요. 중립적인 제목을 사용합니다.
  • 독자에게 절차의 예상 결과를 알릴 수 있습니다.
  • 가능한 한 자주 문제 해결 팁을 포함하세요.

절차 콘텐츠의 제목

  • 절차 관련 문서 또는 문서 내 절차 섹션은 작업 중심이며 동명사로 시작합니다.
    • 사용하세요: ‘학생 개발자 팩 신청’
  • 적극적이고 구체적인 동사를 사용하세요(브레인스토밍하거나 필요한 경우 동의어 사전을 사용하세요).
  • 제목은 특히 문서 또는 머리글에 포함된 작업을 설명하지만, 모든 콘텐츠를 반영할 만큼 일반적입니다.
  • 문서 제목 길이: 최대 80자, 가급적 60자.

절차 콘텐츠의 예시

  •         [AUTOTITLE](/enterprise-cloud@latest/admin/user-management/managing-users-in-your-enterprise/inviting-people-to-manage-your-enterprise)

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