Skip to content

Commit

Permalink
Update content-style-guide.md
Browse files Browse the repository at this point in the history
add this clarification per docs discussion a few weeks back. [source](https://www.notion.so/dbtlabs/Docs-team-meeting-8852fdf3f9354945aba185625e8eaec4?pvs=4)
  • Loading branch information
mirnawong1 authored Jan 16, 2024
1 parent 32d7b1d commit 11c105b
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 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,8 @@ dbt Cloud CLI | CLI, dbt CLI
dbt Core | CLI, dbt CLI
</div></b>

Make sure you keep the reader close to the content and documentation (second person). For example, to explain that a feature is available to a particular dbt Cloud plan &mdash; use “XYZ is available on Enterprise plans” or “People on Enterprise plans can XYZ..” to keep users closer to the documentation. This will signal to users to check their plan or account status on their own.

## 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

0 comments on commit 11c105b

Please sign in to comment.