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