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