文档 Writers' Toolkit 结构 主题类型 概念

概念主题

概念主题提供概览和背景信息，帮助终端用户理解产品、界面或任务。概念主题回答了“它是什么？”这个问题。读者通过概念主题了解功能特性。

概念主题可以包含以下类型的内容：

• 详细的功能概览，包含益处和清晰定义的术语
• 帮助用户理解系统组件的图表
• 流程图
• 最佳实践指南
• 功能的使用示例，示例可能包含截图或其他辅助视觉元素

概念主题不包括：

• 分步说明
• 参考信息，例如查找表或值列表

概念主题结构

概念主题包含以下元素：

• 主题标题： 主题标题应使用名词，例如，Grafana panels。使用此命名约定，读者可以区分概念主题和以动词开头的任务。对于最佳实践指南，使用标题 Best practices。
• 引言： 包含一个解释本主题内容的引言。
• 正文： 根据需要提供足够的内容以详细解释概念。正文可以包含章节、视觉元素和文本。

编写概念主题

要编写概念主题，请遵循以下步骤。

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

2. 在顶层实体中，按照以下命名约定创建一个父目录：

   • 使用名词
   • 使用小写字母
   • 单词之间添加连字符

3. 在父目录中，创建一个 _index.md 文件。

4. 向 _index.md 文件添加 Front matter。

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

5. 将内容添加到 概念模板 的副本中。

   有关可以添加到概念主题的内容类型，请参阅 概念主题。

概念主题示例

请参考以下主题作为概念主题示例：

• 角色和权限
• Loki 部署模式
• Grafana 仪表盘最佳实践

概念模板

准备好写作时，请复制 概念模板 并添加您的内容。