Skip to content

Accept use of common contractions

Mike Jang requested to merge ok-contractions into master

What does this MR do?

In an effort to create a more informal tone for GitLab docs, this MR modifies the current prohibition on contractions in the documentation style guide

I'm proposing a change to allow (and even encourage) "common" contractions where it enhances a conversational tone. (At Mike Lewis' suggestion, this MR would keep the prohibition for "reference" docs.) The model I'm using is the Microsoft Manual of Style, specifically the section entitled use contractions.

Screenshot_from_2020-01-17_08-28-25

I note that they also have comments on contractions in their UI. Contrast with our guidance in the UX Pajamas Guide that supports the use of contractions when it makes "writing simpler and easier to read". I personally agree with that guidance, cc @tauriedavis , and have therefore linked to it in this MR.

Screenshot_from_2020-01-17_08-28-59

Screenshots

Does this MR meet the acceptance criteria?

Conformity

Availability and Testing

Security

n/a

Edited by 🤖 GitLab Bot 🤖

Merge request reports