关于
我们文档的这一部分是关于...文档的!
在这里,我们描述了我们的文档是如何制作的,以及我们希望您如何贡献。这里有一些方便的链接
User
和 Post
数据模型
User
和 Post
是在整个 Prisma 文档中使用的规范模型。选择 User
和 Post
模型的原因如下
- 这两个模型不需要特定领域的知识。
- 它们也常在 ORM 领域中用作示例,使用户从其他工具过渡时感到熟悉。
- 拥有一致的模型使读者在学习不同概念时更容易,因为上下文切换会减少。
- 减少文档作者的决策和认知负担。使用相同的模型可以减少决策疲劳,并且在尝试解释概念时减少了一个需要担心的事情。
表和列的命名约定
Prisma ORM 默认将模型(因此是表)格式化为 PascalCase,而字段(因此是列)则为 camelCase
拥抱冗余
在用户所在的地方满足用户。如果一条信息需要在多个地方描述,请这样做,但请务必使用 markdown 片段,以便将来可以在一个地方更新信息。
关于
我们文档的这一部分是关于...文档的!
Prisma 文档风格指南
Prisma 文档组件
编写模板
编写 Prisma 文档的模板。