용어 설명 주제 유형
GitLab v19.4요약
용어 설명은 생소한 용어와 그 정의 목록을 제공하여 사용자가 특정 GitLab 기능을 이해하도록 돕습니다. 각 용어 설명 항목은 단일 용어와 그에 해당하는 정의를 제공합니다. 용어 설명 항목을 작성할 때 다음을 지킵니다.
용어 설명은 생소한 용어와 그 정의 목록을 제공하여 사용자가 특정 GitLab 기능을 이해하도록 돕습니다.
각 용어 설명 항목은 단일 용어와 그에 해당하는 정의를 제공합니다. 정의는 다음 질문에 답해야 합니다.
- 이것이 무엇인지
- 왜 사용하는지
용어 설명 항목을 작성할 때 다음을 지킵니다.
- 전문 용어를 사용하지 않습니다.
- 내부 용어나 약어를 사용하지 않습니다.
- 단어 목록에 올바른 사용법이 정의되어 있는지 확인합니다.
용어 설명의 대안#
용어 설명은 짧고 간결한 용어-정의 쌍을 제공해야 합니다.
- 정의에 간단한 설명 이상이 필요하면 개념 주제를 대신 사용합니다.
- 기능 사용 방법을 설명하게 된다면 작업 주제를 대신 사용합니다.
용어 설명 예시#
용어 설명 주제는 다음 형식을 따릅니다. 기본적으로 설명 목록을 사용합니다. 추가 분류가 필요하면 표를 사용할 수 있습니다.
용어 설명 주제는 독립된 페이지보다 해당 기능을 설명하는 페이지에 포함하는 편이 좋습니다.
## 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의 다른 대안은 사용하지 않습니다. 예를 들어 다음과 같습니다.
TerminologyGlossary of termsGlossary of common termsDefinitions