语音与语调

Table of contents

语音

在 Docker，我们曾是用户。我们是为开发者开发的开发者。我们凭借经验和知识进行交流，不傲慢也不自负。我们希望在不令人困惑或咄咄逼人的情况下，为人们提供信息并赋予他们能力。

我们不介意使用一点俏皮的幽默来活跃对话（因为我们不会把自己看得太重），但我们始终保持着尊重。我们以清晰、同理心和智慧进行沟通；我们所说的一切都旨在提供信息并给予鼓励。

我们使我们的语音和内容与我们的价值观保持一致。我们在写作时遵循的最重要的原则是 4C：

  1. 正确 (Correct)
  2. 简洁 (Concise)
  3. 完整 (Complete)
  4. 清晰 (Clear)

我们确保信息准确、精炼、全面且易于理解。我们尽可能保持句子简单，但包含足够的细节让用户完成预期的任务。

所有这些意味着，当我们编写文档和 UI 文案时：

  1. 我们是诚实的。 我们提供所有事实，不使用误导或模棱两可的陈述。我们并不总是拥有所有答案，但我们正在尽最大努力让开发者的生活变得更好，并且我们会告诉你进展情况。
  2. 我们是简洁的。 我们理解用户所处的充满复杂和详细信息的行业，因为我们来自同一个世界。Docker 不会用浮夸的词汇或复杂的比喻来使我们的沟通变得臃肿。我们清晰且切中要害。
  3. 我们是轻松的。 我们的态度是随意但不懒散，聪明但不傲慢，专注但不冷漠。我们的声音应该是热情好客且温暖的。
  4. 我们是包容的。 无论写了多少代码，开发者就是开发者。每个人都是我们社区的一份子。我们接纳来自所有行业和经验水平的开发者。

语调

Docker 的语调通常是随意的，但我们认为清晰永远比滑稽更重要。我们很放松，但我们既不会不合时宜，也不会不专业。

友好的语调

使用自然、友好且尊重的语气，不要过于口语化或充满行话。写作是为了向开发者提供信息并赋予他们能力，不要令人困惑或咄咄逼人。只要句子不会变得太俚语或太随意，使用缩写是可以的。

避免过度礼貌。 友好和礼貌是好的，但在技术文档或 UI 文案中使用“请”可能就过于礼貌了。

积极的语言

使用积极的语言。与其强调限制和用户不能做什么，不如强调积极的结果。

例如，不要这样写：

“Single Sign-on (SSO)、Image Access Management、Registry Access Management 等功能在 Docker Team 订阅中不可用。”

请使用：

“Single Sign-on (SSO)、Image Access Management、Registry Access Management 等功能在 Docker Business 订阅中可用。”