Help us learn about your current experience with the documentation. Take the survey.

词汇表主题类型

词汇表提供了一系列不熟悉的术语及其定义,以帮助用户理解特定的 GitLab 功能。

每个词汇表项目提供一个术语及其相关定义。定义应回答以下问题:

  • 这是什么?
  • 你为什么要使用它?

对于词汇表术语:

  • 不要使用行话。
  • 不要使用内部术语或缩写。
  • 确保在词汇表中定义了正确的用法。

词汇表的替代方案

词汇表应提供简短、简洁的术语-定义对。

  • 如果定义需要超过简要解释,请改用概念主题。
  • 如果你发现自己正在解释如何使用该功能,请改用任务主题。

词汇表示例

词汇表主题应采用此格式。主要使用描述列表。如果需要应用额外的分类,可以使用表格。

尽量在解释功能的页面上包含词汇表主题,而不是作为独立页面。

## FeatureName 词汇表

此词汇表提供了与 FeatureName 相关的术语定义。

术语 A
: 术语 A 执行此操作。

术语 B
: 术语 B 执行此操作。

术语 C
: 术语 C 执行此操作。

如果你使用表格格式:

## FeatureName 词汇表

此词汇表提供了与 FeatureName 相关的术语定义。

| 术语   | 定义                     | 附加类别 |
|--------|--------------------------|----------|
| 术语 A | 术语 A 执行此操作。      |          |
| 术语 B | 术语 B 执行此操作。      |          |
| 术语 C | 术语 C 执行此操作。      |          |

词汇表主题标题

使用 FeatureName 词汇表

不要使用 glossary 的替代词。例如:

  • 术语
  • 术语表
  • 常用术语表
  • 定义