Prisma docs style guide

This guide contains guidelines for contributors to the Prisma docs. Its goal is to ensure consistency throughout the Prisma docs and with other official Prisma materials.

Writing style

Audience

Word choice

Avoid words like "easy" and "just"

Spelling, punctuation, and formatting

Avoid contractions

Docs example data model

User and Post are the canonical models that we use in our examples throughout the Prisma docs.

Prisma product and component names

Use the following forms

Prisma docs image guidelines

Screenshots

User interface (GUI) guidelines

Use numbered lists to document UI steps

Boilerplate content

You can use the following phrases and blocks of content as templates when you work on the docs.