選詞

避免使用「簡單」和「僅」等詞語

避免使用「簡單」、「僅」、「容易」和「基本」等詞語。如果使用者在完成看似「簡單」的任務時遇到困難，他們會質疑自己的能力，或因文件而感到惱火。請考慮使用更具體的描述詞。例如，當您說「部署很容易」時，您真正的意思是甚麼？它之所以容易，是因為它比其他選項需要的步驟更少嗎？如果是這樣，請使用最具體的描述詞，在這種情況下，應該是「此部署方法比其他選項涉及的步驟更少」。

為了使文件更具包容性，請避免使用假設讀者經驗或技能水平的短語，例如「只需部署它，您就完成了」或「作為複習（當您提到某人可能沒有讀過的完全不同的文件時）」。通常，當您改述時，您會得到在更廣泛的背景下都有效的更強大的句子。

避免使用拉丁術語

這些在英語中很常見，但對於非第一語言使用者來說可能會造成問題。其中一些甚至可能會讓以英語為母語的人感到困惑。

例如

避免	使用
et al	「及其他」
etc.	「等等」，或列出所有情況
i.e.	「換句話說」
e.g.	「例如」或「舉例來說」
via	「使用」或其他等效詞，例如「現在您可以使用產生的 Prisma Client API 開始發送查詢」

避免使用動名詞（「ing」動詞形式）

避免使用動名詞（動詞的「ing」形式）。例如，使用「開始使用」而不是「開始使用中」。此指南適用於標題和內文。

範例

避免	使用
使用瀏覽器測試憑證	使用瀏覽器測試憑證
排除欄位	排除欄位
如果您使用的是 Node.js 18 或更新版本...	如果您使用 Node.js 18 或更新版本...
您可以透過重建 Prisma Client 來完成此操作	若要執行此操作，請重建 Prisma Client
在設計您的 schema 時...	當您設計您的 schema 時...

請注意，以「ing」結尾的名詞是可以的 - 例如「追蹤」。

避免在列表前使用不完整的句子

當您引入列表時，請勿使用不完整的句子。

使用

您可以使用以下方式設定您的 schema

• 項目 1
• 項目 2

避免

您可以

• 項目 1
• 項目 2

當您參考文件的其他部分時

使用以下術語

• 頁面
• 區段

記錄

將資料庫中的列稱為記錄。例如

「以下 create 查詢會建立單一 User 記錄。」

請勿使用

• 條目
• 列
• 物件

模型屬性

模型屬性是指指向模型的頂層 PrismaClient 屬性

const result = await prisma.user.findMany(...) // "user" model property
const result = await prisma.post.findMany(...) // "post" model property

版本號碼

• 將版本號碼稱為「版本 x.x.x」
• 當您比較版本號碼時，請使用「之前」和「之後」（或「較新」）
• 請勿使用「較低」和「較高」

<!-- Good -->

This feature is in Preview in versions 3.5.0 and later.

<!-- Bad -->

This feature is in Preview in v3.5.0 and higher.

當您撰寫特定版本時，請明確指出您指的是哪個產品。例如，在以下句子中，版本 3.11.1 可能指的是 Prisma 或 MongoDB

此篩選器僅在 MongoDB 版本 3.11.1 及更新版本中可用。

當無法從內容中清楚得知產品時，請在版本號碼前明確提及產品名稱。

此篩選器僅在 Prisma 版本 3.11.1 及更新版本中適用於 MongoDB。

在棄用通知中，請提及棄用版本號碼，但不要提及計畫移除的版本號碼

當您解釋某項功能已棄用時，請包含該功能被棄用的版本號碼。但是，計畫可能會變更。為了保持文件的簡潔和準確，請勿提及 Prisma 計畫移除該功能的版本。

<!-- Good -->

From v3.0.0, the `command name` command is deprecated.

<!-- Bad -->

From v3.0.0, the `command name` command is deprecated.
We plan to remove `command name` in v.4.0.0.

縮寫術語

如果您想要縮寫某個術語，請先完整寫出該術語，然後將縮寫放在括號中。之後，您可以在該頁面的其餘部分使用該縮寫。例如，「在電腦科學中，抽象語法樹 (AST) 是...」。

另請參閱：術語

避免使用含糊不清的英文單字

避免使用以下常見的英文單字，因為它們對許多讀者來說都含糊不清。

要避免的單字	避免的原因	請改用以下單字
As	可以表示「因為」或「與...同時」	「因為」或「同時」，視情況而定
Since（表示「因為」）	也可以表示「在...之後」（例如「自您升級以來」）	「因為」
May（表示「可能」）	也可以表示「被允許」	「可能」
Should（表示「應該」）	也可以表示「可能會發生」	「必須」：「您必須重建 Prisma Client」，或 省略：「重建 Prisma Client。」
Once（表示「當...時」或「在...之後」）	也可以表示「發生一次」	「當...時」：「當建置完成時...」
Wish（表示「想要」）	在國際上不總是清楚	「想要」

