Documentation structure and template

Documentation structure and template

本文档将帮助您确定如何在 GitLab 文档中构建页面以及包含哪些内容. 这些标准有助于确保整个文档的一致性和完整性，并使它们的贡献更加容易.

在开始之前，请熟悉GitLab 的文档指南和有关内容的部分.

大多数页面将专用于 GitLab 的特定功能或涉及一个或多个功能的用例（可能与第三方工具结合使用）.

每个功能部件或用例文档应按以下顺序包括以下内容，以下内容和此页面中包含的模板中注明了例外和详细信息.

  • 简介 ：关于此主题以及在此页面上可以找到的内容的简短句子. 描述功能或主题是什么，它做什么，以及在什么情况下应使用它. 无需添加称为”简介”或”概述”的标题，因为人们很少搜索这些术语. 只需将这些信息放在标题之后即可.
  • 用例 ：描述该功能/配置的实际用例场景.
  • 要求 ：描述所需的软件，配置，帐户或知识.
  • 说明 ：遵循一套或多套详细说明.

请注意，您可以酌情包括其他小节，例如”工作原理”，”体系结构”以及其他逻辑划分，例如部署前和部署后步骤.

要开始新文档，请遵守文件树和文件名准则以及样式准则. 使用以下模板：

通过在文档的开头添加一个键，可以从文档中省略每个文档末尾显示的”帮助和反馈”部分（由！319引入）：

默认为将其保留在此处. 如果要从文档中忽略它，则必须先咨询技术作家.

要仅忽略反馈部分中的评论，请在最前面使用以下键：

We are only hiding comments in main index pages, such as , since its content is too broad to comment on. Before omitting Disqus, you must check with a technical writer.

请注意，一旦在前件中添加了” ，它将自动省略 Disqus，因此，请勿将两个关​​键字都添加到同一文档中.

Google 跟踪代码管理器会跟踪”反馈”部分中的点击事件. 通过导航至” 行为”>”事件”>”热门事件”>” docs”，可以在 Google Analytics（分析）上查看转化.