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