使用清晰的超連結

避免使用「按這裡」或「這裡」作為連結文字。它們在網路上被認為是不好的做法。

<!-- Good -->

Read more in the [Prisma ORM docs](/orm)

<!-- Bad -->

Read more in the Prisma ORM docs [here](/orm)

如果您的連結文字是目的地頁面的標題，請使用句子大小寫

<!-- Good -->

For more information, see [Relation queries](/orm/prisma-client/queries/relation-queries).

<!-- Bad -->

For more information, see [Relation Queries](/orm/prisma-client/queries/relation-queries).

當連結目的地很明顯時（例如，如果您在前面的句子中解釋了概念），則提供進一步資訊連結的非常簡潔（且可維護）的方式如下

[Learn more](/orm/prisma-client/queries/relation-queries)

特定術語

「預覽」和「正式發布」

這些使用小寫。對於正式發布的縮寫「GA」，請使用全部大寫。

<!-- Good -->

We made composite types generally available in version 3.12.0.
They were previously available in preview from version 3.10.0.

<!-- Bad -->

We made composite types Generally Available in version 3.12.0.
They were previously available in Preview from version 3.10.0.

SQL

寫「a SQL query」，而不是「an SQL query」。範例：「A SQL database...」。

macOS

良好：macOS

不良：Mac OS、MacOS 或任何其他變體

終端視窗

使用術語「終端視窗」。請勿使用「命令提示字元」或「shell」。範例

Open a terminal window.

設定/設置

它可以是名詞（「設定」）或動詞（「設定」），因此可能會造成混淆。請嘗試避免使用，並使用替代術語。例如，「設定」或「啟用」。

如果您必須使用它，請確保您使用正確的形式。請記得檢查程式碼片段，它可能會隱藏在程式碼註解中。

關係

當提及關係時，請使用以下形式

避免	使用
1-1	一對一
1-n	一對多
m-n	多對多

prisma 根命令

我們經常提到 prisma CLI 命令，例如 prisma db push。

• 這些命令的完整形式包含 prisma 根命令。例如：prisma db push。
• 這些命令的簡短形式省略了 prisma 根命令。例如：db push。

只有當使用者包含 prisma 時，prisma CLI 命令才能運作。在大多數情況下，使用完整形式可以幫助那些從該處進入文件的使用者。完整形式也能讓文件使用者複製貼上可用的命令到他們的終端機視窗中。

在以下情況使用完整形式

• 當您在程式碼區塊中包含 prisma 命令時。
• 當您在程序中包含 prisma 命令時。

在以下情況下使用簡短形式是可以的。這有助於文件中的簡潔性和可讀性。

• 當您討論 prisma 命令時，例如在參考資料中。範例：「db push 使用與 Prisma Migrate 相同的引擎...」
• 當您在標題中提及 prisma 命令時。範例

所有格的 s

清楚地表示所有者和所有權，並且不要使用所有格的 *s*。

當您避免使用所有格 s 時，您也可以避免

• 將太多名詞串在一起
• 與本地化相關的問題以及國際讀者對您文件內容的理解程度

<!-- Good -->

Change the database connection string of an environment

<!-- Bad -->

Change the environment's database connection string

輸入 (enter) vs [提供 (provide), 輸入 (type)]

對於填寫或輸入文字框或輸入欄位的動作，請使用 *輸入 (enter)*。

不要使用 *提供 (provide)* 或 *輸入 (type)*。

<!-- Good -->

In **Display Name**, enter a name for your project.

<!-- Bad -->

In **Display Name**, type a name for your project.
In **Display Name**, provide a name for your project.

清除 (clear) vs [取消選取 (deselect), 取消選擇 (unselect), 取消勾選 (uncheck), 取消標記 (unmark)]

使用 *清除 (clear)* 來引導讀者移除核取方塊中的核取記號。

<!-- Good -->

Clear **Include sample data**.

<!-- Bad -->

Deselect the **Include sample data** checkbox.

選取 (select) vs 選擇 (choose)

「選擇 (Choose)」傳達了泛泛選擇的概念，而「選取 (select)」在從選項列表中精挑細選或做出 UI 選擇的上下文中更為適用。

當您引導讀者選取哪個 UI 選項時，請使用 *選取 (select)*。

<!-- Good -->

From **Payment method**, select **Wire transfer**.

當您對選擇一個選項而不是另一個選項做出概念性描述時，請使用 *選擇 (choose)*。

<!-- Good -->

You can choose to host your project in Vercel or Netlify.

核取方塊 (checkbox) vs 核取方塊 (check box)

使用 *核取方塊 (checkbox)*。

請參閱避免過度使用 UI 術語。