작업 주제 유형
작업은 절차를 완료하는 방법에 대한 지침을 제공합니다.
형식
작업은 다음 형식을 따라야 합니다.
# 제목 ( "Widget 생성" 또는 "위젯 삭제"와 같이 동사로 시작하는 형태여야 함)
다음 상황에서이 작업을 수행하려는 경우에 대해 알려드립니다.
필수 준비사항 (선택 사항):
- 사물1
- 사물2
- 사물3
이 작업을 하려면:
1. 위치, 그런 다음 조치를 취하십시오. (이 메뉴로 이동한 다음이 항목을 선택하십시오.)
1. 다른 단계
1. 다른 단계
작업 결과 (선택 사항) 다음 단계 (선택 사항).
다음은 예입니다.
# 이슈 생성
버그를 추적하거나 미래 작업을 추적하려는 경우 이슈를 생성하십시오.
필수 준비사항:
- 프로젝트에 대한 최소한 개발자 역할이 있어야 합니다.
이슈를 만들려면:
1. 왼쪽 사이드바에서 **검색 또는 이동**를 선택하고 프로젝트를 찾습니다.
1. **Plan > 이슈**를 선택합니다.
1. 오른쪽 상단에서 **새로운 이슈**를 선택합니다.
1. 필드를 입력합니다. (각 필드를 나열하는 참조 컨텐츠가 있으면 여기에 링크를 걸어주세요.)
1. **이슈 생성**을 선택합니다.
이슈가 생성됩니다. **Plan > 이슈**로 이동하여 확인할 수 있습니다.
작업 주제 제목
제목 텍스트에는 호동사 + 명사 구조를 사용합니다.
예를 들어, 이슈 생성.
페이지의 여러 작업이 공통된 필수 준비 작업을 공유하는 경우 별도의 주제로 만들 수 있습니다.
이때, 제목은 필수 준비사항이어야 합니다.
작업이 하나의 단계 만으로 이루어질 때
하나의 단계로 이루어진 작업을 작성해야하는 경우 그 단계를 순서 없는 목록으로 만듭니다. 이 형식을 사용하면 단계가 두드러지게 나타나면서 동시에 목록에 대한 규칙이 일관되게 유지됩니다.
예를 들어:
# 병합 요청 생성
병합 요청을 생성하려면:
- 오른쪽 상단에서 **새 병합 요청**을 선택합니다.
여러 방법으로 작업을 수행해야 할 때
UI에서 작업을 수행하는 데 여러 가지 방법이 있는 경우 일반적으로 주요 방법만 문서화해야 합니다.
그러나 때로는 하나의 작업을 수행하는 데 여러 가지 방법을 문서화해야 할 수도 있습니다. 이러한 경우:
- 작업을 평소처럼 소개한 다음, 각 작업 수행 방법에 대한 주제 제목을 추가합니다.
- 주제 제목을 작업 주제 제목 아래의 레벨 아래로 들여쓰기합니다.
- 가장 가능성이 높은 방법을 제일 먼저 나열하고 내림차순으로 작업을 나열합니다.
- 작업 제목을 최대한 간결하게 만듭니다. 가능한 경우
부정사+명사를 사용합니다.
다음은 예입니다.
# 기본 브랜치 이름 변경
인스턴스 또는 그룹의 기본 브랜치 이름을 변경할 수 있습니다.
인스턴스에 이름이 설정된 경우 그룹에서 재정의할 수 있습니다.
## 인스턴스의 경우
필수 준비사항:
- 인스턴스에 대한 최소한 유지자 역할이 있어야 합니다.
인스턴스에 대한 기본 브랜치 이름을 변경하려면:
1. 단계
1. 단계
## 그룹의 경우
필수 준비사항:
- 그룹에 대한 최소한 개발자 역할이 있어야 합니다.
그룹에 대한 기본 브랜치 이름을 변경하려면:
1. 단계
1. 단계
UI 및 API에서 작업 수행
일반적으로 UI에서 수행하는 작업과 동일한 작업을 수행하는 API가 있습니다.
이러한 경우:
- API에 대한 한 문장 링크를 별도의 제목으로 사용하지 마십시오.
- API 예제는 GitLab 사용 문서에 포함시키지 마십시오. API 예제는 API 문서에 속합니다. GraphQL 예제가 있는 경우 API 문서로 이동할 수 있으므로 고유 페이지에 넣으십시오.
- API가 필요하지 않은 경우 API를 언급하지 마십시오. 사용자는 API 문서를 검색할 수 있으며, 불필요한 링크는 혼란을 줄입니다.
-
API를 반드시 언급해야 한다고 생각하는 경우 UI 작업 마지막에 다음 문장을 추가하십시오.
이슈를 만들려면 [API 사용](link.md)도 가능합니다.
작업 소개
작업 주제를 시작할 때 호동사 + 명사 구조를 사용하고 행동에 대한 컨텍스트를 제공합니다.
예를 들어, 버그를 추적하거나 미래 작업을 추적하려면 이슈를 생성합니다.
작업 단계를 시작할 때 간결한 조치 다음에 콜론을 사용합니다.
예를 들어, 이슈를 생성하려면:
작업 준비사항
최선의 실천은 작업이 사용자에게 Guest 역할 이외의 역할을 요구하는 경우, 최소 역할을 준비사항에 표시하는 것입니다.
각 역할에 대한 구문을 작성하는 방법에 대해 자세히는 단어 목록을 참조하십시오.
Prerequisites는 하나의 항목만 포함하는 경우에도 항상 복수로 사용해야 합니다.
도움말