語氣和語調
目錄
語音
在 Docker,我們曾是客戶。我們是為開發者而開發的開發者。我們以經驗和知識說話,沒有傲慢或自負。我們希望在不引起混淆或強迫的情況下,向人們提供資訊和賦能。
我們不害怕使用一些幽默來活躍對話(因為我們不把自己看得太認真),但我們始終保持尊重。我們以清晰、同理心和智慧進行溝通;我們所說的每一句話都應該提供資訊和鼓勵。
我們把語調和內容與我們的價值觀保持一致。我們寫作時遵循的最重要的原則是 4C
- 正確
- 簡潔
- 完整
- 清晰
我們確保資訊準確、簡潔、全面且易於理解。我們使句子儘可能簡單,但包含足夠的細節,以便使用者完成預期任務。
所有這一切意味著,當我們編寫文件和 UI 文字時
- 我們是誠實的。我們提供所有事實,不使用誤導或模稜兩可的陳述。我們不總是有所有答案,但我們正在盡力讓開發者的生活更美好,我們會告訴你進展如何。
- 我們是簡潔的。我們理解使用者所處的複雜而詳細的資訊行業,因為我們來自同一個世界。Docker 不會用華麗的詞藻或複雜的比喻來充斥我們的交流。我們清晰明瞭,直截了當。
- 我們是輕鬆的。我們的態度是隨意但不懶惰,聰明但不傲慢,專注但不冷漠。我們的聲音應該熱情和溫暖。
- 我們是包容的。無論寫了多少程式碼,開發者就是開發者。每個人都是我們社群的一部分。我們接受來自所有行業和經驗水平的所有開發者。
語調
Docker 的語調通常是非正式的,但我們認為清晰永遠比幽默更重要。我們輕鬆,但我們不失禮或不專業。
友好的語調
使用自然、友好和尊重的語調,不要過於口語化或充滿行話。寫作目的是為開發者提供資訊和賦能,而不是引起混淆或強迫。可以使用縮略詞,只要句子不會變得過於俚語或非正式。
避免過度禮貌。友好和禮貌是好的,但在技術文件或 UI 文字中使用“請”可能過於禮貌。
積極的語言
使用積極的語言。與其強調限制和使用者不能做什麼,不如強調積極的結果。
例如,而不是
“Docker Team 訂閱中不提供單點登入 (SSO)、映象訪問管理、登錄檔訪問管理等功能。”
使用:
“單點登入 (SSO)、映象訪問管理、登錄檔訪問管理等功能在 Docker Business 訂閱中可用。”