diff options
| author | Alex Kalderimis <akalderimis@gitlab.com> | 2019-08-05 12:57:23 +0000 |
|---|---|---|
| committer | Alex Kalderimis <akalderimis@gitlab.com> | 2019-08-05 12:57:23 +0000 |
| commit | adc17552bf69d6ade639881909a3690711c18b7c (patch) | |
| tree | 15f2962279be706175a8c19168903b9f4ff375ee | |
| parent | 4b1b8b99b093fe4c0341e0d9a54c1903292ac180 (diff) | |
| download | gitlab-ce-adc17552bf69d6ade639881909a3690711c18b7c.tar.gz | |
Improve language guidelines
The instructions here were confusing, instructing us to use the third person, and then giving non-third-person examples (we/us is first-person-plural, you is second-person). The intent is clear, so I clarified the instruction.
| -rw-r--r-- | doc/development/documentation/styleguide.md | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/development/documentation/styleguide.md b/doc/development/documentation/styleguide.md index e84d65f424e..12d2d04bba1 100644 --- a/doc/development/documentation/styleguide.md +++ b/doc/development/documentation/styleguide.md @@ -219,8 +219,10 @@ Do not include the same information in multiple places. [Link to a SSOT instead. - Use inclusive language and avoid jargon, as well as uncommon words. The docs should be clear and easy to understand. -- Write in the 3rd person (use "we", "you", "us", "one", instead of "I" or "me"). +- Use inclusive pronouns (use "we", "you", "us", "one"). Avoid the + first-person-singular ("I", "me", "my"). - Be clear, concise, and stick to the goal of the doc. +- Avoid acronyms, and if you do use them, explain them on the first usage. - Write in US English. - Capitalize "G" and "L" in GitLab. - Use title case when referring to [features](https://about.gitlab.com/features/) or |