Task는 절차를 완료하는 방법에 대한 지침을 제공합니다.

형식#

Task는 다음 형식으로 작성해야 합니다:

title: 제목 (능동 동사로 시작, 예: "위젯 만들기" 또는 "위젯 삭제하기")
---

이 task를 수행하는 경우는 ...

전제 조건 (선택):

- 항목 1
- 항목 2
- 항목 3

이 task를 수행하려면:

1. 위치 후 동작. (이 메뉴로 이동한 후 이 항목을 선택합니다.)
1. 다음 단계.
1. 다음 단계.

Task 결과 (선택). 다음 단계 (선택).

다음은 예시입니다.

title: 이슈 만들기
---

버그나 향후 작업을 추적하려는 경우 이슈를 만드세요.

전제 조건:

- 프로젝트에 대한 Developer, Maintainer 또는 Owner 권한.

이슈를 만들려면:

1. 상단 표시줄에서 **검색 또는 이동**을 선택하고 프로젝트를 찾습니다.
1. 왼쪽 사이드바에서 **계획** > **작업 항목**을 선택합니다.
1. 오른쪽 상단에서 **새 항목**을 선택합니다.
1. **유형** 드롭다운 목록에서 아직 선택되지 않은 경우 **이슈**를 선택합니다.
1. 제목과 설명을 입력합니다. 각 필드를 나열하는 참조 콘텐츠가 있는 경우 여기에 링크합니다.
1. **이슈 만들기**를 선택합니다.

이슈가 만들어집니다. 이슈를 보려면 **작업 항목** 목록을 **유형** = **이슈**로 필터링하고 이슈를 선택합니다.

Task 토픽 제목#

제목 텍스트에는 능동 동사 + 명사 구조를 사용합니다. 예를 들어, 이슈 만들기.

Task가 한 단계만 있는 경우#

한 단계만 있는 task를 작성해야 하는 경우, 해당 단계를 순서 없는 목록 항목으로 만드세요. 이 형식은 단계가 눈에 띄게 하면서도 목록 규칙과 일관성을 유지합니다.

예를 들어:

title: 머지 리퀘스트 만들기
---

머지 리퀘스트를 만들려면:

- 오른쪽 상단에서 **새 머지 리퀘스트**를 선택합니다.

하나의 task를 수행하는 방법이 둘 이상 있는 경우#

UI에서 task를 수행하는 방법이 둘 이상 있는 경우, 기본 방법만 문서화해야 합니다.

그러나 때로는 task를 수행하는 여러 방법을 문서화해야 할 수 있습니다. 이런 상황이 발생하면:

• 평소와 같이 task를 소개합니다. 그런 다음 task를 수행하는 각 방법에 대해 토픽 제목을 추가합니다.

• 토픽 제목을 task 토픽 제목의 한 수준 아래에 중첩합니다.

• task를 내림차순으로 나열하고, 가장 가능성 높은 방법을 먼저 나열합니다.

• task 제목을 가능한 간결하게 만듭니다. 가능하면 부정사 + 명사를 사용합니다.

다음은 예시입니다.

title: 기본 브랜치 이름 변경하기
---

인스턴스 또는 그룹의 기본 브랜치 이름을 변경할 수 있습니다.
인스턴스에 이름이 설정되어 있으면 그룹에 대해 재정의할 수 있습니다.

## 인스턴스의 경우

전제 조건:

- 관리자 액세스.

인스턴스의 기본 브랜치 이름을 변경하려면:

1. 단계.
1. 단계.

## 그룹의 경우

전제 조건:

- 그룹에 대한 Developer, Maintainer 또는 Owner 권한.

그룹의 기본 브랜치 이름을 변경하려면:

1. 단계.
1. 단계.

UI와 API에서 task 수행하기#

일반적으로 UI에서 수행하는 것과 동일한 task를 수행하는 API가 있습니다.

이런 상황이 발생하면:

• API에 대한 한 문장 링크에 별도의 제목을 사용하지 마세요.

• GitLab 사용 문서에 API 예시를 포함하지 마세요. API 예시는 API 문서에 속합니다. GraphQL 예시가 있으면 별도 페이지에 배치하세요. API 문서가 언젠가 이동할 수 있기 때문입니다.

• 필요하지 않으면 API를 언급하지 마세요. 사용자가 API 문서를 검색할 수 있으며, 추가 링크는 불필요한 내용을 추가합니다.

• API를 꼭 언급해야 한다고 강하게 느끼는 사람이 있으면, UI task 끝에 다음 문장을 추가하세요:

이슈를 만들려면 [API를 사용할 수도 있습니다](link.md).

Task 소개#

task 토픽을 시작할 때 능동 동사 + 명사 구조를 사용하고 동작에 대한 컨텍스트를 제공합니다. 예를 들어, 버그나 향후 작업을 추적하려는 경우 이슈를 만드세요.

task 단계를 시작할 때 간결한 동작 뒤에 콜론을 사용합니다. 예를 들어, 이슈를 만들려면:

Task 전제 조건#

task에서 사용자가 Guest 이외의 권한을 가져야 하는 경우, 전제 조건에 해당하는 모든 권한을 나열합니다. 각 권한에 대한 문구 작성 방법은 단어 목록을 참조하세요. 해당 권한을 먼저 나열합니다.

task가 관리자만 수행할 수 있는 경우 전제 조건에 관리자 액세스.를 입력합니다.

Prerequisites는 목록에 항목이 하나만 포함된 경우에도 항상 복수형이어야 합니다.

전제 조건에 구독 또는 추가 기능을 나열하지 마세요. 이는 제품 가용성 세부 정보에만 포함되어야 합니다.

페이지의 여러 task가 전제 조건을 공유하는 경우 제목이 Prerequisites인 별도 토픽을 만들 수 있습니다.

전제 조건 문장 작성하기#

전제 조건을 작성할 때 가능한 한 다음 패턴을 따르세요.

• 암묵적인 소개 You must have:를 가정하여 명사 목록을 사용합니다.

• 암묵적인 소개 You must:를 가정하여 동사 목록을 사용합니다.

예를 들어, 명사 목록의 경우:

Prerequisites:

- The Maintainer or Owner role for the project.
- A project access token.
- Docker installed locally.

동사 목록의 경우:

Prerequisites:

- Enable Cloud Logging API on your Google Cloud project.
- Configure dependency scanning on your target projects.
- Create a service account with appropriate permissions.

Ensure that 또는 You must have와 같은 문구는 가능한 피하세요.

관련 토픽#

• task 단계 작성 방법

• 수정 전후 예시