튜토리얼 페이지 유형
튜토리얼은 복잡한 워크플로 또는 시나리오의 end-to-end 안내를 포함하는 페이지입니다. 일반적으로 튜토리얼을 사용하는 경우:
- 워크플로가 각 단계가 서브 단계로 이루어진 순차적인 단계를 필요로 하는 경우
- 단계가 다양한 GitLab 기능 또는 타사 도구를 포함하는 경우
튜토리얼 가이드
- 튜토리얼은 작업이 아닙니다. 작업은 한 가지 절차에 대한 지침을 제공합니다. 튜토리얼은 특정 목표를 달성하기 위해 여러 작업을 결합합니다.
- 튜토리얼은 작동 예제를 제공합니다. 이상적인 경우, 독자가 튜토리얼에서 설명하는 예제를 만들 수 있어야 합니다. 정확히 복제할 수 없더라도 비슷한 것을 만들 수 있어야 합니다.
- 튜토리얼에서 새로운 기능을 소개하지 않습니다.
- 튜토리얼은 진리의 단일 원천(original)에 따를 필요가 없습니다. 어딘가에 이미 있는 콘텐츠를 복제하는 것은 이상적이지 않지만, 독자로 하여금 필요한 것을 찾기 위해 페이지를 나가도록 하는 것보다는 나아합니다.
튜토리얼 파일 이름 및 위치
튜토리얼 Markdown 파일의 경우 다음 중 하나를 선택할 수 있습니다:
- 제품 문서와 동일한 디렉터리에 파일을 저장합니다.
-
doc/tutorials하위폴더를 만들고 파일의 이름을index.md로 지정합니다.
왼쪽 내비게이션에 튜토리얼을 관련 기능 문서 근처에 추가합니다.
튜토리얼 중 하나에 대한 링크를 튜토리얼 페이지 중 하나에 추가합니다.
튜토리얼 형식
튜토리얼은 이 형식을 따라야 합니다:
# 제목 ("튜토리얼:"로 시작하여 "튜토리얼: 웹 사이트 만들기"와 같은 동사로)
튜토리얼이 하는 일과 예상 결과를 설명하는 문단.
웹 사이트를 만들려면:
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. 다른 단계.
이 형식을 따르는 튜토리얼의 예는 Tutorial: Make your first Git commit입니다.
튜토리얼 페이지 제목
페이지 제목은 튜토리얼:로 시작하여 튜토리얼: 웹 사이트 만들기와 같은 동사로 시작하도록 합니다.
왼쪽 내비게이션에서 전체 페이지 제목을 사용합니다. 약어를 사용하지 않습니다.
파이프라인이 성공하도록 텍스트에 따옴표를 넣습니다. 예를 들어,
"튜토리얼: Make your first Git commit"입니다.
튜토리얼로 GitLab 배우기 페이지에서는 제목에 튜토리얼을 사용하지 않습니다.
스크린샷
튜토리얼에는 복잡한 프로세스의 중요한 단계를 설명하기 위해 스크린샷을 포함할 수 있습니다. 코어 제품 문서에서는 일러스트레이션을 절약하여 사용해야 합니다. 그러나 튜토리얼에서는 스크린샷이 복잡한 프로세스를 이해하는 데 도움이 될 수 있습니다.
튜토리얼에서 스크린샷의 수량을 균형 있게 유지하여 이야기의 흐름을 방해하지 않도록 노력합니다. 예를 들어, 튜토리얼 중간에 큰 스크린샷을 하나 넣지 않습니다. 대신 여러 작은 스크린샷을 여기저기 넣습니다.
튜토리얼 어조
다른 주제 유형에 비해 더 친근한 어조를 사용합니다. 예를 들어,
- 작업 후에 격려하는 말이나 축하하는 표현을 추가합니다.
- 특히 단계를 소개할 때 가끔 미래 시제를 사용합니다. 예를 들어,
다음으로, 이슈를 에픽에 연관시킬 것입니다. - 보다 대화체를 사용합니다. 예를 들어,
이 작업은 완료하는 데 시간이 걸릴 수 있습니다.
메타데이터
튜토리얼인 페이지에는 파일 상단에 가장 적합한 stage: 및 group: 메타데이터를 추가합니다.
콘텐츠의 대부분이 단일 그룹과 일치하지 않는 경우, stage:에 none을 지정하고 group:에 Tutorials을 지정합니다:
stage: none
group: Tutorials
도움말