文档 写作者工具包 结构 主题类型 参考

参考主题

参考主题向用户提供了执行任务时可能需要查阅的信息。有效的参考主题提供了一个全面的数据列表，例如函数和参数、错误消息以及返回码。参考主题通常以表格、项目符号列表或示例脚本的形式呈现。

API 信息也包含在参考主题中。

由于参考主题包含用户完成任务所需的信息，因此参考主题通常会链接到任务主题。

参考结构

• 主题标题：参考主题标题包含一个限定词和名词，例如，Grafana CLI。这有助于读者区分参考主题和任务。
• 引言：提供一段引言，解释本主题将包含的内容。
• 正文：在参考主题中使用表格或列表提供信息。

撰写参考主题

要撰写参考主题，请完成以下步骤：

1. 确定您想要在 Grafana Labs 产品中添加参考文档的位置。

2. 在父目录中创建一个子目录，遵循以下命名约定：

   • 目录名称以限定词开头，后跟一个名词。
   • 使用小写字母。
   • 单词之间使用连字符。

3. 在参考目录中创建一个 index.md 文件。

4. 向 index.md 文件添加 front matter。

   有关 front matter 的更多信息，请参阅Front matter。

5. 复制参考模板，并将您的内容添加进去。

参考主题示例

请参阅以下主题以获取参考主题示例：

• 计算类型
• Grafana CLI

参考模板

准备好撰写时，复制参考模板并将您的内容添加进去。