文档 文档撰写工具包 撰写

撰写文档

本撰写指南定义了 Grafana Labs 如何撰写文档。

本指南适用于任何有兴趣改进 Grafana Labs 技术内容的人士。无论您是请求更改、编辑主题，还是从头开始为一个产品或功能撰写一套文档，本指南都旨在引导您完成文档撰写过程。

如果您为 Grafana Labs 撰写技术文档，请熟悉这些指南。

如果您找不到所需信息，请发送电子邮件至Grafana Labs 文档团队。

撰写之前

要了解如何组织文档结构，请参阅文档结构。

有关撰写文档的指南，请参阅以下章节

• 风格指南
  Grafana Labs 风格指南
• 工具和工作流程
  在本地构建和审阅您的内容。了解如何使用文档工具以及我们的工作流程。
• Markdown 指南
  使用 Markdown 撰写技术文档的指南。
• Front Matter
  了解 Grafana 如何使用 Front Matter 正确地发布和搜索技术文档。
• Shortcodes
  了解什么是 Shortcodes 以及如何在 Markdown 中使用它们。
• Grot 指南
  了解什么是 Grot 指南以及如何在 Markdown 中使用它们。
• 链接
  了解如何在页面之间添加链接。
• 媒体指南
  如何在 Grafana Labs 文档中包含图像和其他媒体。
• 复用
  了解如何在文档中复用内容。
• 废弃或删除
  了解如何在文档中废弃或删除内容。

撰写之后

撰写内容后，下一步是在本地构建内容、审阅输出，然后发布。有关详细信息，请参阅构建和审阅。