From 11c105bd0b76d5c4fbf7284819e91c1b3a0ec8d3 Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Tue, 16 Jan 2024 11:02:55 +0000 Subject: [PATCH 1/2] Update content-style-guide.md add this clarification per docs discussion a few weeks back. [source](https://www.notion.so/dbtlabs/Docs-team-meeting-8852fdf3f9354945aba185625e8eaec4?pvs=4) --- contributing/content-style-guide.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/contributing/content-style-guide.md b/contributing/content-style-guide.md index 4ebbf83bf5f..c6b85d7148d 100644 --- a/contributing/content-style-guide.md +++ b/contributing/content-style-guide.md @@ -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 @@ -529,6 +530,8 @@ dbt Cloud CLI | CLI, dbt CLI dbt Core | CLI, dbt CLI +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 — 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. From 56faf65dd071bea9ed96d65fb18b9f6751042836 Mon Sep 17 00:00:00 2001 From: mirnawong1 <89008547+mirnawong1@users.noreply.github.com> Date: Wed, 17 Jan 2024 10:34:04 +0000 Subject: [PATCH 2/2] Update contributing/content-style-guide.md --- contributing/content-style-guide.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/contributing/content-style-guide.md b/contributing/content-style-guide.md index c6b85d7148d..0360ef0e84c 100644 --- a/contributing/content-style-guide.md +++ b/contributing/content-style-guide.md @@ -530,7 +530,14 @@ dbt Cloud CLI | CLI, dbt CLI dbt Core | CLI, dbt CLI -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 — 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. +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