apps/design-system/content/docs/copywriting.mdx
Write UI copy that helps developers complete tasks quickly. Be direct, action-oriented, and respectful of developer time.
Supabase UI copy is:
| Bad | Good |
|---|---|
| "Remove" | "Delete project" |
| "Change" | "Revoke access" |
| "Configure" | "Enable RLS" |
| Action | Bad | Good |
|---|---|---|
| Primary action: | "Submit" | "Create table" |
| Secondary action: | "Go back" | "Cancel" |
| Action | Bad | Good |
|---|---|---|
| Label: | "Name your table" | "Table name" |
| Description: | "This field allows you to specify a name for your table using letters, numbers, and underscores" | "Letters, numbers, and underscores only" |
| Bad | Good |
|---|---|
| "This ensures your table name is unique" | "Must be unique within the schema" |
| "You can enter up to 255 characters here" | "Maximum 255 characters" |
| "This field is required when using Row Level Security policies" | "Required for RLS policies" |
| Bad | Good |
|---|---|
| "Will store connection pool settings" | "Stores connection pool settings" |
| "This will limit query execution time" | "Limits query execution time" |
| Bad | Good |
|---|---|
| "An error occurred" | "Table name already exists. Choose a different name." |
| "Something went wrong. Please try again." | "Invalid API key. Check your project settings." |
| Bad | Good |
|---|---|
| "Invalid input" | "Password must be at least 8 characters" |
| "Connection error" | "Connection failed: timeout after 30 seconds" |
| Bad | Good |
|---|---|
| "Sorry, we couldn't connect" | "Unable to connect to database" |
| "Oops! Something went wrong" | "Table creation failed: column name is reserved" |
| Bad | Good |
|---|---|
| "Success!" | "Table created successfully" |
| "Done" | "API key revoked" |
| "Operation completed" | "Changes saved" |
| Bad | Good |
|---|---|
| "Your backup has been successfully restored to your database" | "Backup restored" |
| "The migration has been applied successfully to your project" | "Migration applied" |
| Bad | Good |
|---|---|
| "This is a toggle switch" | "Enables real-time subscriptions for this table" |
| "Click to delete" | "Prevents accidental deletions" |
| Bad | Good |
|---|---|
| "Row Level Security restricts access based on user policies. When enabled, users can only access rows that match their policy conditions." | "Restricts access based on user policies" |
| "This setting controls the maximum number of concurrent connections that can be established to your database at any given time." | "Maximum number of concurrent connections" |
Use title case for page names in the main nav and document titles (e.g. "Database Settings", "Project Settings"). This distinguishes the page as a destination from section labels and in-page headings, which use sentence case.
Use a fragment with no trailing period, and prefer declarative over instructional. Describe what the page covers, not what the user should do.
| Good | Bad |
|---|---|
| "General configuration, domains, ownership, and lifecycle" | "Configure general options, domains, transfers, and project lifecycle" |
| Bad | Good |
|---|---|
| "Set Up Authentication" | "Set up authentication" |
| "Database Settings" | "Database settings" |
| "Create New Project" | "Create new project" |
| Bad | Good |
|---|---|
| "Manage your API keys" | "API keys" |
| "Configure connection pooling" | "Connection pooling" |
| "Edit your tables" | "Table editor" |
| Bad | Good |
|---|---|
| "You don't have any tables" | "No tables yet. Create your first table to get started." |
| "There are no API keys available" | "No API keys. Generate a key to connect your application." |
| Bad | Good |
|---|---|
| "No buckets found" | "No buckets yet. [Create bucket] button" |
| "No functions available" | "No functions deployed. [Deploy function] button" |
| Bad | Good |
|---|---|
| "Please wait..." | "Creating table..." |
| "Loading..." | "Loading schema..." |
| "Processing..." | "Applying migration..." |
| Action | Bad | Good |
|---|---|---|
| "Delete project" → Loading: | "Processing..." | "Deleting project..." |
| "Save changes" → Loading: | "Please wait..." | "Saving changes..." |
| Bad | Good |
|---|---|
| "Are you sure?" | "Delete this project? This action cannot be undone and will permanently delete all data." |
| "This action is permanent. Continue?" | "Revoke this API key? Applications using this key will stop working immediately." |
| Bad | Good |
|---|---|
| "All data will be removed if this project is deleted" | "Deleting this project will remove all data" |
| "Existing connections will be broken if this key is revoked" | "Revoking this key will break existing connections" |
| Bad | Good |
|---|---|
| "Easily create tables" | "Create tables" |
| "Simply configure settings" | "Configure settings" |
| "Powerful database features" | "Database features" |
| Bad | Good |
|---|---|
| "Manage tables" | "Create, edit, or delete tables" |
| "Handle errors" | "View and resolve errors" |
| "Work with data" | "Query and update data" |
RLS, API key, supabase initBefore publishing UI copy, ask: