語氣和口吻
目錄
語氣
在 Docker,我們曾經是客戶。我們是為開發者開發的開發者。我們以經驗和知識說話,沒有傲慢或自負。我們希望在不造成混淆或強迫的情況下提供資訊並賦能他人。
我們不害怕使用一些輕鬆的幽默來調劑談話(而且因為我們不會太嚴肅地看待自己),但我們始終保持尊重。我們以清晰、同理心和機智進行溝通;我們所說的一切都應提供資訊並鼓勵他人。
我們將我們的語氣和內容與我們的價值觀相符。我們在撰寫時遵循的最重要原則是 4C
- 正確 (Correct)
- 簡潔 (Concise)
- 完整 (Complete)
- 清晰 (Clear)
我們確保資訊準確、簡潔、詳盡且易於理解。我們盡可能保持句子簡潔,但包含足夠的細節供使用者完成預期任務。
所有這一切意味著,當我們撰寫文件和 UI 拷貝時
- 我們誠實。 我們提供所有事實,我們不使用誤導或模稜兩可的陳述。我們並不總是知道所有答案,但我們正在盡最大努力讓開發人員的生活更美好,我們會告訴你進展如何。
- 我們簡潔。 我們了解我們的用戶所處的複雜且詳細的訊息產業,因為我們來自同一個世界。Docker 不會用華麗的詞藻或複雜的比喻來堆砌我們的溝通。我們清晰且切中要點。
- 我們輕鬆。 我們的態度隨和但不懶惰,聰明但不傲慢,專注但不冷漠。我們的聲音應該親切且溫暖。
- 我們包容。 開發人員就是開發人員,無論他們編寫了多少程式碼。每個人都是我們社群的一份子。我們歡迎來自所有產業和經驗水平的所有開發人員。
口吻
Docker 的語氣通常是非正式的,但我們相信清晰始終比幽默更重要。我們很輕鬆,但我們不會不恰當或不專業。
友善的口吻
使用自然、友善和尊重的語氣,避免過於口語化或充滿行話。在不造成混淆或強迫的情況下,撰寫文件以提供資訊並賦能開發人員。可以使用縮寫,只要句子不會變得太俚語或非正式即可。
避免過度禮貌。 友善和禮貌是好的,但在技術文件中或 UI 拷貝中使用「請」可能過於禮貌。
正面用語
使用正面用語。不要強調限制和使用者不能做的事情,而要強調積極的結果。
例如,**不要**
「Docker Team 訂閱方案不提供單一登入 (SSO)、映像檔存取管理、Registry 存取管理等功能。」
使用:
「Docker Business 訂閱方案提供單一登入 (SSO)、映像檔存取管理、Registry 存取管理等功能。」