작업 주제 유형
작업은 절차를 완료하는 방법에 대한 지침을 제공합니다.
형식
작업은 다음 형식을 따라야 합니다:
# 제목(“웹 위젯 생성” 또는 “웹 위젯 삭제”와 같이 동작 동사로 시작)
다음을 원할 때 이 작업을 수행합니다.
선행 조건(옵션):
- Thing 1
- Thing 2
- Thing 3
이 작업을 수행하려면:
1. 위치, 그런 다음 조치(특정 메뉴로 이동한 후 해당 항목을 선택).
1. 또 다른 단계.
1. 다른 단계.
작업 결과(옵션). 다음 단계(옵션).
다음은 예시입니다.
# 이슈 생성
오류를 추적하거나 향후 작업을 추적하려면 이슈를 만듭니다.
선행 조건:
- 프로젝트에 대한 개발자 권한을 반드시 가져야 합니다.
이슈를 만들려면:
1. 왼쪽 사이드바에서 **검색 또는 이동**을 선택하고 프로젝트를 찾습니다.
1. **Plan > 이슈**를 선택합니다.
1. 오른쪽 상단 모서리에서 **새 이슈**를 선택합니다.
1. 필드를 작성합니다(각 필드를 나열한 참조 콘텐츠가 있는 경우 여기에 링크).
1. **이슈 만들기**를 선택합니다.
이슈가 생성됩니다. **Plan > 이슈**로 이동하여 확인할 수 있습니다.
작업 주제 제목
제목 텍스트로서 동작 동사 + 명사 구조를 사용하세요. 예를 들어, 이슈 생성.
하나의 페이지에서 여러 작업이 동일한 선행 조건을 공유하는 경우, 선행 조건이라는 별도의 주제를 만들 수 있습니다.
작업이 한 단계만 있는 경우
한 단계만 있는 작업을 작성해야 하는 경우, 해당 단계를 순서 없는 디렉터리으로 만듭니다. 이 형식은 해당 단계를 강조하는 동시에 디렉터리 규칙과 일관성을 유지합니다.
예를 들어:
# Merge Request 생성
Merge Request을 만들려면:
- 오른쪽 상단 모서리에서 **새 Merge Request**을 선택합니다.
작업을 수행하는 방법이 여러 가지인 경우
UI에서 작업을 수행하는 데 여러 가지 방법이 있다면, 주된 방법만 문서화해야 합니다.
그러나 때로는 작업을 수행하는 여러 가지 방법을 문서화해야 하는 경우도 있습니다. 이런 경우에는 다음과 같은 작업을 수행합니다:
- 작업을 평소와 같이 소개합니다. 그런 다음 각 작업 수행 방법에 대해 주제 제목을 추가합니다.
- 주제 제목을 작업 주제 제목의 하위 수준으로 들여씁니다.
- 작업을 가장 가능성 있는 방법부터 내림차순으로 나열합니다.
- 작업 제목을 가능한 한 간결하게 유지하세요. 가능한 경우,
동명사+명사를 사용하세요.
다음은 예시입니다.
# 기본 브랜치 이름 변경
인스턴스 또는 그룹의 기본 브랜치 이름을 변경할 수 있습니다.
기본 이름이 인스턴스에 설정되어 있는 경우, 해당 이름을 그룹에서 재정의할 수 있습니다.
## 인스턴스용
선행 조건:
- 인스턴스에 대한 최소한의 관리자 역할이 있어야 합니다.
인스턴스의 기본 브랜치 이름을 변경하려면:
1. 단계.
1. 단계.
## 그룹용
선행 조건:
- 그룹에 대한 최소한의 개발자 역할이 있어야 합니다.
그룹의 기본 브랜치 이름을 변경하려면:
1. 단계.
1. 단계.
UI 및 API에서 작업 수행
일반적으로 UI에서 수행하는 작업이 있는 경우 해당 작업을 API로 수행할 수 있습니다.
이 경우에는 다음과 같은 작업을 수행합니다:
- API에 대한 한 문장의 링크를 별도의 제목으로 사용하지 마세요.
- GitLab 사용 문서에 API 예시를 포함하지 마세요. API 예시는 API 문서에 포함되어야 합니다. GraphQL 예시가 있는 경우, API 문서가 언젠가 이동할 수 있으므로 별도의 페이지에 넣어주세요.
- API가 필요하지 않은 경우 API에 대해 언급하지 마세요. 사용자는 API 문서를 검색할 수 있으며, 추가 링크는 혼란을 야기시킵니다.
-
누군가가 API에 언급해야 한다고 강하게 느낀다면, UI 작업의 마지막에 다음 문장을 추가하세요:
이슈를 만들려면 [API를 사용](link)할 수도 있습니다.
작업 소개
작업 주제를 시작할 때 동작 동사 + 명사 구조를 사용하고 동작에 대한 문맥을 제공하세요.
예를 들어, 오류를 추적하거나 향후 작업을 추적하려면 이슈를 만들어야 합니다.
작업 단계를 시작할 때 간결한 동작 다음에 콜론을 사용하세요.
예를 들어, 이슈를 만들려면:
작업 선행 조건
작업이 Guest 외의 역할이 필요한 경우, 해당 역할의 최소한 요구사항을 선행 조건으로 작성하세요. 각 역할에 대한 구문을 작성하는 방법은 단어 디렉터리을 참조하세요.
Prerequisites는 하나의 항목만 포함하더라도 항상 복수로 사용되어야 합니다.
도움말