diff --git a/doc/development/documentation/styleguide/index.md b/doc/development/documentation/styleguide/index.md index e683d55d46db2589b4b19c1f7d8a6742b09a3be7..b3830a5bbd7bbfc8ea51417bd0931ad289dedcfa 100644 --- a/doc/development/documentation/styleguide/index.md +++ b/doc/development/documentation/styleguide/index.md @@ -300,11 +300,17 @@ Do not include the same information in multiple places. ## Language -GitLab documentation should be clear and easy to understand. +GitLab documentation should be clear and easy to understand. Avoid unnecessary words. -- Be clear, concise, and stick to the goal of the documentation. +- Be clear, concise, and stick to the goal of the topic. - Write in US English with US grammar. (Tested in [`British.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/British.yml).) - Use [inclusive language](#inclusive-language). +- Rewrite to avoid wordiness: + - there is + - there are + - enables you to + - in order to + - because of the fact that ### Capitalization