文档 Writers' Toolkit 写作 风格指南

风格指南

本风格指南是一套内容规范，涵盖内容风格的各个方面，如语法、语言、格式和语气。它适用于所有为 Grafana Labs 技术文档做出贡献的人员。

它包括以下方面的规则和最佳实践：

• 风格约定
  为 Grafana Labs 撰写技术文档时应考虑的技术写作技巧和风格的非穷尽列表。
• 语气和语调指南
  Grafana Labs 文档的语气和语调指南。
• 大小写和标点符号
  大小写和标点符号的使用指南。
• 包容性写作
  了解包容性写作在 Grafana Labs 的重要性，并学习如何进行包容性写作。
• 为开发者写作
  学习如何为使用 Grafana Labs 产品的软件开发者和工程师撰写文档。
• UX 写作
  UI 组件中的文本、风格和语调创建指南
• 词汇表
  Grafana Labs 文档写作的词汇使用指南。
• UI 元素列表
  在 Grafana 文档中引用 UI 元素的指南。

如果此处未涵盖某个风格问题，请参考 Google 开发者文档风格指南。