개념 토픽 유형

GitLab 문서의 개념 토픽 유형에 대한 형식, 제목 규칙, 작성 예시를 설명합니다.

개념 토픽은 단일 기능이나 개념을 소개합니다. 개념 토픽은 다음 질문에 답해야 합니다: 이것이 무엇 인가? 왜 사용하는가? 이 개념을 처음 접하는 사람이 알고 싶어할 모든 내용을 생각해 보세요. 이 기능을 어떻게 사용하는지 설명하지 마세요. 무엇인지 를 설명하세요. 다른 개념을 설명하기 시작한다면, 새로운 개념 토픽을 시작하고 링크로 연결하세요. 형식 # 개념 토픽은 다음 형식으로 작성해야 합니다: title: 제목 (명사, 예: "위젯") --- 이 기능이 무엇이고 왜 사용하는지 설명하는 단락 한두 개. 다른 개념을 설명하기 시작한다면, 멈추세요. 각 개념 토픽은 **하나의 개념**만 다루어야 합니다. **사용 방법**을 설명하기 시작한다면, 멈추세요. 태스크 토픽이 사용 방법을 설명하며, 개념 토픽은 그렇지 않습니다. 관련 태스크 링크를 포함하지 마세요. 내비게이션에서 태스크 링크를 제공합니다. 개념 토픽 제목 # 제목 텍스트에는 명사를 사용하세요. 예: 위젯(Widgets) GDK 의존성 관리(GDK dependency management) 더 설명적인 단어가 필요하다면, ing 형태 대신 ion 형태의 단어를 사용하세요. 예: Migrating objects 또는 Migrate objects 대신 Object migration ing 로 끝나는 단어는 번역하기 어렵고 더 많은 공간을 차지하며, 능동형 동사는 태스크 토픽에 사용됩니다. 자세한 내용은 Google 스타일 가이드 를 참조하세요. 피해야 할 제목 # 다음과 같은 토픽 제목은 피하세요: 개요(Overview) 또는 소개(Introduction) . 대신, 사람들이 검색할 만한 더 구체적인 명사나 구문을 사용하세요. 사용 사례(Use cases) . 대신, 해당 정보를 개념의 일부로 포함시키세요. 작동 방식(How it works) . 대신, 명사 뒤에 워크플로(workflow) 를 붙이세요. 예: 머지 리퀘스트 워크플로(Merge request workflow) . 예시 # 변경 전 # 다음 토픽은 모든 것을 다루려 했습니다. 그룹에 대한 정보와 그룹을 찾는 위치를 제공하고, UI에서 보이는 내용을 반복했습니다. [ ](/19.1/development/documentation/topic_types/img/example_1_v17_10.png) 변경 후 # 정보를 개념과 태스크 로 분리하면 스캔하기가 더 쉬워집니다. 개념 # [ ](/19.1/development/documentation/topic_types/img/example_1_after_concept_v17_10.png) 태스크 # [ ](/19.1/development/documentation/topic_types/img/example_1_after_task_v17_10.png)