튜토리얼 페이지 유형
튜토리얼은 복잡한 워크플로 또는 시나리오의 종단간 이해를 제공하는 페이지입니다. 일반적으로 다음과 같은 경우에 튜토리얼을 사용하는 것이 좋습니다.
- 해당 워크플로가 여러 연속적인 단계를 필요로 하며 각 단계는 하위 단계로 이루어져 있는 경우
- 해당 단계가 다양한 GitLab 기능 또는 제3자 도구를 다루는 경우
튜토리얼 가이드라인
- 튜토리얼은 작업이 아닙니다. 작업은 한 가지 절차에 대한 지침을 제공합니다. 튜토리얼은 여러 작업을 결합하여 특정 목표를 달성합니다.
- 튜토리얼은 작동하는 예제를 제공합니다. 이상적인 경우에는 독자가 튜토리얼에서 설명하는 예제를 만들 수 있어야 합니다. 정확히는 복제할 수 없더라도 비슷한 것을 만들 수 있어야 합니다.
- 튜토리얼은 새로운 기능을 소개하지 않습니다.
- 튜토리얼은 단일 정보 원천 원칙을 준수할 필요가 없습니다. 어디에서든 사용 가능한 콘텐츠를 중복해서 제공하는 것은 이상적이지는 않지만 독자가 필요한 정보를 찾기 위해 페이지를 벗어나도록 하는 것보다는 더 나쁩니다.
튜토리얼 파일 이름 및 위치
튜토리얼 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. 다른 단계.
이 형식을 따르는 튜토리얼의 예는 튜토리얼: 첫 번째 Git 커밋 만들기입니다.
튜토리얼 페이지 제목
페이지 제목은 튜토리얼:로 시작하고 이어서 활동 동사인 튜토리얼: 웹사이트 만들기처럼 할 것을 권장합니다.
왼쪽 탐색에서는 전체 페이지 제목을 사용합니다. 약어를 사용하지 마세요.
파이프라인의 성공을 위해 텍스트를 따옴표로 묶으세요. 예를 들어 "튜토리얼: 첫 번째 Git 커밋 만들기".
튜토리얼로 GitLab 배우기 페이지에서는 제목에 튜토리얼을 사용하지 않습니다.
스크린샷
튜토리얼에는 복잡한 과정에서 중요한 단계를 설명하는 데 도움이 되는 스크린샷을 포함할 수 있습니다. 핵심 제품 설명 문서에서는 일러스트 사용을 삼가하시기 바랍니다. 그러나 튜토리얼에서는 스크린샷이 복잡한 프로세스에서 사용자가 어디에 있는지 이해하는 데 도움이 될 수 있습니다.
튜토리얼에서 스크린샷의 수를 균형 있게 유지하여 내러티브 흐름을 방해하지 않도록 하세요. 예를 들어, 튜토리얼 중간에 큰 스크린샷 하나를 넣지 마세요. 대신 여러 작고 작은 스크린샷을 여기저기 넣어주세요.
튜토리얼 어조
다른 주제 유형보다 더 친근한 어조를 사용하세요. 예를 들어,
- 작업 후에는 격려의 말이나 축하의 구문을 추가하세요.
- 특히 단계를 소개할 때 가끔 미래 시제를 사용하세요. 예를 들어,
다음에는 이슈를 에픽과 연결할 것입니다. - 대화체를 더 많이 사용하세요. 예를 들어,
이 작업은 완료하는 데 시간이 걸릴 수 있습니다.
메타데이터
튜토리얼인 페이지에는 파일 상단에 가장 적합한 stage: 및 group: 메타데이터를 추가하세요.
콘텐츠의 대부분이 특정 그룹과 일치하지 않는 경우, 단계에 대해 none 및 그룹에 대해 Tutorials를 지정하세요.
stage: none
group: Tutorials
도움말