Commit 5a4fde47 authored by Mike Lewis's avatar Mike Lewis

Merge branch 'docs-collect-avoid-rules' into 'master'

Combined avoidance rules for Style Guide

See merge request gitlab-org/gitlab!30488
parents f15f3477 9d3f75f5
...@@ -248,12 +248,6 @@ GitLab documentation should be clear and easy to understand. ...@@ -248,12 +248,6 @@ GitLab documentation should be clear and easy to understand.
- Be clear, concise, and stick to the goal of the documentation. - Be clear, concise, and stick to the goal of the documentation.
- Write in US English with US grammar. - Write in US English with US grammar.
- Use inclusive language. - Use inclusive language.
- Avoid jargon.
- Avoid uncommon words.
- Don't write in the first person singular.
- Instead of "I" or "me," use "we," "you," "us," or "one."
- When possible, stay user focused by writing in the second person ("you" or the imperative).
- Don't overuse "that". In many cases, you can remove "that" from a sentence and improve readability.
### Point of view ### Point of view
...@@ -287,25 +281,52 @@ because it’s friendly and easy to understand. ...@@ -287,25 +281,52 @@ because it’s friendly and easy to understand.
Some features are also objects. For example, "GitLab's Merge Requests support X" and Some features are also objects. For example, "GitLab's Merge Requests support X" and
"Create a new merge request for Z." "Create a new merge request for Z."
### Language to avoid
When creating documentation, limit or avoid the use of the following verb
tenses, words, and phrases:
- Avoid jargon.
- Avoid uncommon words.
- Don't write in the first person singular.
- Instead of "I" or "me," use "we," "you," "us," or "one."
- When possible, stay user focused by writing in the second person ("you" or
the imperative).
- Don't overuse "that". In many cases, you can remove "that" from a sentence
and improve readability.
- Avoid use of the future tense: - Avoid use of the future tense:
- Instead of "after you execute this command, GitLab will display the result", use "after you execute this command, GitLab displays the result". - Instead of "after you execute this command, GitLab will display the
- Only use the future tense to convey when the action or result will actually occur at a future time. result", use "after you execute this command, GitLab displays the result".
- Do not use slashes to clump different words together or as a replacement for the word "or": - Only use the future tense to convey when the action or result will actually
- Instead of "and/or," consider using "or," or use another sensible construction. occur at a future time.
- Other examples include "clone/fetch," author/assignee," and "namespace/repository name." Break apart any such instances in an appropriate way. - Don't use slashes to clump different words together or as a replacement for
- Exceptions to this rule include commonly accepted technical terms such as CI/CD, TCP/IP, and so on. the word "or":
- Do not use "may" and "might" interchangeably: - Instead of "and/or," consider using "or," or use another sensible
- Use "might" to indicate the probability of something occurring. "If you skip this step, the import process might fail." construction.
- Use "may" to indicate giving permission for someone to do something, or consider using "can" instead. "You may select either option on this screen." Or, "you can select either option on this screen." - Other examples include "clone/fetch," author/assignee," and
"namespace/repository name." Break apart any such instances in an
appropriate way.
- Exceptions to this rule include commonly accepted technical terms, such as
CI/CD and TCP/IP.
- We discourage use of Latin abbreviations, such as "e.g.," "i.e.," or "etc.," - We discourage use of Latin abbreviations, such as "e.g.," "i.e.," or "etc.,"
as even native users of English might misunderstand them. as even native users of English might misunderstand them.
- Instead of "i.e.," use "that is." - Instead of "i.e.," use "that is."
- Instead of "e.g.," use "for example," "such as," "for instance," or "like." - Instead of "e.g.," use "for example," "such as," "for instance," or "like."
- Instead of "etc.," either use "and so on" or consider editing it out, since it can be vague. - Instead of "etc.," either use "and so on" or consider editing it out, since
- Avoid using the word *Currently* when talking about the product or its it can be vague.
- Avoid using the word *currently* when talking about the product or its
features. The documentation describes the product as it is, and not as it features. The documentation describes the product as it is, and not as it
will be at some indeterminate point in the future. will be at some indeterminate point in the future.
### Word usage clarifications
- Don't use "may" and "might" interchangeably:
- Use "might" to indicate the probability of something occurring. "If you
skip this step, the import process might fail."
- Use "may" to indicate giving permission for someone to do something, or
consider using "can" instead. "You may select either option on this
screen." Or, "You can select either option on this screen."
### Contractions ### Contractions
- Use common contractions when it helps create a friendly and informal tone, especially in tutorials, instructional documentation, and [UIs](https://design.gitlab.com/content/punctuation/#contractions). - Use common contractions when it helps create a friendly and informal tone, especially in tutorials, instructional documentation, and [UIs](https://design.gitlab.com/content/punctuation/#contractions).
......
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