diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2023-12-05 18:10:08 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2023-12-05 18:10:08 +0300 |
commit | 6659634b2bdc3ba362574541985c6852ad1574a4 (patch) | |
tree | 495e2462917ef620d379d0b7296d44e6c4b84bbc /doc/development/documentation/styleguide | |
parent | b35f7ce1f3f12bf7b673c9d29002e14d0c83f35f (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/development/documentation/styleguide')
-rw-r--r-- | doc/development/documentation/styleguide/index.md | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/doc/development/documentation/styleguide/index.md b/doc/development/documentation/styleguide/index.md index 4ca2a72fddb..6109d4d603d 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. |