튜토리얼 페이지 유형
튜토리얼은 복잡한 워크플로우 또는 시나리오에 대한 끝에서 끝까지의 안내를 포함하는 페이지입니다.
일반적으로, 다음과 같은 경우에 튜토리얼을 사용하는 것이 좋습니다:
- 워크플로우가 각 단계가 하위 단계로 구성된 일련의 순차적 단계가 필요한 경우.
- 단계가 다양한 GitLab 기능 또는 서드파티 도구를 다루는 경우.
튜토리얼 안내
- 튜토리얼은 작업이 아닙니다. 작업은 하나의 절차에 대한 지침을 제공합니다. 튜토리얼은 특정 목표를 달성하기 위해 여러 작업을 결합합니다.
- 튜토리얼은 작동하는 예제를 제공합니다. 이상적으로 독자는 튜토리얼에서 설명하는 예제를 직접 만들 수 있어야 합니다. 만약 그들이 정확하게 복제할 수 없다면, 비슷한 것을 복제할 수 있어야 합니다.
- 튜토리얼은 새로운 기능을 소개하지 않습니다.
- 튜토리얼은 단일 출처의 진실 원칙을 준수할 필요가 없습니다. 다른 곳에 있는 내용을 중복하는 것이 이상적이지 않지만, 독자가 필요한 것을 찾기 위해 페이지를 떠나야 하는 것은 더 나쁩니다.
튜토리얼 파일 이름 및 위치
튜토리얼 Markdown 파일의 경우 다음 중 하나를 선택할 수 있습니다:
- 제품 문서 디렉터리에 파일을 저장합니다.
-
doc/tutorials아래에 하위 폴더를 만들고 파일 이름을index.md로 지정합니다.
왼쪽 내비게이션에 관련 기능 문서 근처에 튜토리얼을 추가합니다.
tutorial 페이지 중 하나에 튜토리얼 링크를 추가하세요.
튜토리얼 형식
튜토리얼은 다음 형식이어야 합니다:
# 제목 ( "튜토리얼:"로 시작하고 "웹사이트 만들기"와 같은 능동적인 동사가 뒤따름)
튜토리얼이 무엇을 하는지와 예상 결과를 설명하는 단락입니다.
웹사이트를 만들려면:
1. [첫 번째 작업 수행](#do-the-first-task)
1. [두 번째 작업 수행](#do-the-second-task)
## 시작하기 전에
이 섹션은 선택 사항입니다.
- 사항 1
- 사항 2
- 사항 3
## 첫 번째 작업 수행
단계 1을 수행하려면:
1. 첫 번째 단계.
1. 또 다른 단계.
1. 또 다른 단계.
## 두 번째 작업 수행
시작하기 전에, [첫 번째 작업을 수행했는지](#do-the-first-task) 확인하세요.
단계 2를 수행하려면:
1. 첫 번째 단계.
1. 또 다른 단계.
1. 또 다른 단계.
이 형식을 따르는 튜토리얼의 예는 튜토리얼: 첫 번째 Git 커밋 만들기입니다.
튜토리얼 페이지 제목
페이지 제목을 튜토리얼:로 시작하고, 웹사이트 만들기와 같은 능동적인 동사가 뒤따르도록 하세요.
왼쪽 내비게이션에서는 전체 페이지 제목을 사용하세요. 축약하지 마세요. 파이프라인이 성공적으로 실행되도록 텍스트를 따옴표로 감싸세요. 예: "튜토리얼: 첫 번째 Git 커밋 만들기".
튜토리얼로 GitLab 배우기 페이지에서 제목에 튜토리얼을 사용하지 마세요.
스크린샷
중요한 단계에서 사용자가 위치를 이해하는 데 도움이 되는 스크린샷을 튜토리얼에 포함할 수 있습니다.
핵심 제품 문서에서는 일러스트레이션을 최소한으로 사용해야 하지만, 튜토리얼에서는 스크린샷이 복잡한 프로세스에서 사용자가 어디에 있는지 이해하는 데 도움이 될 수 있습니다.
튜토리얼의 스크린샷 수를 균형 있게 조절하여 서사 흐름을 방해하지 않도록 하세요. 예를 들어, 튜토리얼 중간에 큰 스크린샷을 넣지 마세요. 대신, 여러 개의 작은 스크린샷을 여기저기 배치하세요.
튜토리얼 음성
다른 주제 유형보다 더 친근한 어조를 사용하세요. 예를 들어:
- 작업 후 격려하거나 축하하는 문구를 추가하세요.
- 단계를 소개할 때 미래형을 사용하는 것도 좋습니다. 예:
다음 단계에서 문제를 에픽에 연결할 것입니다. - 더 대화식으로 하세요. 예:
이 작업은 완료하는 데 시간이 걸릴 수 있습니다.
메타데이터
튜토리얼 페이지에는 가장 적절한 stage: 및 group: 메타데이터를 파일 상단에 추가하세요.
대부분의 내용이 단일 그룹과 일치하지 않는 경우, stage에는 none을, group에는 Tutorials를 지정하세요:
stage: none
group: Tutorials
도움말