Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add plan/accounts guidance to style guide #4754

Merged
merged 6 commits into from
Jan 17, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions contributing/content-style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -519,6 +519,7 @@ enter (in the command line) | type (in the command line)
email | e-mail
on dbt | on a remote server
person, human | client, customer
plan(s), account | organization, customer
press (a key) | hit, tap
recommended limit | soft limit
sign in | log in, login
Expand All @@ -529,6 +530,15 @@ dbt Cloud CLI | CLI, dbt CLI
dbt Core | CLI, dbt CLI
</div></b>

Note, let's make sure we're talking to our readers and keep them close to the content and documentation (second person).

For example, to explain that a feature is available to a particular dbt Cloud plan, you can use:
- “XYZ is available on Enterprise plans”,
- “If you're on an Enterprise plan, you can access XYZ..” or
- "Enterprise plans can access XYZ..." to keep users closer to the documentation.

This will signal users to check their plan or account status independently.

## Links

Links embedded in the documentation are about trust. Users trust that we will lead them to sites or pages related to their reading content. In order to maintain that trust, it's important that links are transparent, up-to-date, and lead to legitimate resources.
Expand Down
Loading