文档 Writers' Toolkit 结构 主题类型

主题类型

Grafana Labs 文档使用不同的主题类型：概念 (concept)、任务 (task)、参考 (reference) 和 教程 (tutorial)。当您撰写内容时，应使用其中一种主题类型。

根据特定产品领域的需求，从下表中选择一种主题类型以了解详情。

概念

提供概述和背景信息。回答“它是什么？”这个问题。

任务

提供描述如何达成结果的带编号步骤。回答“我该怎么做？”这个问题。

参考

为用户提供在任务执行过程中可能需要参考的信息。回答“完成此任务我需要哪些细节？”这个问题。

教程

提供用户可以安全地复现和学习的步骤。回答：“你能教我如何做……吗？”这个问题。

章节

提供一个着陆页，供用户查找内容。

为了您的方便，提供了主题模板。

标准化主题的模板

除了主要的主题类型外，还有针对特定主题类型的模板，以确保记录相同主题的页面具有标准格式。

这些模板与主题类型模板位于同一目录中。