@@ -61,17 +61,19 @@ Examples:
61
61
> * "helps" rather than "facilitates"
62
62
> * "uses" rather than "utilizes."
63
63
64
- ## Active voice is preferred over passive voice
64
+ ## Prefer active over passive voice
65
65
66
66
Unless one of the following applies:
67
67
68
68
* The system performs the action.
69
69
* It is more appropriate to focus on the receiver of the action.
70
70
* You want to avoid blaming the user for an error, such as in an error message.
71
71
* The information is clearer in passive voice.
72
- * Avoid -ing endings if possible as they make the sentence longer and more passive / less actionable. Examples:.
73
- * "Get started", not "Getting started".
74
- * "Provision a new device", not "Provisioning a new device".
72
+ * Avoid -ing endings if possible as they make the sentence longer and more passive / less actionable. Examples:
73
+
74
+ * "Get started", not "Getting started".
75
+ * "Provision a new device", not "Provisioning a new device".
76
+
75
77
* Helpful resource: the section titled "Passive Voice Should Never Be Used by
76
78
You" in the [ Linux Journal Author's
77
79
Guide] ( https://www.linuxjournal.com/author/authguide ) .
@@ -130,8 +132,9 @@ Examples:
130
132
* Numbers >=10 to be written as numbers.
131
133
* Use a comma separate large numbers (e.g. 10,000).
132
134
* Exceptions: avoid mixing number formats in same sentence.
133
- * Don't write: "...while three of our customers have over 20,000 devices...".
134
- * Do write: "...while 3 of our customers have over 20,000 devices...".
135
+
136
+ * Don't write: "...while three of our customers have over 20,000 devices...".
137
+ * Do write: "...while 3 of our customers have over 20,000 devices...".
135
138
136
139
## Use present tense as much as possible
137
140
@@ -176,11 +179,11 @@ Our taxonomy reference can be found [here](02.Overview/15.Taxonomy/docs.md).
176
179
177
180
Open links in the current tab:
178
181
179
- > [ https://docs.mender.io ] ( https://docs.mender.io )
182
+ > ` [https://docs.mender.io](https://docs.mender.io) `
180
183
181
184
And in a new tab:
182
185
183
- > [ https://docs .mender.io ] ( https://docs .mender.io?target=_blank )
186
+ > ` [https://hub .mender.io](https://hub .mender.io?target=_blank) `
184
187
185
188
186
189
0 commit comments