建議詞彙列表
為了確保文件的一致性,技術寫作團隊建議使用以下措辭。
& (符號)
請勿在標題、文字、導覽、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
。請針對按鈕、連結、選單項目和列表使用 選取
。
`選取` 適用於更多裝置,而 `點擊` 則更 specific to a mouse.
currently(目前)
在談論產品或其功能時,請勿使用 currently
。文件描述的是產品目前的狀態。
disable(停用)
請勿使用 disable
。暗示身心障礙是不良或負面的狀態。
請改用 關閉
或 切換關閉
。
有些情況下,開發團隊會針對技術性較強的功能使用 disable
,此時可以使用該術語。
earlier(較早版本)
談論版本號碼時,請使用 earlier
。
使用
在 Docker Desktop 4.1 及較早版本中。
而不是
在 Docker Desktop 4.1 及更低版本中。
easy, easily(簡單、輕鬆地)
對您來說簡單的事情對其他人來說可能不簡單。嘗試從句子中刪除這個詞,因為通常可以在沒有它的情況下表達相同的意思。
e.g.(例如)
請勿使用。請改用片語,例如 例如
或 像是
。
enable(啟用)
請勿使用 enable
。暗示身心障礙是不良或負面的狀態。
請改用 開啟
或 切換開啟
。
有些情況下,開發團隊會針對技術性較強的功能使用 enable
,此時可以使用該術語。
execute(執行)
盡可能避免使用。請改用 執行
。
later(較新版本)
談論版本號碼時,請使用 later
。
使用
在 Docker Desktop 4.1 及較新版本中。
而不是
在 Docker Desktop 4.1 及更高版本中… 或 在 Docker Desktop 4.1 及以上版本中…
please(請)
即使您在解釋如何使用產品的困難任務時,也請勿在說明過程中使用 please
。也請勿使用片語 please note
(請注意)。
register(註冊)
在談論建立帳戶時,請使用 註冊
取代 register。
repo(儲存庫)
請勿使用。請改用 repository
(儲存庫)。
respectively(分別)
避免使用 respectively
,請改用更精確的描述。
scroll(捲動)
避免使用。如果上下文清楚,請改用動詞片語,例如 *`移動`* 或 *`導覽至`*。
sign in(登入)
請使用 登入
取代 sign on
、signon
、log on
、logon
或 log in
、login
。如果使用者介面使用不同的詞彙,請使用 those.
請使用 登入
取代 登入到
。
sign up(註冊)
在談論建立帳戶時,請使用 註冊
或 建立帳戶
取代 register
。
tab versus view(索引標籤與檢視)
在 UI 中的主要區段時請使用 檢視
。在 UI 的子區段時請使用 索引標籤
。
例如,在 Docker Desktop 中,有 **映像檔** 檢視和 **本機** 索引標籤。
toggle(切換)
您可以開啟或關閉切換。例如
開啟深色模式切換。
upgrade(升級)
描述較高等級的訂閱方案時,請使用 升級
vs(對比)
請勿使用 vs
或 vs.
作為 versus 的縮寫;請使用未縮寫的 versus
或 `對比`。
we(我們)
盡量避免使用 we
,而應著重於使用者如何在 Docker 中執行某事。
使用
當您有想要組織的工作時,請使用 widget。
而不是
我們建立了一個功能讓您新增 widget。
wish(希望)
請勿使用。請改用 想要
。