声音和语气
目录
声音
在 Docker,我们一直是客户。我们是为开发者开发软件的开发者。我们凭借经验和知识说话,不傲慢,不自大。我们希望在不造成混淆或强迫的情况下,告知和赋能用户。
我们不害怕使用一些俏皮的幽默来活跃气氛(因为我们不会过于认真对待自己),但我们始终尊重他人。我们以清晰、同理心和智慧进行沟通;我们所说的每一句话都应该具有信息性和鼓励性。
我们将我们的语气和内容与我们的价值观相一致。我们在写作时遵循的最重要的原则是 4C 原则。
- 正确 (Correct)
- 简洁 (Concise)
- 完整 (Complete)
- 清晰 (Clear)
我们确保信息准确、简洁、全面且易于理解。我们尽可能使用简单的句子,但包含足够的细节,以便用户完成预期的任务。
所有这一切都意味着,当我们编写文档和 UI 文案时:
- 我们是诚实的。我们提供所有事实,并且不使用误导性信息或含糊其辞的陈述。我们并不总是拥有所有答案,但我们正在尽最大努力改善开发者的生活,并且我们会告诉您进展如何。
- 我们是简洁的。我们了解用户所处的复杂和详细的消息传递行业,因为我们来自同一个世界。Docker 不会用空洞的词语或复杂的隐喻来增加我们的沟通量。我们清晰明了。
- 我们是轻松的。我们的态度是随意但不懒惰,聪明但不傲慢,专注但不冷淡。我们的声音应该热情友好。
- 我们是包容的。无论编写了多少代码,开发者都是开发者。每个人都与其他人一样是我们社区中的一员。我们接纳来自所有行业和经验水平的所有开发者。
语气
Docker 的语气通常是非正式的,但我们认为清晰始终比幽默更重要。我们很轻松,但我们不会不恰当或不专业。
友好的语气
使用自然、友好和尊重的语气,避免过于口语化或充满专业术语。以清晰的方式告知和赋能开发者,避免造成混淆或强迫。只要句子不会变得过于俚语化或非正式,使用缩略词是可以的。
避免过度礼貌。友好和礼貌是好的,但在技术文档或 UI 文案中使用“请”可能会显得过于礼貌。
积极的语言
使用积极的语言。与其突出限制和用户无法执行的操作,不如强调积极的结果。
例如,而不是
“Docker Team 订阅中不提供单点登录 (SSO)、镜像访问管理和注册表访问管理等功能。”
使用:
“Docker Business 订阅中提供单点登录 (SSO)、镜像访问管理和注册表访问管理等功能。”