Commit f4b8fb60 authored by Mike Jang's avatar Mike Jang

Merge branch 'docs-style-guide-jargon-uncommon-words' into 'master'

Clarify rules on jargon and uncommon words

See merge request gitlab-org/gitlab!36627
parents f600bf9b bbebbe6e
...@@ -290,8 +290,8 @@ because it’s friendly and easy to understand. ...@@ -290,8 +290,8 @@ because it’s friendly and easy to understand.
When creating documentation, limit or avoid the use of the following verb When creating documentation, limit or avoid the use of the following verb
tenses, words, and phrases: tenses, words, and phrases:
- Avoid jargon. - Avoid jargon when possible, and when not possible, define the term or [link to a definition](#links-to-external-documentation).
- Avoid uncommon words. - Avoid uncommon words when a more-common alternative is possible, ensuring that content is accessible to more readers.
- Don't write in the first person singular. - Don't write in the first person singular.
(Tested in [`FirstPerson.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/FirstPerson.yml).) (Tested in [`FirstPerson.yml`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/FirstPerson.yml).)
- Instead of "I" or "me," use "we," "you," "us," or "one." - Instead of "I" or "me," use "we," "you," "us," or "one."
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment