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: supplementary_style_guide/style_guidelines/grammar.adoc
+20-19Lines changed: 20 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,14 +12,14 @@ For more information about the Conscious Language Group, see https://github.com/
12
12
To ensure consistency and success, it is imperative for product team stakeholders to align internally. For example, documentation teams should engage in discussions with their engineering leadership to reach an agreement on replacement terms. This ensures that the product documentation matches the code.
13
13
====
14
14
15
-
=== blacklist and whitelist
15
+
=== Blacklist and whitelist
16
16
17
17
When possible, rewrite documentation to avoid these terms.
18
18
When it is not possible to remove the terms _blacklist_ and _whitelist_, replace them with one of the following alternatives:
19
19
20
-
* blocklist / allowlist: This combination is recommended by the _IBM Style_ guide. Use this combination unless your product area has another specific replacement that is agreed between engineering leadership and your documentation team.
21
-
* denylist / allowlist
22
-
* blocklist / passlist
20
+
* Blocklist / allowlist: This combination is recommended by the _IBM Style_ guide. Use this combination unless your product area has another specific replacement that is agreed between engineering leadership and your documentation team.
21
+
* Denylist / allowlist
22
+
* Blocklist / passlist
23
23
* You can also use a term that has been agreed by your product team stakeholders.
24
24
25
25
.Examples
@@ -36,16 +36,16 @@ image:images/no.png[no] The following steps demonstrate adding a new rule to _wh
36
36
image:images/yes.png[yes] The following steps demonstrate adding a new rule to _allow_ a custom binary.
37
37
38
38
39
-
=== master and slave
39
+
=== Master and slave
40
40
41
41
When possible, rewrite documentation to avoid these terms. When it is not possible to rewrite, you can use the following alternatives for _master_ / _slave_:
42
42
43
-
* primary / secondary
44
-
* source / replica
45
-
* initiator, requester / responder
46
-
* controller, host / device, worker, proxy
47
-
* director / performer
48
-
* controller / port interface (in networking)
43
+
* Primary / secondary
44
+
* Source / replica
45
+
* Initiator, requester / responder
46
+
* Controller, host / device, worker, proxy
47
+
* Director / performer
48
+
* Controller / port interface (in networking)
49
49
* You can also use a term that has been agreed by your product team stakeholders.
50
50
51
51
@@ -90,18 +90,19 @@ Documentation for cloud services follows the _IBM Style_ guide for _fairly conve
90
90
91
91
[[homographs]]
92
92
== Homographs
93
-
A homograph is a word that is spelled the same as another word but has a different meaning when used as a different part of speech.
93
+
A homograph is a word that is spelled the same as another word but has a different meaning.
94
94
Using homographs close together in a sentence or paragraph might confuse readers.
95
95
Therefore, be aware of this potential issue, and, when possible, avoid writing sentences that use homographs close to one another provided that you can do so without changing the technical meaning.
96
96
97
97
The following list includes homographs that might commonly appear in technical documentation:
98
98
99
-
* attribute
100
-
* block
101
-
* coordinates
102
-
* number
103
-
* object
104
-
* project
99
+
* Application
100
+
* Attribute
101
+
* Block
102
+
* Coordinates
103
+
* Number
104
+
* Object
105
+
* Project
105
106
106
107
[[minimalism]]
107
108
== Minimalism
@@ -110,7 +111,7 @@ Minimalism is a methodology for creating targeted documentation focused on your
110
111
Minimalism has five principles:
111
112
112
113
=== Principle 1: Customer focus and action orientation
113
-
Know what your users do, what their goals are, and why they perform these actions. Minimize how much content customers must wade through to get to something they recognize as real work. Separate conceptual and background information from procedural tasks.
114
+
Know what your users do, what their goals are, and why they perform these actions. Minimize how much content customers must wade through to get to something they recognize as real work. Separate conceptual and background information from procedural tasks.
0 commit comments