Skip to content

Commit 9fa09b3

Browse files
committed
Added content
Added content for 'Bullet lists' and 'Numbered lists and procedures' and made a few minor adjustments elsewhere
1 parent 17a4a07 commit 9fa09b3

File tree

1 file changed

+24
-13
lines changed

1 file changed

+24
-13
lines changed

source/process/sg_grammar-spelling-mechanics.rst

Lines changed: 24 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,12 @@
22
Grammar, spelling, and mechanics
33
================================
44

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.
96

107
Language and spelling
118
=====================
129

13-
Write documents in English. Use American spelling conventions.
10+
Write documents in English. Use American spelling.
1411

1512
Paragraphs and sentences
1613
========================
@@ -73,8 +70,6 @@ Person
7370
Use the second person and avoid the first person.
7471

7572
Preferred
76-
To open the program, click **Open**.
77-
7873
You can view the status in the *Status* pane.
7974

8075
Avoid
@@ -85,9 +80,12 @@ Numbers
8580

8681
Use decimal numbers except when the number is the first word of a sentence. Use commas to make long numbers easier to read.
8782

88-
Good
83+
Preferred
8984
Three cows ran for 6 kilometers when they saw 2,300,097 mosquitoes chasing them.
9085

86+
Avoid
87+
3 cows ran for six kilometers when they saw 2300097 mosquitoes chasing them.
88+
9189
Text highlighting
9290
=================
9391

@@ -106,21 +104,34 @@ references italic
106104
Contractions
107105
============
108106

109-
As a general rule, contractions are fine.
107+
As a general rule, contractions are acceptable in Mattermost documents.
110108

111109
Verb tense
112110
==========
113111

114112
Use the present tense.
115113

116114
Preferred
117-
Click **Open**. The *File Open* window opens.
115+
Sharing this link lets other users view the linked message.
118116

119117
Avoid
120-
Click **Open**. The *File Open* window will open.
118+
Sharing this link will let other users view the linked message.
121119

122120
Bullet lists
123121
============
124122

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:
129+
130+
131+
1. This is the first step.
132+
2. This is the second step.
133+
134+
a. This is a substep.
135+
b. This is another substep.
136+
137+
3. This is the third step.

0 commit comments

Comments
 (0)