작업 주제 유형
작업은 절차를 완료하는 방법에 대한 지침을 제공합니다.
형식
작업은 다음 형식이어야 합니다:
# 제목 (활동적인 동사로 시작, 예: "위젯 생성" 또는 "위젯 삭제")
이 작업을 수행하려면...
선행 조건 (선택 사항):
- 항목 1
- 항목 2
- 항목 3
이 작업을 수행하려면:
1. 위치 후 동작. (이 메뉴로 이동한 다음 이 항목을 선택합니다.)
1. 또 다른 단계.
1. 또 다른 단계.
작업 결과 (선택 사항). 다음 단계 (선택 사항).
다음은 예시입니다.
# 문제 생성
버그나 향후 작업을 추적하려면 문제를 생성하세요.
선행 조건:
- 프로젝트에 대해 최소한 개발자 역할을 가져야 합니다.
문제를 생성하려면:
1. 왼쪽 사이드바에서 **검색 또는 이동**을 선택하고 프로젝트를 찾습니다.
1. **계획 > 문제**를 선택합니다.
1. 오른쪽 상단 모서리에서 **새 문제**를 선택합니다.
1. 필드를 완료합니다. (각 필드를 나열한 참조 콘텐츠가 있는 경우, 여기에 링크하세요.)
1. **문제 생성**을 선택합니다.
문제가 생성됩니다. **계획 > 문제**로 이동하여 이를 볼 수 있습니다.
작업 주제 제목
제목 텍스트는 구조 활동적인 동사 + 명사를 사용하세요.
예: 문제 생성.
페이지에 여러 작업이 동일한 선행 조건을 공유하는 경우, 제목 선행 조건으로 별도의 주제를 만들 수 있습니다.
작업이 한 단계만 있는 경우
단계가 하나만 있는 작업을 작성해야 하는 경우, 해당 단계를 비순서 목록 항목으로 만드세요.
이 형식은 단계를 부각시키며 목록에 대한 규칙과 일치하도록 유지합니다.
예:
# 병합 요청 생성
병합 요청을 생성하려면:
- 오른쪽 상단 모서리에서 **새 병합 요청**을 선택합니다.
여러 방법이 있을 때 작업 수행
UI에서 작업을 수행하는 여러 방법이 있을 경우, 기본 방법만 문서화해야 합니다.
그러나 상황에 따라 작업을 수행하는 여러 방법을 문서화해야 할 수도 있습니다.
이 경우:
- 작업을 일반적으로 소개합니다. 그런 다음, 각 방법에 대해 주제 제목을 추가합니다.
- 주제 제목을 작업 주제 제목 아래에서 한 단계 들어간 수준으로 중첩합니다.
- 작업 목록을 내림차순으로 나열하며, 가장 가능성이 높은 방법이 먼저 오도록 합니다.
- 작업 제목을 가능한 한 간단하게 만듭니다. 가능하다면
부정사+명사를 사용합니다.
예시는 다음과 같습니다.
# 기본 브랜치 이름 변경
인스턴스 또는 그룹에 대한 기본 브랜치 이름을 변경할 수 있습니다.
인스턴스에 대해 이름이 설정된 경우 그룹에 대해 이를 재정의할 수 있습니다.
## 인스턴스에 대해
선행 조건:
- 인스턴스를 위해 최소한 유지관리자 역할을 가져야 합니다.
인스턴스에 대한 기본 브랜치 이름을 변경하려면:
1. 단계.
1. 단계.
## 그룹에 대해
선행 조건:
- 그룹에 대해 최소한 개발자 역할을 가져야 합니다.
그룹에 대한 기본 브랜치 이름을 변경하려면:
1. 단계.
1. 단계.
UI 및 API에서 작업 수행
일반적으로 UI에서 수행하는 동일한 작업을 수행하기 위해 API가 존재합니다.
이 상황이 발생할 경우:
- API에 대한 단일 링크를 위한 별도의 제목을 사용하지 않습니다.
- GitLab 사용 문서에는 API 예제를 포함하지 않습니다. API 예제는 API 문서에 속합니다. GraphQL 예제가 있는 경우, 이를 별도의 페이지에 두십시오. API 문서는 언젠가 이동할 수 있습니다.
- 필요하지 않다면 API를 언급하지 마십시오. 사용자들은 API 문서를 검색할 수 있으며, 추가 링크는 혼잡함을 더할 수 있습니다.
-
만약 누군가 API 언급을 강하게 원한다면, UI 작업 끝에 다음 문장을 추가하세요:
문제를 생성하려면 [API를 사용할 수 있습니다](link.md).
작업 소개
작업 주제를 시작하려면 능동 동사 + 명사 구조를 사용하고, 작업에 대한 맥락을 제공하세요.
예를 들어, 버그나 향후 작업을 추적하려면 이슈를 생성하세요.
작업 단계를 시작하려면 간결한 동사 다음에 콜론을 붙이세요.
예를 들어, 이슈를 생성하려면:
작업 전제 조건
모범 사례로, 작업에 사용자가 게스트 외의 다른 역할을 요구하는 경우 최소 역할을 전제 조건에 기재하세요. 각 역할에 대한 문구 작성 방법은 용어집를 참조하세요.
전제 조건은 항상 복수형이어야 하며, 목록에 항목이 하나만 포함되어 있더라도 마찬가지입니다.
도움말