Task 토픽 유형

GitLab 문서 작성 시 절차를 설명하는 Task 토픽 유형의 형식, 제목, 전제 조건 작성 방법을 설명합니다.

Task 토픽은 절차를 완료하는 방법을 안내합니다. 형식 # Task 토픽은 다음 형식을 따릅니다: title: Title (starts with an active verb, like "Create a widget" or "Delete a widget") --- Do this task when you want to... Task result (optional) Prerequisites (optional): - Thing 1 - Thing 2 - Thing 3 To do this task: 1. Location then action. (Go to this menu, then select this item.) 1. Another step. 1. Another step. Next steps (optional). 예시는 다음과 같습니다. title: Create an issue --- Create an issue when you want to track bugs or future work. Prerequisites: - The Developer, Maintainer, or Owner role for the project. To create an issue: 1. On the top bar, select **Search or go to** and find your project. 1. In the left sidebar, select **Plan** > **Work items** . 1. In the upper-right corner, select **New item** . 1. From the **Type** dropdown list, select **Issue** if it is not already selected. 1. Enter a title and description. If you have reference content that lists each field, link to it here. 1. Select **Create issue** . To view the issue, filter the **Work items** list by **Type** = **Issue** and select your issue. Task 토픽 제목 # 제목 텍스트에는 active verb + noun 구조를 사용합니다. 예를 들어 Create an issue 입니다. Task에 단계가 하나뿐인 경우 # 단계가 하나뿐인 task를 작성해야 한다면 그 단계를 순서 없는 목록 항목으로 만듭니다. 이 형식은 목록 규칙과의 일관성을 유지하면서 해당 단계를 눈에 띄게 합니다. 예를 들면 다음과 같습니다: title: Create a merge request --- To create a merge request: - In the upper-right corner, select **New merge request** . Task를 수행하는 방법이 둘 이상 있는 경우 # UI에서 task를 수행하는 방법이 둘 이상 있다면 주된 방법 하나만 문서화합니다. 다만 여러