Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
1
Merge Requests
1
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
gitlab-ce
Commits
bbebbe6e
Commit
bbebbe6e
authored
Jul 21, 2020
by
Mike Lewis
Committed by
Mike Jang
Jul 21, 2020
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Clarify rules on jargon and uncommon words
parent
1cdec983
Changes
1
Show whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
2 additions
and
2 deletions
+2
-2
doc/development/documentation/styleguide.md
doc/development/documentation/styleguide.md
+2
-2
No files found.
doc/development/documentation/styleguide.md
View file @
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."
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment