参考主题类型

参考信息应该采用易于扫描的格式， 比如表格或列表。这类似于字典或百科全书的条目。

格式

参考主题应采用以下格式：

title: 标题（一个名词，如"Pipeline settings"或"Administrator options"）
---

介绍性句子。

| 设置 | 描述 |
|---------|-------------|
| **Name** | 关于该设置的描述性句子。 |

参考主题标题

参考主题标题通常是名词。

避免使用以下主题标题：

• Important notes（重要说明）。相反，应将此信息整合到更合适的位置。这些信息可能是某项任务的前提条件，或者是关于某个概念的信息。
• Limitations（限制）。相反，应将内容移至其他类似信息附近。被列为限制的内容通常可以被视为关于功能工作方式的前提信息。
• 如果必须，可以使用标题 Known issues（已知问题）。

示例

修改前

这个主题是各种信息的汇编，难以扫描。

修改后

Overview（概述）主题中的信息现在被组织在一个易于扫描的表格中。它还有一个更易于搜索的标题。