InfoGrab DocsInfoGrab Docs

용어 설명 주제 유형

GitLab 기능 문서에서 용어 설명(Glossary) 주제 유형을 작성하는 형식과 규칙을 설명합니다.

용어 설명(Glossary)은 생소한 용어와 그 정의 목록을 제공하여 사용자가 특정 GitLab 기능을 이해할 수 있도록 돕습니다. 각 용어 설명 항목은 단일 용어와 해당 정의를 제공합니다. 정의는 다음 질문에 답해야 합니다: 무엇 인가? 왜 사용하는가? 용어 설명 항목을 작성할 때: 전문 용어(jargon)를 사용하지 마세요. 내부 용어나 약어를 사용하지 마세요. 단어 목록 에서 올바른 사용법이 정의되어 있는지 확인하세요. 용어 설명의 대안 # 용어 설명은 간결한 용어-정의 쌍을 제공해야 합니다. 정의가 간략한 설명 이상을 필요로 한다면, 대신 개념(concept) 주제를 사용하세요. 기능 사용 방법을 설명하고 있다면, 대신 작업(task) 주제를 사용하세요. 용어 설명 예시 # 용어 설명 주제는 다음 형식을 따라야 합니다. 기본적으로 설명 목록 을 사용하세요. 추가적인 분류가 필요한 경우 표를 사용할 수 있습니다. 가능하면 독립적인 페이지로 만들기보다 해당 기능을 설명하는 페이지에 용어 설명 주제를 포함하세요. ## FeatureName glossary This glossary provides definitions for terms related to FeatureName. Term A : Term A does this thing. Term B : Term B does this thing. Term C : Term C does this thing. 표 형식을 사용할 경우: ## FeatureName glossary This glossary provides definitions for terms related to FeatureName. | Term | Definition | Additional category | |--------|-------------------------|---------------------| | Term A | Term A does this thing. | | | Term B | Term B does this thing. | | | Term C | Term C does this thing. | | 용어 설명 주제 제목 # FeatureName glossary 를 사용하세요. glossary 대신 다른 대안을 사용하지 마세요. 예를 들어 다음은 사용하지 않습니다: Terminology Glossary of terms Glossary of common terms Definitions