推薦詞彙表
為幫助確保文件的一致性,技術寫作團隊推薦以下詞彙選擇。
& (和號)
在標題、正文、導航、UI 文字或目錄中,不要使用 &
代替 and
。
above
儘量避免在文件頁面中引用示例或表格時使用 above
。如果需要,請使用 previous
。
例如
在上一個示例中,狗有跳蚤。
account name
不要使用。請改用 username
(使用者名稱)。
admin
首次使用時請寫全 administrator
。如果 admin
是 UI 標籤或其他元素的名稱,則可以使用 admin
。
allows
不要使用。請改用 lets
(讓)。
as of this writing
避免使用,因為文字本身就包含了此含義。此短語還可能過早地洩露產品或功能策略,或不適當地暗示產品或功能可能發生變化。
below
儘量避免 below
在文件頁面中引用示例或表格時使用。如果需要,請改用 following
。
例如
在以下示例中,狗有跳蚤。
checkbox
對 checkbox
使用一個單詞。不要使用 check box
。
您 select
(選擇,而不是 check
或 enable
)複選框,並 clear
(清除,而不是 deselect
或 disable
)。
click
不要使用 click
。請改用 select
(選擇)來指代按鈕、連結、選單項和列表。
Select
適用於更多裝置,而 click
更特定於滑鼠。
currently
談論產品或其功能時,不要使用 currently
。本文件描述的是產品當前的狀態。
disable
不要使用 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
不要使用 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 versus view
指代 UI 中的主要部分時,使用 view
(檢視)。指代 UI 中的子部分時,使用 tab
(選項卡)。
例如,在 Docker Desktop 中,**映象** 檢視和 **本地** 選項卡。
toggle
您開啟或關閉切換開關。例如
開啟深色模式切換開關。
upgrade
在描述更高階的訂閱層級時,使用 upgrade
(升級)
vs
不要使用 vs
或 vs.
作為 versus 的縮寫;請改用未縮寫的 versus
(對比)。
we
儘量避免使用 we
,而應專注於使用者如何在 Docker 中執行某項操作。
使用
當您有想要組織的工作時,請使用小元件。
不要使用
我們建立了一個功能供您新增小元件。
wish
不要使用。請改用 want
(想要)。