자습서 페이지 유형

튜토리얼은 복잡한 워크플로 또는 시나리오의 end-to-end walkthrough을 포함하는 페이지입니다. 일반적으로 다음과 같은 경우, 튜토리얼을 사용하는 것을 고려할 수 있습니다:

워크플로가 여러 순차적 단계를 요구하며 각 단계는 하위 단계로 구성됩니다.
단계가 다양한 GitLab 기능이나 타사 도구를 다룹니다.

튜토리얼 가이드

튜토리얼은 작업이 아닙니다. 작업은 한 가지 절차에 대한 지침을 제공합니다. 튜토리얼은 특정 목표를 달성하기 위해 여러 작업을 결합합니다.
튜토리얼은 작동하는 예제를 제공합니다. 이상적으로 독자는 튜토리얼에서 설명하는 예제를 만들 수 있어야 합니다. 완벽하게 복제하지 못하더라도 비슷한 것을 복제할 수 있어야 합니다.
튜토리얼은 새로운 기능을 소개하지 않습니다.
튜토리얼은 단일 정답 출처(Single Source of Truth) 원칙을 준수할 필요가 없습니다. 내용을 반복해서 제공하는 것은 이상적이지 않지만, 독자가 필요한 내용을 찾기 위해 페이지를 떠나야 하는 것보다 나쁘다.

튜토리얼 파일명과 위치

튜토리얼 마크다운 파일의 경우 다음 중 하나를 선택할 수 있습니다:

제품 설명서가 있는 디렉토리에 파일을 저장합니다.
doc/tutorials 아래에 하위 폴더를 만들고 파일 이름을 index.md로 지정합니다.

왼쪽 내비게이션에 튜토리얼을 추가하여 관련 기능 설명서 근처에 배치합니다.

하나의 튜토리얼 페이지에서 튜토리얼에 대한 링크를 추가하세요.

튜토리얼 형식

튜토리얼은 다음과 같은 형식을 갖추어야 합니다:

# 제목 ("튜토리얼: Create a website"와 같이 "튜토리얼:"로 시작하는 동사와 함께)

튜토리얼이 하는 일과 예상되는 결과를 설명하는 단락입니다.

웹사이트를 만들려면:

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에서 확인할 수 있습니다.

튜토리얼 페이지 제목

페이지 제목을 튜토리얼:로 시작하고 튜토리얼: Create a website와 같이 동사로 시작합니다.

왼쪽 내비게이션에서는 전체 페이지 제목을 사용하세요. 약어를 사용하지 마세요. 파이프라인이 성공하도록 텍스트를 따옴표로 묶습니다. 예를 들어, "튜토리얼: Make your first Git commit".

tutorials 페이지에서는 제목에 튜토리얼을 사용하지 마세요.

스크린샷

튜토리얼에 중요한 단계를 설명하기 위해 스크린샷을 포함할 수 있습니다. 핵심 제품 설명서에서는 스크린샷을 삼가하도록 노력해야 합니다. 그러나 튜토리얼에서는 스크린샷이 복잡한 프로세스에서 사용자가 어디에 있는지 이해하는 데 도움이 될 수 있습니다.

튜토리얼에서 스크린샷의 수를 균형 있게 유지하여 내러티브 플로우가 방해받지 않도록 노력하세요. 예를 들어, 튜토리얼 가운데 크고 하나의 스크린샷을 넣지 마세요. 대신 여러 개의 작은 스크린샷을 곳곳에 넣으세요.

튜토리얼 어조

기타 주제 유형보다 더 친근한 어조를 사용하세요. 예를 들어, 다음과 같은 것들이 가능합니다:

작업 후 격려 또는 축하의 문구 추가.
특히 단계를 소개할 때 가끔 미래 시제를 사용합니다. 예를 들어, 다음에는 이슈를 에픽에 연결할 것입니다.
대화체를 더 많이 사용하세요. 예를 들어, 이 작업은 시간이 오래 걸릴 수 있습니다.

메타데이터

튜토리얼인 페이지에는 파일 상단에 가장 적합한 stage: 및 group: 메타데이터를 추가하세요. 대부분의 내용이 특정 그룹과 일치하지 않는 경우, stage:에는 none을 지정하고 group:에는 Tutorials을 지정하세요:

stage: none
group: Tutorials