概念主题类型

概念介绍单个功能或概念。

概念应该回答以下问题：

• 这是什么？
• 为什么使用它？

想象一下，如果有人从未听说过这个概念，他们可能想知道的一切。

不要告诉他们如何做这件事。告诉他们这是什么。

如果你开始描述另一个概念，就创建一个新的概念主题并链接到它。

格式

概念主题应采用以下格式：

title: 标题（一个名词，如"Widgets"）
---

一段或两段话，解释这是什么以及为什么使用它。

如果你开始描述另一个概念，请停下来。
每个概念主题应该只关于**一个概念**。

如果你开始描述**如何使用这个东西**，请停下来。
任务主题解释如何使用某物，而不是概念主题。

不要包含相关任务的链接。导航会提供任务的链接。

概念主题标题

标题文本使用名词。例如：

• Widgets
• GDK dependency management

如果需要更具描述性的词语，使用单词的 ion 形式，而不是 ing 形式。例如：

• Object migration 而不是 Migrating objects 或 Migrate objects

以 ing 结尾的单词难以翻译且占用更多空间，任务主题使用主动动词。 详情请参阅 Google 风格指南。

应避免的标题

避免使用这些主题标题：

• Overview 或 Introduction。相反，使用更具体的 名词或短语，这些是人们会搜索的内容。
• Use cases。相反，将信息作为概念的一部分包含在内。
• How it works。相反，使用名词后跟 workflow。例如，Merge request workflow。

示例

修改前

以下主题试图满足所有人的需求。它提供了关于组 及其位置的信息。它重复了 UI 中可见的内容。

修改后

如果你将信息移到概念主题和 任务 中，会更容易浏览。

概念

任务