작업 주제 유형

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

형식

작업은 다음 형식을 따라야 합니다: 

# 제목 ( "위젯 생성" 또는 "위젯 삭제"와 같이 능동적 동사로 시작)

다음을 원할 때 이 작업을 수행합니다.

필수 조건(옵션):

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

이 작업을 수행하려면:

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

작업 결과 (옵션). 추가 단계 (옵션).

다음은 예시입니다. 

# 이슈 생성

버그를 추적하거나 향후 작업을 추적하려면 이슈를 생성합니다.

필수 조건:

- 프로젝트에 대한 최소한 개발자 역할이 있어야 합니다.

이슈를 생성하려면:

1. 왼쪽 사이드바에서 **검색 또는 이동**을 선택하고 프로젝트를 찾습니다.
1. **Plan > 이슈**를 선택합니다.
1. 오른쪽 상단 모서리에서 **새 이슈**를 선택합니다.
1. 필드를 작성합니다. (각 필드를 나열하는 참조 콘텐츠가 있는 경우 여기에 링크를 걸어 둡니다.)
1. **이슈 생성**을 선택합니다.

이슈가 생성됩니다. **Plan > 이슈**로 이동하여 확인할 수 있습니다.

작업 주제 제목

제목 텍스트에는 능동적 동사 + 명사 구조를 사용합니다. 예: 이슈 생성.

한 페이지에서 여러 작업이 동일한 필수 조건을 공유하는 경우 별도의 주제를 작성하여 제목을 필수 조걱으로 지정할 수 있습니다.

작업 단계가 한 단계인 경우

한 단계만 있는 작업을 작성해야 하는 경우 해당 단계를 순서 없는 항목으로 만듭니다. 이 형식을 사용하면 해당 단계를 눈에 잘 띄게 만들어 주고 디렉터리에 대한 규칙을 일관되게 유지할 수 있습니다.

예를 들어: 

# Merge Request 생성

Merge Request을 생성하려면:

- 오른쪽 상단 모서리에서 **새 Merge Request**을 선택합니다.

여러 가지 방법으로 작업을 완료해야 하는 경우

UI에서 작업을 완료하는 데 여러 가지 방법이 있는 경우 기본적인 방법만 문서화해야 합니다.

그러나 때로는 작업을 완료하는 데 여러 가지 방법을 문서로 작성해야 할 수 있습니다. 이 경우:

  • 작업을 평소와 같이 소개합니다. 그런 다음 각 작업 수행 방법에 대한 별도의 주제 제목을 추가합니다.
  • 주제 제목을 작업 주제 제목 아래에 하나의 수준 아래로 중첩합니다.
  • 작업을 가장 가능성이 높은 방법부터 내림차순으로 나열합니다.
  • 작업 제목을 가능한 한 간결하게 만듭니다. 가능한 경우 to부정사 + 명사를 사용합니다.

다음은 예시입니다. 

# 기본 브랜치 이름 변경

인스턴스 또는 그룹에 대한 기본 브랜치 이름을 변경할 수 있습니다.
인스턴스의 이름이 설정된 경우 그룹에서 재정의할 수 있습니다.

## 인스턴스용

필수 조건:

- 인스턴스의 유지보수자 역할을 최소한 가지고 있어야 합니다.

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

1. 단계.
1. 단계.

## 그룹용

필수 조건:

- 그룹의 개발자 역할을 최소한 가지고 있어야 합니다.

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

1. 단계.
1. 단계.

UI 및 API에서 작업 수행

일반적으로 UI에서 수행하는 작업과 동일한 작업을 API로 수행할 수 있습니다.

이 경우:

  • UI에서 한 문장으로 API에 대한 링크를 따로 지정하지 마세요.
  • GitLab 사용 설명서에 API 예시를 포함하지 마세요. API 예시는 API 설명서에 포함되어야 합니다. GraphQL 예시가 있는 경우 그 예시를가 API 설명서에 넣으세요. API 설명서의 위치가 언제든지 바뀔 수 있으므로 별도의 페이지에 두는 것이 좋습니다.
  • 필요하지 않다면 API에 대한 언급을 하지 마세요. 사용자는 API 설명서를 검색할 수 있으며, 추가 링크는 혼란을 초래할 수 있습니다.

  • 누군가가 꼭 API에 대해 언급해야 한다고 생각한다면 UI 작업의 끝에 다음 문장을 추가하세요:

    이슈를 생성하려면 [API를 사용](링크)할 수도 있습니다.

작업 소개

작업 주제를 시작할 때 능동적 동사 + 명사 구조를 사용하고 동작에 대한 문맥을 제공합니다. 예: 버그를 추적하거나 향후 작업을 추적하려면 이슈를 생성합니다.

작업 단계를 시작할 때 명확한 동작 뒤에 콜론을 추가합니다. 예: 이슈를 생성하려면:

작업 필수 조건

역할 기본 이상으로 사용자가 필요한 경우, 최소한 필요한 역할을 필수 조건에 기재하세요. 각 역할에 대한 구절 작성 방법은 단어 디렉터리을 참조하세요.

필수 조건은 항상 복수여야 합니다. 하나의 항목만 포함되어 있는 경우라도 복수로 표기하세요.

관련 주제