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
ccc80751
Commit
ccc80751
authored
Jun 16, 2021
by
Susan Tacker
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Added examples of wordiness
parent
09c369d1
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
8 additions
and
2 deletions
+8
-2
doc/development/documentation/styleguide/index.md
doc/development/documentation/styleguide/index.md
+8
-2
No files found.
doc/development/documentation/styleguide/index.md
View file @
ccc80751
...
@@ -300,11 +300,17 @@ Do not include the same information in multiple places.
...
@@ -300,11 +300,17 @@ Do not include the same information in multiple places.
## Language
## Language
GitLab documentation should be clear and easy to understand.
GitLab documentation should be clear and easy to understand.
Avoid unnecessary words.
-
Be clear, concise, and stick to the goal of the
documentation
.
-
Be clear, concise, and stick to the goal of the
topic
.
-
Write in US English with US grammar. (Tested in
[
`British.yml`
](
https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/British.yml
)
.)
-
Write in US English with US grammar. (Tested in
[
`British.yml`
](
https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/.vale/gitlab/British.yml
)
.)
-
Use
[
inclusive language
](
#inclusive-language
)
.
-
Use
[
inclusive language
](
#inclusive-language
)
.
-
Rewrite to avoid wordiness:
-
there is
-
there are
-
enables you to
-
in order to
-
because of the fact that
### Capitalization
### Capitalization
...
...
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