文档 作家工具包 编写 风格指南 声音和语调指南

声音和语调指南

在 Grafana，我们希望公司听起来像一个真实的人。

声音和语调反映了您的态度以及您传达信息的方式。用词、使用 粗体 或 斜体 强调、标点符号和语法都会影响您的声音。您选择的语调反映了您消息的紧急程度，因此可以根据情况而改变。

请在撰写技术文档时参考以下声音和语调指南。

展现自信

您比任何人都更了解主题内容。让您的风格反映您的专业知识。用权威的语调写作，以唤起读者的信心。

采用对话式风格

采用自然、对话式的风格写作，语言应积极友好。使用易于理解的词语和句子，提供信息并提供帮助。保持语言简洁明了。

语调

与传统商务写作相比，UI 文案和辅助材料中接受非正式语调。

只要能使句子更短，您可以适度使用 and、but 和 so 等词语。

使用缩写形式，例如用 isn’t 代替 is not，以帮助传达非正式语调。

任务完成

向用户提供完成任务所需的恰好足够的信息。任务完成后，告知用户已按预期发生了某个事件。

学习

有时，更详细地向用户解释或教育他们会有帮助。对 Grafana Labs 来说，重要的是让用户对他们的操作和 Grafana Labs 的产品功能感到自信。

不仅要教会人们如何执行操作，还要解释他们为什么应该这样做。

激励

激励用户继续，提供关于下一步的信息。不要假定用户知道下一步是什么或结果会怎样。