From 2dde75ef84e30c67416bda8bb03e7a16d8dc8e29 Mon Sep 17 00:00:00 2001 From: Suzanne Selhorn <sselhorn@gitlab.com> Date: Tue, 5 Dec 2023 13:54:52 +0000 Subject: [PATCH] Added details about marketing text in the docs --- doc/development/documentation/styleguide/index.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/doc/development/documentation/styleguide/index.md b/doc/development/documentation/styleguide/index.md index 33e10e2144c3..042e2dce5953 100644 --- a/doc/development/documentation/styleguide/index.md +++ b/doc/development/documentation/styleguide/index.md @@ -189,6 +189,20 @@ Words that indicate you are not writing from a customer perspective are [allow and enable](word_list.md#allow-enable). Try instead to use [you](word_list.md#you-your-yours) and to speak directly to the user. +### Building trust + +Product documentation should be focused on providing clear, concise information, +without the addition of sales or marketing text. + +- Do not use words like [easily](word_list.md#easily) or [simply](word_list.md#simply-simple). +- Do not use marketing phrases like "This feature will save you time and money." + +Instead, focus on facts and achievable goals. Be specific. For example: + +- The build time can decrease when you use this feature. +- You can use this feature to save time when you create a project. The API creates the file and you + do not need to manually intervene. + ### Capitalization As a company, we tend toward lowercase. -- GitLab