声音和语气

嗓音

在 Docker,我们一直是客户。我们是为开发者开发的开发者。我们以经验和知识说话,没有傲慢或自负。我们希望向人们提供信息并赋予他们权力,而不是令人困惑或咄咄逼人。

我们并不害怕使用一点厚颜无耻的幽默来缓和谈话(因为我们不会太认真地对待自己),但我们总是尊重他人。我们的沟通清晰、富有同理心且机智;我们所说的一切都应该提供信息和鼓励。

我们的语气和内容与我们的美德保持一致。我们写作时遵循的最重要原则是 4C:

  1. 正确的
  2. 简洁的
  3. 完全的
  4. 清除

我们确保信息准确、简洁、全面且易于理解。我们使句子尽可能简单,但包含足够的细节,以便用户完成预期的任务。

所有这些意味着当我们编写文档和 UI 副本时:

  1. 我们是诚实的。我们向您提供所有事实,我们不会误导或做出模棱两可的陈述。我们并不总能找到所有答案,但我们正在尽最大努力让开发人员的生活变得更好,我们会告诉您进展如何。
  2. 我们很简洁。我们了解用户所处的复杂而详细的消息传递行业,因为我们来自同一个世界。 Docker 不会用空洞的词语或复杂的隐喻来加强我们的沟通。我们说得很清楚并且切中要害。
  3. 我们很放松。我们的举止随意但不懒惰,聪明但不傲慢,专注但不冷漠。我们的声音应该是欢迎和温暖的。
  4. 我们具有包容性。开发人员就是开发人员,无论他们编写了多少代码。每个人都是我们社区的一部分。我们接受来自各个行业和经验水平的所有开发人员。

语气

Docker 的语气通常是非正式的,但我们相信清晰总是比滑稽更重要。我们很放松,但我们并不不合适或不专业。

友好的语气

使用自然、友好和尊重的语气,不要过于口语化或充满行话。编写内容是为了向开发人员提供信息和授权,而不是令人困惑或咄咄逼人。只要句子不会变得太俚语或非正式,就可以使用缩写。

避免过度礼貌。保持友好和礼貌固然很好,但在技术文档或 UI 副本中使用“请”可能会过于礼貌。

积极的语言

使用积极的语言。不要强调限制和用户不能做什么,而是强调积极的结果。

例如,代替

Docker Team 订阅中不提供单点登录 (SSO)、图像访问管理、注册表访问管理等功能。”

使用

Docker Business 订阅中提供单点登录 (SSO)、图像访问管理、注册表访问管理等功能。”