Skip to content

Commit 508b0e5

Browse files
authored
Merge pull request #394 from jafiala/homographs-application
Add application to homographs, harmonize capitalization in lists
2 parents 1fbb3d8 + c0f1d77 commit 508b0e5

File tree

1 file changed

+20
-19
lines changed

1 file changed

+20
-19
lines changed

supplementary_style_guide/style_guidelines/grammar.adoc

Lines changed: 20 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,14 @@ For more information about the Conscious Language Group, see https://github.com/
1212
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.
1313
====
1414

15-
=== blacklist and whitelist
15+
=== Blacklist and whitelist
1616

1717
When possible, rewrite documentation to avoid these terms.
1818
When it is not possible to remove the terms _blacklist_ and _whitelist_, replace them with one of the following alternatives:
1919

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
2323
* You can also use a term that has been agreed by your product team stakeholders.
2424

2525
.Examples
@@ -36,16 +36,16 @@ image:images/no.png[no] The following steps demonstrate adding a new rule to _wh
3636
image:images/yes.png[yes] The following steps demonstrate adding a new rule to _allow_ a custom binary.
3737

3838

39-
=== master and slave
39+
=== Master and slave
4040

4141
When possible, rewrite documentation to avoid these terms. When it is not possible to rewrite, you can use the following alternatives for _master_ / _slave_:
4242

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)
4949
* You can also use a term that has been agreed by your product team stakeholders.
5050

5151

@@ -90,18 +90,19 @@ Documentation for cloud services follows the _IBM Style_ guide for _fairly conve
9090

9191
[[homographs]]
9292
== 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.
9494
Using homographs close together in a sentence or paragraph might confuse readers.
9595
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.
9696

9797
The following list includes homographs that might commonly appear in technical documentation:
9898

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
105106

106107
[[minimalism]]
107108
== Minimalism
@@ -110,7 +111,7 @@ Minimalism is a methodology for creating targeted documentation focused on your
110111
Minimalism has five principles:
111112

112113
=== 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.
114115

115116
=== Principle 2: Findability
116117
Findability covers two areas:

0 commit comments

Comments
 (0)