推薦詞彙表
為幫助確保文件的一致性,技術寫作團隊推薦以下措辭選擇。
& (和號)
在標題、文字、導航、UI 副本或目錄中,不要使用 & 代替 and。
above (上方)
儘量避免在文件頁面中提及示例或表格時使用 above。如果需要,請改用 previous。
例如:
在前面的示例中,這隻狗有跳蚤。
account name (賬戶名)
不要使用。請改用 username。
admin (管理員)
首次使用時請寫出 administrator。如果它是 UI 標籤或其他元素的名稱,則使用 admin。
allows (允許)
不要使用。請改用 lets。
as of this writing (截至本文撰寫時)
避免使用,因為撰寫本身就暗示了這句話。這句話也可能過早地分享產品或功能策略,或不恰當地暗示產品或功能可能會發生變化。
below (下方)
儘量避免在文件頁面中提及示例或表格時使用 below。如果需要,請改用 following。
例如:
在以下示例中,這隻狗有跳蚤。
checkbox (複選框)
checkbox 請使用一個詞。不要使用 check box。
您選擇(而不是勾選或啟用)和清除(而不是取消選擇或停用)複選框。
click (點選)
不要使用 click。請改用 select,用於按鈕、連結、選單項和列表。
Select 適用於更多裝置,而 click 更特定於滑鼠。
currently (當前)
談論產品或其功能時,不要使用 currently。文件描述的是產品現狀。
停用
不要使用 disable。它暗示殘疾是一種不受歡迎或消極的狀態。
請改用 turn off 或 toggle off。
對於更具技術性的功能,開發團隊有時會使用 disable,在這種情況下,使用該術語是可以的。
earlier (更早)
談論版本號時使用 earlier。
使用
在 Docker Desktop 4.1 及更早版本中。
而不是
在 Docker Desktop 4.1 及更低版本中。
easy, easily (簡單,輕易)
對您來說容易的事情,對其他人來說可能並不容易。儘量從句子中刪除這個詞,因為通常可以在沒有它的情況下傳達相同的含義。
e.g. (例如)
不要使用。請改用 for example 或 such as 等短語。
啟用
不要使用 enable。它暗示殘疾是一種不受歡迎或消極的狀態。
請改用 turn on 或 toggle on。
對於更具技術性的功能,開發團隊有時會使用 enable,在這種情況下,使用該術語是可以的。
execute (執行)
儘可能避免使用。請改用 run。
later (更晚)
談論版本號時使用 later。
使用
在 Docker Desktop 4.1 及更高版本中。
而不是
在 Docker Desktop 4.1 及更高版本中…… 或 在 Docker Desktop 4.1 及以上版本中……
please (請)
在解釋如何使用產品(即使是解釋一項困難任務)的正常過程中,不要使用 please。也不要使用短語 please note。
register (註冊)
談論建立賬戶時,請使用 sign up 代替 register。
repo (倉庫)
不要使用。請改用 repository。
respectively (分別)
避免使用 respectively,而是更精確地表達。
scroll (滾動)
避免使用。如果上下文清晰,請改用動詞短語,例如 move through 或 navigate to。
sign in (登入)
請使用 sign in 代替 sign on、signon、log on、logon 或 log in、login。如果使用者介面使用不同的詞,請使用這些詞。
請使用 sign in to 代替 sign into。
sign up (註冊)
談論建立賬戶時,請使用 sign up 或 create account 代替 register。
tab (選項卡) 與 view (檢視)
提及 UI 中的主要部分時使用 view。提及 UI 中的子部分時使用 tab。
例如,在 Docker Desktop 中,Images 檢視和 Local 選項卡。
toggle (開關)
您開啟或關閉一個開關。例如:
開啟深色模式開關。
upgrade (升級)
描述更高的訂閱級別時使用 upgrade
vs (對)
不要使用 vs 或 vs. 作為 versus 的縮寫;請改用未縮寫的 versus。
we (我們)
儘量避免使用 we,而是專注於使用者如何在 Docker 中完成某事。
使用
當您有需要組織的工作時,請使用小部件。
而不是
我們為您建立了新增小部件的功能。
wish (希望)
不要使用。請改用 want。