From d183d2d76bcc25f983c0836805c712af096bcc2f Mon Sep 17 00:00:00 2001 From: GitLab Bot Date: Thu, 9 Feb 2023 21:09:12 +0000 Subject: Add latest changes from gitlab-org/gitlab@master --- doc/development/documentation/styleguide/index.md | 1 + doc/development/documentation/styleguide/word_list.md | 7 +++++-- 2 files changed, 6 insertions(+), 2 deletions(-) (limited to 'doc/development/documentation/styleguide') diff --git a/doc/development/documentation/styleguide/index.md b/doc/development/documentation/styleguide/index.md index 9ae3bba564f..74437ea46c9 100644 --- a/doc/development/documentation/styleguide/index.md +++ b/doc/development/documentation/styleguide/index.md @@ -182,6 +182,7 @@ the page is rendered to HTML. There can be only **one** level 1 heading per page Heading levels greater than `H5` do not display in the right sidebar navigation. - Do not skip a level. For example: `##` > `####`. - Leave one blank line before and after the topic title. +- If you use code in topic titles, ensure the code is in backticks. ### Backticks in Markdown diff --git a/doc/development/documentation/styleguide/word_list.md b/doc/development/documentation/styleguide/word_list.md index 5d7c94a6721..7e77e19c4a2 100644 --- a/doc/development/documentation/styleguide/word_list.md +++ b/doc/development/documentation/styleguide/word_list.md @@ -1363,16 +1363,19 @@ in present tense, active voice. ## you, your, yours -Use **you**, **your**, and **yours** instead of **the user** and **the user's**. -Documentation should be from the [point of view](https://design.gitlab.com/content/voice-and-tone#point-of-view) of the reader. +Use **you** instead of **the user**, **the administrator** or **the customer**. +Documentation should speak directly to the user, whether that user is someone installing the product, +configuring it, administering it, or using it. Use: - You can configure a pipeline. +- You can reset a user's password. (In content for an administrator) Instead of: - Users can configure a pipeline. +- Administrators can reset a user's password. ## you can -- cgit v1.2.1