Help us learn about your current experience with the documentation. Take the survey.
文档主题类型 (CTRT)
页面上的每个主题都应属于以下主题类型之一：
即使页面很短，通常也会从概念开始，然后包含任务或参考主题。
技术写作团队有时使用首字母缩略词 CTRT 来指代这些主题类型。
该缩略词代表每种主题类型的第一个字母。
概述请参见 编辑风格和主题类型。
其他页面和主题类型
除了四种主要主题类型外，您还可以使用以下类型：
应避免的页面和主题类型
您应该避免：
- 仅包含其他页面链接的页面。唯一的例外是有助于导航的顶级页面。
- 只有一两个句子的主题。在这种情况下：
- 将信息合并到另一个主题中。
- 如果该句子链接到另一个页面，请改用 相关主题 链接。
主题标题指南
通常，对于主题标题：
- 清晰直接。让每个词都有意义。
- 尽可能使用少于 70 个字符。markdownlint 规则：
line-length(MD013) - 使用冠词和介词。
- 遵循 大小写 指南。
- 不要重复前面主题标题中的文本。例如，如果页面关于合并请求，
不要使用
Troubleshooting merge requests，而只使用Troubleshooting。 - 避免使用连字符分隔信息。
例如，不要使用
Internal analytics - Architecture，而使用Internal analytics architecture或Architecture of internal analytics。
另请参阅 Markdown 中标题层级的指南。
相关主题
如果内联链接不够，您可以创建一个名为 相关主题 的部分， 并包含一个相关主题的无序列表。该主题应位于故障排除部分之上。
此部分的链接应简洁且易于扫描。它们通常不是 完整的句子，因此不应以句号结尾。
## Related topics
- [CI/CD variables](link-to-topic.md)
- [Environment variables](link-to-topic.md)