자습서는 사용자가 전체 워크플로를 통해 작업을 완료하도록 안내하여 제품에 대해 배우고 실제 문제를 해결하는 데 도움을 줍니다. 자습서는 다른 콘텐츠보다 어조가 더 대화형입니다. 자습서는 다양한 기술 지식을 가진 독자가 손쉽게 사용하는 동안 개발자-개발자 대화와 같은 느낌을 줍니다. 자습서가 포함된 제품에는 이미 빠른 시작이 있어야 합니다. 바이트 크기 워크플로의 경우 빠른 시작 모델을 대신 사용하세요.
자습서는 전문가의 조언과 문제와 관련된 모범 사례에 대한 자세한 토론을 원하는 사용자를 위한 것입니다. 또한 자습서는 과거에 다른 제품과 유사한 해법을 구현한 사용자가 GitHub을(를) 사용하는 데 도움이 됩니다. 자습서는 해법이 요구 사항에 적합한지 여부를 확인하는 데 도움이 될 수도 있습니다.
우리 사이트에서는 튜토리얼과 빠른 시작을 "가이드"라고 합니다. /guides 방문 페이지에 있는 문서 집합의 가이드 목록에는 튜토리얼, 빠른 시작 및 특정 절차에 대한 문서가 포함되어 있습니다.
자습서 작성 방법
자습서 템플릿은 템플릿을(를) 참조하세요.
자습서의 내용:
- 소개
- 대상 그룹을 명확히 하세요.
- 필수 전제 조건 및 사전 지식을 명시하세요.
- 사용자가 달성하거나 구축해야 할 것을 명시하세요.
- 성공적인 프로젝트의 예를 포함하세요.
- 작업을 완료하는 데 걸리는 예상 시간을 포함하면 안 되는데, 이는 자습서를 완료하는 사용자의 경험 수준에 따라 달라지기 때문입니다.
- 절차에 대한 섹션
- 자습서의 대상 그룹에 따라 단계가 절차적 콘텐츠에 사용되는 것보다 덜 명시적이고 공식적일 수 있습니다. 대상 그룹이 해당 수준의 세부 정보가 필요하지 않은 경우 기존의 재사용 가능한 문자열을 사용하여 단계를 구성할 필요가 없습니다.
- 사용: "프로필에서 [설정] 클릭한 다음 [개발자 설정] 을 클릭합니다."
- 페이지의 오른쪽 위 모서리에서 프로필 사진을 클릭한 다음 설정 클릭하세요. 왼쪽 사이드바에서 [개발자 설정] 을 클릭하세요.
- 자습서의 정보 흐름을 방해하지 않도록, 복제하는 대신 다른 문서나 리소스에 연결합니다.
- 시각적 신호를 제공합니다. 코드 블록 및 스크린샷을 많이 사용하여 사용자가 올바른 작업을 수행하고 있음을 알립니다.
- 실제 예시를 제공하세요.
- 예를 들어 ‘커밋 메시지 입력’을 지시하는 대신, 이전 단계와 일치하는 적절한 커밋 메시지 예시를 제공하세요.
- 자습서의 대상 그룹에 따라 단계가 절차적 콘텐츠에 사용되는 것보다 덜 명시적이고 공식적일 수 있습니다. 대상 그룹이 해당 수준의 세부 정보가 필요하지 않은 경우 기존의 재사용 가능한 문자열을 사용하여 단계를 구성할 필요가 없습니다.
- 문제 해결
- 작업에서 문제가 발생할 수 있는 사항을 인정하고 사용자가 겪을 수 있는 몇 가지 일반적인 문제를 나열하세요.
- 결론
- 수행하거나 빌드한 작업을 검토하세요. 소개에서 성공적인 프로젝트의 예로 제시한 프로젝트를 다시 참조하세요.
- 다음 단계
- 자습서를 완료한 후 사용자가 수행할 수 있는 2~3개 실행 가능한 다음 단계를 포함하세요. 다음과 같은 다른 관련 정보에 연결하세요.
- 소개된 개념을 보여 주는 GitHub의 프로젝트
- docs.github.com와 관련된 정보
- 관련된 GitHub Skills
- Hubbers가 게시한 관련 강연, 블로그 게시물 또는 커뮤니티 포럼 시리즈
- 자습서를 완료한 후 사용자가 수행할 수 있는 2~3개 실행 가능한 다음 단계를 포함하세요. 다음과 같은 다른 관련 정보에 연결하세요.
자습서에 대한 제목 지침
- 절차 문서에 대한 제목 지침을 따르세요.
- 제목에 ‘자습서’ 또는 ‘가이드’를 사용하지 마세요.
자습서시 예
자습서:
언어와 프레임워크 가이드: