關於
我們文件的這個部分是關於... 文件本身!
在這裡,我們描述我們的文件是如何製作的,以及我們希望您如何貢獻。以下是一些方便的連結
User
和 Post
資料模型
User
和 Post
是整個 Prisma 文件中使用的標準模型。選擇 User
和 Post
模型的原因如下
- 這兩個模型不需要特定領域的知識。
- 它們也常被用作 ORM 領域的範例,使來自其他工具的使用者感到熟悉。
- 擁有一致的模型可以讓讀者在學習不同概念時更容易,因為可以減少情境切換。
- 減少文件作者的決策和認知負擔。使用相同的模型可以減少決策疲勞,並且在試圖解釋概念時可以少擔心一件事。
表格和欄位的命名慣例
Prisma ORM 預設將模型(因此也包括表格)格式化為 PascalCase,而欄位(因此也包括欄)則為 camelCase
接受冗餘
在使用者所在的地方與他們相遇。如果一段資訊需要在多個地方描述,請這樣做,但請務必使用 markdown 片段,以便將來可以在一個地方更新資訊。
關於
我們文件的這個部分是關於... 文件本身!
Prisma 文件風格指南
Prisma 文件元件
寫作範本
用於撰寫 Prisma 文件的範本。