You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: source/process/sg_grammar-spelling-mechanics.rst
+24-13Lines changed: 24 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,15 +2,12 @@
2
2
Grammar, spelling, and mechanics
3
3
================================
4
4
5
-
To maintain consistency across all Mattermost technical documentation, adhere to the guidelines here. in all cases, accuracy and clarity over rule
6
-
consistency of tone, of typographical conventions such as capitalization of titles and inline text highlighting of filenames,
7
-
clarity aids
8
-
covers the language to use, the tone of voice,
5
+
To maintain consistency across all Mattermost technical documentation, adhere to the guidelines here.
9
6
10
7
Language and spelling
11
8
=====================
12
9
13
-
Write documents in English. Use American spelling conventions.
10
+
Write documents in English. Use American spelling.
14
11
15
12
Paragraphs and sentences
16
13
========================
@@ -73,8 +70,6 @@ Person
73
70
Use the second person and avoid the first person.
74
71
75
72
Preferred
76
-
To open the program, click **Open**.
77
-
78
73
You can view the status in the *Status* pane.
79
74
80
75
Avoid
@@ -85,9 +80,12 @@ Numbers
85
80
86
81
Use decimal numbers except when the number is the first word of a sentence. Use commas to make long numbers easier to read.
87
82
88
-
Good
83
+
Preferred
89
84
Three cows ran for 6 kilometers when they saw 2,300,097 mosquitoes chasing them.
90
85
86
+
Avoid
87
+
3 cows ran for six kilometers when they saw 2300097 mosquitoes chasing them.
88
+
91
89
Text highlighting
92
90
=================
93
91
@@ -106,21 +104,34 @@ references italic
106
104
Contractions
107
105
============
108
106
109
-
As a general rule, contractions are fine.
107
+
As a general rule, contractions are acceptable in Mattermost documents.
110
108
111
109
Verb tense
112
110
==========
113
111
114
112
Use the present tense.
115
113
116
114
Preferred
117
-
Click **Open**. The *File Open* window opens.
115
+
Sharing this link lets other users view the linked message.
118
116
119
117
Avoid
120
-
Click **Open**. The *File Open* window will open.
118
+
Sharing this link will let other users view the linked message.
121
119
122
120
Bullet lists
123
121
============
124
122
125
-
Procedures
126
-
==========
123
+
The list items in a bullet list can be either all complete sentences or all sentence fragments. Don't mix complete sentences and sentence fragments in a single list. Remember that a complete sentence begins with an upper case letter and ends with a punctuation mark.
124
+
125
+
Numbered lists and procedures
126
+
=============================
127
+
128
+
Create numbered lists and procedure steps using arabic numerals for the top-level list and lower case alpha characters for the first nested list. For example:
0 commit comments