语气和语调
目录
语音
在 Docker,我们曾是客户。我们是为开发者而开发的开发者。我们以经验和知识说话,没有傲慢或自负。我们希望在不引起混淆或强迫的情况下,向人们提供信息和赋能。
我们不害怕使用一些幽默来活跃对话(因为我们不把自己看得太认真),但我们始终保持尊重。我们以清晰、同理心和智慧进行沟通;我们所说的每一句话都应该提供信息和鼓励。
我们把语调和内容与我们的价值观保持一致。我们写作时遵循的最重要的原则是 4C
- 正确
- 简洁
- 完整
- 清晰
我们确保信息准确、简洁、全面且易于理解。我们使句子尽可能简单,但包含足够的细节,以便用户完成预期任务。
所有这一切意味着,当我们编写文档和 UI 文本时
- 我们是诚实的。我们提供所有事实,不使用误导或模棱两可的陈述。我们不总是有所有答案,但我们正在尽力让开发者的生活更美好,我们会告诉你进展如何。
- 我们是简洁的。我们理解用户所处的复杂而详细的信息行业,因为我们来自同一个世界。Docker 不会用华丽的词藻或复杂的比喻来充斥我们的交流。我们清晰明了,直截了当。
- 我们是轻松的。我们的态度是随意但不懒惰,聪明但不傲慢,专注但不冷漠。我们的声音应该热情和温暖。
- 我们是包容的。无论写了多少代码,开发者就是开发者。每个人都是我们社区的一部分。我们接受来自所有行业和经验水平的所有开发者。
语调
Docker 的语调通常是非正式的,但我们认为清晰永远比幽默更重要。我们轻松,但我们不失礼或不专业。
友好的语调
使用自然、友好和尊重的语调,不要过于口语化或充满行话。写作目的是为开发者提供信息和赋能,而不是引起混淆或强迫。可以使用缩略词,只要句子不会变得过于俚语或非正式。
避免过度礼貌。友好和礼貌是好的,但在技术文档或 UI 文本中使用“请”可能过于礼貌。
积极的语言
使用积极的语言。与其强调限制和用户不能做什么,不如强调积极的结果。
例如,而不是
“Docker Team 订阅中不提供单点登录 (SSO)、镜像访问管理、注册表访问管理等功能。”
使用:
“单点登录 (SSO)、镜像访问管理、注册表访问管理等功能在 Docker Business 订阅中可用。”